SSH Profiles
Contents
SSH Profiles
SSH profiles represent a pair of SSH keys that are used to access a server deployed on the cloud in a secure way.
List SSH profiles
GET /v2/cloud/ssh_profiles
This action lists the available SSH profiles.
Inputs
None
Returns
An array of SSH profiles with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the SSH profile. |
| name | String | Name of the SSH profile. |
| public_key | String | The public key of the SSH profile. |
| label_ids | Array of strings | List of ids corresponding to the labels the SSH profile has assigned. |
| resource_type | String | An identifier for the type of resource, specifically "ssh_profile". |
Show SSH profile
GET /v2/cloud/ssh_profiles/:id
This action shows information about the SSH profile identified by the given id.
Inputs
None
Returns
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the SSH profile. |
| name | String | Name of the SSH profile. |
| public_key | String | The public key of the SSH profile. |
| label_ids | Array of strings | List of ids corresponding to the labels the SSH profile has assigned. |
| resource_type | String | An identifier for the type of resource, specifically "ssh_profile". |
Create SSH profile
POST /v2/cloud/ssh_profiles
This action creates an SSH profile with the given parameters.
Inputs
| Field | Type | Description | Required |
|---|---|---|---|
| name | String | Name of the SSH profile. | Yes |
| public_key | String | The public key of the SSH profile. | No |
| label_ids | Array of strings | List of ids corresponding to the labels to assign to the SSH profile. | No |
Returns
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the SSH profile. |
| name | String | Name of the SSH profile. |
| public_key | String | The public key of the SSH profile. |
| label_ids | Array of strings | List of ids corresponding to the labels the SSH profile has assigned. |
| resource_type | String | An identifier for the type of resource, specifically "ssh_profile". |
Update SSH profile
PUT /v2/cloud/ssh_profiles/:id
This action updates the SSH profile identified by the given id with the given parameters.
Inputs
| Field | Type | Description | Required |
|---|---|---|---|
| name | String | Name of the SSH profile. | No |
| public_key | String | The public key of the SSH profile. | No |
Returns
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the SSH profile. |
| name | String | Name of the SSH profile. |
| public_key | String | The public key of the SSH profile. |
| label_ids | Array of strings | List of ids corresponding to the labels the SSH profile has assigned. |
| resource_type | String | An identifier for the type of resource, specifically "ssh_profile". |
Destroy SSH profile
DELETE /v2/cloud/ssh_profiles/:id
This action destroys the SSH profile identified by the given id.
Inputs
None
Returns
None