APaptible
SshPortalConnections

create ssh_portal_connection

Changed on

Creates a new SSH portal connection for the specified operation.

post/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

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.

Request body

ssh_public_keystring required
commandstring

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