Manage SSH keys. See project endpoints to list and create project-level SSH keys.

Returns a collection of the user’s ssh keys.

    /ssh-keys
  • Parameters
  • Search string
    string in query

    Search by key, label, or fingerprint

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Creates a ssh key.

    /ssh-keys
  • Parameters
  • ssh key
     (required) in body

    ssh key to create

    {
    	"label": "string",
    	"key": "string"
    } 

Retrieve a project's ssh keys

GET
/projects/{id}/ssh-keys

Returns a collection of the project's ssh keys.

    /projects/{id}/ssh-keys
  • Parameters
  • id
    string  (required) in path

    Project UUID

    Search string
    string in query

    Search by key, label, or fingerprint

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Creates a ssh key.

    /projects/{id}/ssh-keys
  • Parameters
  • id
    string  (required) in path

    Project UUID

    ssh key
     (required) in body

    ssh key to create

    {
    	"label": "string",
    	"key": "string"
    } 

Retrieve a device's ssh keys

GET
/devices/{id}/ssh-keys

Returns a collection of the device's ssh keys.

    /devices/{id}/ssh-keys
  • Parameters
  • id
    string  (required) in path

    Project UUID

    Search string
    string in query

    Search by key, label, or fingerprint

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Retrieve a ssh key

GET
/ssh-keys/{id}

Returns a single ssh key if the user has access

    /ssh-keys/{id}
  • Parameters
  • id
    string  (required) in path

    SSH Key UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Update the ssh key

PUT
/ssh-keys/{id}

Updates the ssh key.

    /ssh-keys/{id}
  • Parameters
  • id
    string  (required) in path

    SSH Key UUID

    ssh key
     (required) in body

    ssh key to update

    {
    	"label": "string",
    	"key": "string"
    } 

Delete the ssh key

/ssh-keys/{id}

Deletes the ssh key.

    /ssh-keys/{id}
  • Parameters
  • id
    string  (required) in path

    ssh key UUID