Skip to content
Equnix Metal
show

SSH Keys copied!

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

Retrieve all ssh keys copied!

GET
/ssh-keys

Returns a collection of the user’s ssh keys.

  • Parameters
  • Search string
    string in query

    Search by key, label, or fingerprint

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

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

Creates a ssh key.

  • Parameters
  • ssh key
     (required) in body

    ssh key to create

    {
        "label": "string",
        "key": "string",
        "instances_ids": [
            "string"
        ]
    }

Retrieve a project's ssh keys copied!

GET
/projects/{id}/ssh-keys

Returns a collection of the project's ssh keys.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    Search string
    string in query

    Search by key, label, or fingerprint

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

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

Create a ssh key for the given project copied!

POST
/projects/{id}/ssh-keys

Creates a ssh key.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    ssh key
     (required) in body

    ssh key to create

    {
        "label": "string",
        "key": "string",
        "instances_ids": [
            "string"
        ]
    }

Retrieve a device's ssh keys copied!

GET
/devices/{id}/ssh-keys

Returns a collection of the device's ssh keys.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    Search string
    string in query

    Search by key, label, or fingerprint

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

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

Retrieve a ssh key copied!

GET
/ssh-keys/{id}

Returns a single ssh key if the user has access

  • Parameters
  • id
    string  (required) in path

    SSH Key UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

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

Update the ssh key copied!

PUT
/ssh-keys/{id}

Updates the ssh key.

  • 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 copied!

DELETE
/ssh-keys/{id}

Deletes the ssh key.

  • Parameters
  • id
    string  (required) in path

    ssh key UUID