APaptible
SshPortalConnections

show ssh_portal_connection

Changed on

Returns the details of a specific SSH portal connection by ID.

get/ssh_portal_connections/{id}

Request

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

Path parameters

idinteger required

id

Query parameters

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

idstring uuid required
_typestring required
ssh_userstring required
ssh_certificate_bodystring required
ssh_port_forward_socketstring required
ssh_ptyboolean required
created_atstring dateTime required
updated_atstring dateTime 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