ACacquia
SSH Keys

Gets a list of SSH keys.

Gets a list of all SSH keys accessible to the requester. Each key includes a user_id field identifying the owner.

To look up the owner of an SSH key by fingerprint or public key, apply a mandatory filter: GET /ssh-keys?filter=fingerprint%3D<value> or GET /ssh-keys?filter=public_key%3D<value>. The matching key(s) will include the user_id of the owner.

Filterable fields:

  • label
  • fingerprint
  • public_key
  • user_id

Sortable fields:

  • label
get/ssh-keys

Request

Query parameters

offsetinteger
Example:20

The number of items to skip before starting to collect the result set.

limitinteger
Example:10

The maximum number of items to return per page.

filterstring

Filter the result set using field-based criteria. Format: field=value or field<operator>value Logical operators:

  • , (comma) - OR logic between filters
  • ; (semicolon) - AND logic between filters
  • Note: Cannot mix OR and AND operators in the same query Comparison operators:
  • = - Equals (default if no operator specified)
  • != - Does not equal
  • > - Greater than
  • < - Less than
  • >= - Greater than or equal to
  • <= - Less than or equal to
  • =@ - Contains substring
  • !@ - Does not contain substring Wildcards:
  • * - Wildcard character for pattern matching Examples:
  • label=primary - Filter by label equals primary
  • fingerprint=@SHA256 - Filter by fingerprint containing "SHA256"
  • label=primary;fingerprint=@SHA256 - label is primary AND fingerprint contains SHA256
  • label=primary,label=backup - label is primary OR backup
sortstring

Sort the result set by one or more fields. Format: field1,field2,-field3 Sort order:

  • No prefix - Ascending order (default)
  • - prefix - Descending order Multiple fields:
  • Fields are processed in the order specified
  • First field has highest priority
  • Use comma to separate multiple fields Examples:
  • name - Sort by name in ascending order
  • -created_at - Sort by created_at in descending order
  • name,-created_at - Sort by name ascending, then created_at descending
  • status,name,-updated_at - Sort by status ascending, then name ascending, then updated_at descending

Response

OK

countinteger required

The number of items in the current page

totalinteger required

The total number of items available

Changes

No recorded changes to this operation across all 1 revision of this API.