Sign in

v1

latestOpenAPI 3.0.02026-07-135965404.0 KB
SSH Keys

Get metadata for a list of SSH Keys

Returns a list of SSH Keys within the account. Can be filtered for a single user.

get/ssh-keys

Query parameters

userIdstring

Only return results for the given user ID. This is not the username, but the numeric ID of the user.

limitinteger

Limits the results by the given number. Cannot be set higher than 100.

offsetinteger

Determines which item to start on for pagination. Use zero (0) to start at the beginning of the list.

Headers

ev-api-keystring required

API key required to make the API call.

ev-access-tokenstring required

Access token required to make the API call.

Response

Successful Operation

responseStatusinteger

Http status code of the response.

totalResultsinteger

Total results found.

returnedResultsinteger

Number of returned results.

Example response

{
  "responseStatus": 200,
  "totalResults": 2,
  "returnedResults": 2,
  "data": [
    {
      "id": 655621,
      "type": "sshKey"
    }
  ],
  "included": [
    {
      "id": 655621,
      "type": "user",
      "attributes": {
        "status": 1,
        "expiration": "2020-06-30T13:33:30-07:00",
        "created": "2018-07-27T15:43:55-07:00",
        "modified": "2018-07-29T15:43:55-07:00",
        "accessTimestamp": "2011-03-21T00:18:56-07:00",
        "accountName": "exampleaccount",
        "username": "exampleuser",
        "nickname": "exampleuser",
        "email": "example@exavault.mail",
        "homePath": "/",
        "role": "user",
        "timeZone": "America/Chicago"
      },
      "relationships": {
        "homeResource": {
          "data": {
            "type": "resource"
          }
        },
        "ownerAccount": {
          "data": {
            "type": "account"
          }
        }
      }
    }
  ]
}