SSHKey

SSH key management

List SSH keys

get

Authorizations

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

uuidstringRead-onlyRequired

SSH key UUID as specified in RFC 4122

Example: 7561c39d-f4df-4c46-b3f1-2ac981271e29

namestringRequired

SSH key name

publicKeystringRequired

Public SSH key contents

createdAtinteger · integerRead-onlyRequired

SSH key createdAt

403

Invalid credentials

500

Internal Server Error

application/json

get/v3/sshKey

GET /v3/sshKey HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "uuid": "7561c39d-f4df-4c46-b3f1-2ac981271e29",
    "name": "text",
    "publicKey": "text",
    "createdAt": 1
  }
]

Upload a new SSH key

post

Note: Please always upload a public(!) key and preferably in OpenSSH format.

Authorizations

PRIVATE-TOKENstringRequired

Body

uuidstringRead-onlyRequired

SSH key UUID as specified in RFC 4122

Example: 7561c39d-f4df-4c46-b3f1-2ac981271e29

namestringRequired

SSH key name

publicKeystringRequired

Public SSH key contents

createdAtinteger · integerRead-onlyRequired

SSH key createdAt

Responses

200

OK

application/json

uuidstringRead-onlyRequired

SSH key UUID as specified in RFC 4122

Example: 7561c39d-f4df-4c46-b3f1-2ac981271e29

namestringRequired

SSH key name

publicKeystringRequired

Public SSH key contents

createdAtinteger · integerRead-onlyRequired

SSH key createdAt

403

Invalid credentials

422

Unprocessable Entity

500

Internal Server Error

application/json

post/v3/sshKey

POST /v3/sshKey HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "name": "text",
  "publicKey": "text"
}

[
  {
    "uuid": "7561c39d-f4df-4c46-b3f1-2ac981271e29",
    "name": "text",
    "publicKey": "text",
    "createdAt": 1
  }
]

SSH key by ID

get

Authorizations

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

uuidstringRead-onlyRequired

SSH key UUID as specified in RFC 4122

Example: 7561c39d-f4df-4c46-b3f1-2ac981271e29

namestringRequired

SSH key name

publicKeystringRequired

Public SSH key contents

createdAtinteger · integerRead-onlyRequired

SSH key createdAt

403

Invalid credentials

404

Entity not found

500

Internal Server Error

application/json

get/v3/sshKey/{uuid}

GET /v3/sshKey/{uuid} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "uuid": "7561c39d-f4df-4c46-b3f1-2ac981271e29",
    "name": "text",
    "publicKey": "text",
    "createdAt": 1
  }
]

Delete SSH key

delete

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

uuidstringRequired

SSH key UUID

Example: 7561c39d-f4df-4c46-b3f1-2ac981271e29

Responses

204

No Content

No content

400

Invalid UUID

403

Invalid credentials

404

SSH key not found

500

Internal Server Error

application/json

delete/v3/sshKey/{uuid}

DELETE /v3/sshKey/{uuid} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content