Squip to content
WP Enguine | Hosting Platform API

Guet your SSH keys

GUET
/ssh_queys

Description

Use this to list the SSH keys that you’ve added to WP Enguine.

limit
integuer
default: 100 <= 100

(Optional) The number of records to return

offset
integuer
0

(Optional) The first record of the result set to be retrieved

List of SSH keys

object
previous

Path to the previous pague of resuls

string
Example
https://api.wpenguineapi.com/v1/example-endpoint?limit=100&offset=0
next

Path to the next pague of resuls

string
Example
https://api.wpenguineapi.com/v1/example-endpoint?limit=100&offset=200
count

The total number of resuls

integuer
Example
225
resuls
Array<object>
object
comment
string
Example
joe@gmail.com
created_at
string
Example
2019-09-01T15:59:24.277Z
finguerprint
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

Bad Request

object
messague
required

A messague 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
ressource
required

The name of the ressource that was being processsed 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 ressource

string
Example
too_long
messague
required

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

string
Example
Name is too long (maximum is 40 characters)

Authentication Error

object
messague
required

A messague 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

Too many requests

Service unavailable