SSH Key

This endpoint is used to create, update, search or delete ssh keys.

To use this endpoint you should have "manageVcs" access at team level and a Terrakube Organization

Entity fields:

Path	Type	Description
data.type	string	Should be "ssh"
data.attributes.name	string	Unique ssh key name for an Terrakube organization
data.attributes.description	string	Free text for description
data.attributes.privateKey	string	SSH Key content
data.attributes.sshType	string	rsa or ed25519

Example:

{
  "data": {
    "type": "ssh",
    "attributes": {
      "name": "Sample SSH Key",
      "description": "SSH Key Description",
      "privateKey": "{{sshPrivateKey}}",
      "sshType": "{{sshKeyType}}"
    }
  }
}

Supported Operations

Returns the relationship ssh

GET/api/v1/organization/{organizationId}/ssh

Path parameters

organizationId*string

organization Identifier

Query parameters

Response

200

Successful response

Body

application/vnd.api+json

dataarray of ssh (object)

includedarray of object

Included resources

Request

JavaScriptCurl

const response = await fetch('/api/v1/organization/{organizationId}/ssh', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "type": "text",
      "id": "text",
      "attributes": {
        "createdBy": "text",
        "createdDate": "2024-04-25T02:28:42.998Z",
        "description": "text",
        "name": "text",
        "privateKey": "text",
        "sshType": "rsa",
        "updatedBy": "text",
        "updatedDate": "2024-04-25T02:28:42.998Z"
      },
      "relationships": {
        "organization": {
          "id": "text",
          "type": "organization"
        }
      }
    }
  ],
  "included": [
    {
      "id": "text",
      "type": "text"
    }
  ]
}

Creates an item of type ssh and adds it to ssh

POST/api/v1/organization/{organizationId}/ssh

Path parameters

organizationId*string

organization Identifier

Body

application/vnd.api+json

datassh (object)

Response

201

Successful response

Body

application/vnd.api+json

datassh (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/organization/{organizationId}/ssh', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "createdBy": "text",
      "createdDate": "2024-04-25T02:28:42.998Z",
      "description": "text",
      "name": "text",
      "privateKey": "text",
      "sshType": "rsa",
      "updatedBy": "text",
      "updatedDate": "2024-04-25T02:28:42.998Z"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  }
}

Deletes an instance of type ssh

DELETE/api/v1/organization/{organizationId}/ssh/{sshId}

Path parameters

organizationId*string

organization Identifier

sshId*string

ssh Identifier

Response

204

Successful response

Request

JavaScriptCurl

const response = await fetch('/api/v1/organization/{organizationId}/ssh/{sshId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Modifies an instance of type ssh

PATCH/api/v1/organization/{organizationId}/ssh/{sshId}

Path parameters

organizationId*string

organization Identifier

sshId*string

ssh Identifier

Body

application/vnd.api+json

datassh (object)

Response

204

Successful response

Request

JavaScriptCurl

const response = await fetch('/api/v1/organization/{organizationId}/ssh/{sshId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();