APaptible
Accounts

find account by handle

Changed on

Returns the account matching the specified handle.

get/find/account

Request

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

Query parameters

handlestring required

account handle

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

idinteger required
typestring required
_typestring required
namestring required
handlestring required
onboarding_statusstring required
numberstring required
activatedboolean required
syslog_hoststring required
syslog_portinteger required
bastion_hoststring required
bastion_portinteger required
ssh_portal_portinteger required
container_countinteger required
domain_countinteger required
total_disk_sizeinteger required
total_app_countinteger required
app_container_countinteger required
database_container_countinteger required
total_database_countinteger required
created_atstring dateTime required
updated_atstring dateTime required
sweetness_stackstring required
gentlemanjerry_endpointstring required
gentlemanjerry_certificatestring required
gentlemanjerry_docker_namestring required
gentlemanjerry_instance_idstring required
sweetness_stack_version'v1' | 'v2' required
ca_bodystring required
ca_private_keystring

Changes

  • 1dc1e5b8c6ebRevision changes
    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • info

      added the new optional header request parameter Prefer

    • info

      added the new optional query request parameter no_embed

  • 5c71f4c63067Revision changes
    • info

      endpoint added