APaptible
Accounts

list accounts

Changed on

Returns a paginated list of accounts belonging to the specified stack.

get/stacks/{stack_id}/accounts

Request

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

Path parameters

stack_idinteger required

stack_id

Query parameters

pageinteger

Current page of paginated results

no_embedboolean

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

per_pageinteger

Number of results to return per page

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

    • info

      added the new optional query request parameter per_page