v1

latestOpenAPI 3.0.02026-07-135965404.0 KB

SSH Keys

Create a new SSH Key

Create a new SSH Key for a user. Provide the Public Key as formatted from the ssh-keygen command (openssh format or RFC-4716 format).

If you'd prefer to let us generate your key automatically, you can log in to your account via the web portal and set up new keys via the SSH Keys page.

post/ssh-keys

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.

Request body

userIdinteger required

ID of the user to assign the new key to.

publicKeystring required

Public Key to provide ExaVault. You can provide the Public Key as formatted from the ssh-keygen command or a standard rfc-4716 format.

Response

Successful Operation

responseStatusinteger

Http status code of the response.

Example response

{
  "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"
          }
        }
      }
    }
  ]
}