Add a new SSH key

POST

/ssh_keys

Description

Use this to add a new SSH key to WP Engine.

Authorizations

• basicAuth

Request Body

Properties

• public_key - required - The public key you want to add

object

public_key

required

string

Example

ssh-rsa AAAAbcdefg+567te/4i9ASKGHtw9euaskl+Iksldfjw== joe@gmail.com

Responses

201

Created

object

comment

string

Example

joe@gmail.com

created_at

string

Example

2019-09-01T15:59:24.277Z

fingerprint

string

Example

a1:b2:c3:d4:e5:46:a7:88:c9:40:d2:d7:9b:cd:42:05

uuid

string format: uuid

Example

e41fa98f-ea80-1f16-a7b7-d748bcc9e64d

400

Bad Request

object

message

required

A message regarding the error that occurred on the server

string

Example

Invalid Site: Name cannot be empty.

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

errors

An array of error objects describing specific errors that arose when servicing the request

Array<object>

object

resource

required

The name of the resource that was being processed when the error occurred

string

Example

Site

field

required

(Optional) The specific field associated with the error

string

Example

name

type

required

(Optional) A type associated with the error. invalid_value, access_error, value_unavailable

string

Example

invalid_value

code

required

(Optional) A machine code relating to the error that occurred with the field and resource

string

Example

too_long

message

required

(Optional) A human-readable message relating to the error that occurred with the field and resource

string

Example

Name is too long (maximum is 40 characters)

401

Authentication Error

object

message

required

A message regarding the error that occurred on the server

string

Example

Bad Credentials

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

403

Not authorized

object

message

required

A message regarding the error that occurred on the server

string

Example

You don't have permission to perform that action

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

429

Too many requests

503

Service unavailable