1 of 1

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

Example:

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

Supported Operations

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

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

sortarray of enum

Sorts the collection on the selected attributes. A prefix of '-' sorts descending

itemsenum

createdBy-createdBydescription-descriptionname-nameprivateKey-privateKeyupdatedBy-updatedByid-id

fields[ssh]array of enum

Selects the set of ssh fields that should be returned in the result.

itemsenum

createdBycreatedDatedescriptionnameprivateKeysshTypeupdatedByupdatedDateorganization

includearray of enum

Selects the set of relationships that should be expanded as a compound document in the result.

itemsenum

organization

filter[ssh]string

Filters the collection of ssh using a 'disjoint' RSQL expression

page[number]integer

Number of pages to return. Can be used with page[size]

page[size]integer

Number of elements per page. Can be used with page[number]

page[offset]integer

Offset from 0 to start paginating. Can be used with page[limit]

page[limit]integer

Maximum number of items to return. Can be used with page[offset]

page[totals]string

For requesting total pages/records be included in the response page meta data

Response

Successful response

Body

dataarray of ssh (object)

typestring

Create Permissions : (team manage ssh) Delete Permissions : (team manage ssh)

idstring

attributesobject

createdBystring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

createdDatestring (date-time)

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

descriptionstring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

namestring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

privateKeystring

Read Permissions : (read private key) Update Permissions : (team manage ssh)

sshTypeenum

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

rsaed25519

updatedBystring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

updatedDatestring (date-time)

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

relationshipsobject

organizationobject

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

idstring

typeenum

organization

includedarray of object

Included resources

attributesobject

idstring

relationshipsobject

typestring

Request

Response

Creates an item of type ssh and adds it to ssh

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

Path parameters

organizationId*string

organization Identifier

Body

datassh (object)

typestring

Create Permissions : (team manage ssh) Delete Permissions : (team manage ssh)

idstring

attributesobject

createdBystring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

createdDatestring (date-time)

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

descriptionstring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

namestring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

privateKeystring

Read Permissions : (read private key) Update Permissions : (team manage ssh)

sshTypeenum

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

rsaed25519

updatedBystring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

updatedDatestring (date-time)

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

relationshipsobject

organizationobject

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

idstring

typeenum

organization

Response

Successful response

Body

datassh (object)

typestring

Create Permissions : (team manage ssh) Delete Permissions : (team manage ssh)

idstring

attributesobject

createdBystring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

createdDatestring (date-time)

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

descriptionstring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

namestring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

privateKeystring

Read Permissions : (read private key) Update Permissions : (team manage ssh)

sshTypeenum

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

rsaed25519

updatedBystring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

updatedDatestring (date-time)

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

relationshipsobject

organizationobject

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

idstring

typeenum

organization

Request

Response

Deletes an instance of type ssh

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

Path parameters

organizationId*string

organization Identifier

sshId*string

ssh Identifier

Response

Successful response

Request

Modifies an instance of type ssh

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

Path parameters

organizationId*string

organization Identifier

sshId*string

ssh Identifier

Body

datassh (object)

typestring

Create Permissions : (team manage ssh) Delete Permissions : (team manage ssh)

idstring

attributesobject

createdBystring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

createdDatestring (date-time)

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

descriptionstring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

namestring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

privateKeystring

Read Permissions : (read private key) Update Permissions : (team manage ssh)

sshTypeenum

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

rsaed25519

updatedBystring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

updatedDatestring (date-time)

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

relationshipsobject

organizationobject

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

idstring

typeenum

organization

Response

Successful response

Request

Creates an item of type ssh and adds it to ssh

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

Path parameters

organizationId*string

organization Identifier

Body

datassh (object)

typestring

Create Permissions : (team manage ssh) Delete Permissions : (team manage ssh)

idstring

attributesobject

createdBystring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

createdDatestring (date-time)

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

descriptionstring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

namestring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

privateKeystring

Read Permissions : (read private key) Update Permissions : (team manage ssh)

sshTypeenum

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

rsaed25519

updatedBystring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

updatedDatestring (date-time)

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

relationshipsobject

organizationobject

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

idstring

typeenum

organization

Response

Successful response

Body

datassh (object)

typestring

Create Permissions : (team manage ssh) Delete Permissions : (team manage ssh)

idstring

attributesobject

createdBystring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

createdDatestring (date-time)

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

descriptionstring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

namestring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

privateKeystring

Read Permissions : (read private key) Update Permissions : (team manage ssh)

sshTypeenum

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

rsaed25519

updatedBystring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

updatedDatestring (date-time)

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

relationshipsobject

organizationobject

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

idstring

typeenum

organization

Request

Response

Returns the relationship ssh

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

Path parameters

organizationId*string

organization Identifier

Query parameters

sortarray of enum

Sorts the collection on the selected attributes. A prefix of '-' sorts descending

itemsenum

createdBy-createdBydescription-descriptionname-nameprivateKey-privateKeyupdatedBy-updatedByid-id

fields[ssh]array of enum

Selects the set of ssh fields that should be returned in the result.

itemsenum

createdBycreatedDatedescriptionnameprivateKeysshTypeupdatedByupdatedDateorganization

includearray of enum

Selects the set of relationships that should be expanded as a compound document in the result.

itemsenum

organization

filter[ssh]string

Filters the collection of ssh using a 'disjoint' RSQL expression

page[number]integer

Number of pages to return. Can be used with page[size]

page[size]integer

Number of elements per page. Can be used with page[number]

page[offset]integer

Offset from 0 to start paginating. Can be used with page[limit]

page[limit]integer

Maximum number of items to return. Can be used with page[offset]

page[totals]string

For requesting total pages/records be included in the response page meta data

Response

Successful response

Body

dataarray of ssh (object)

typestring

Create Permissions : (team manage ssh) Delete Permissions : (team manage ssh)

idstring

attributesobject

createdBystring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

createdDatestring (date-time)

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

descriptionstring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

namestring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

privateKeystring

Read Permissions : (read private key) Update Permissions : (team manage ssh)

sshTypeenum

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

rsaed25519

updatedBystring

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

updatedDatestring (date-time)

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

relationshipsobject

organizationobject

Read Permissions : (team view ssh) Update Permissions : (team manage ssh)

idstring

typeenum

organization

includedarray of object

Included resources

attributesobject

idstring

relationshipsobject

typestring

Request

Response

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();

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();

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "createdBy": "text",
      "createdDate": "2024-11-23T23:47:58.858Z",
      "description": "text",
      "name": "text",
      "privateKey": "text",
      "sshType": "rsa",
      "updatedBy": "text",
      "updatedDate": "2024-11-23T23:47:58.858Z"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  }
}

{
  "data": [
    {
      "type": "text",
      "id": "text",
      "attributes": {
        "createdBy": "text",
        "createdDate": "2024-11-23T23:47:58.858Z",
        "description": "text",
        "name": "text",
        "privateKey": "text",
        "sshType": "rsa",
        "updatedBy": "text",
        "updatedDate": "2024-11-23T23:47:58.858Z"
      },
      "relationships": {
        "organization": {
          "id": "text",
          "type": "organization"
        }
      }
    }
  ],
  "included": [
    {
      "id": "text",
      "type": "text"
    }
  ]
}