APaptible
SshPortalConnections

list ssh_portal_connections

Changed on

Returns a paginated list of SSH portal connections for the specified operation.

get/operations/{operation_id}/ssh_portal_connections

Request

  • Base URL
    https://api.aptible.com
  • Auth
    API key in header Authorization

Path parameters

operation_idinteger required

operation_id

Query parameters

pageinteger

Current page of paginated results

per_pageinteger

Number of results to return per page

no_embedboolean

When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.

Headers

Prefer'no_sensitive_extras=true'

When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.

Response

successful

total_countinteger required
per_pageinteger required
current_pageinteger required

Changes

  • 1dc1e5b8c6ebRevision changes
    • breaking

      the /// response's property type changed from integer to string for status

    • info

      added the new optional header request parameter Prefer

    • info

      added the new optional query request parameter no_embed

    • info

      added the new optional query request parameter per_page