APaptible
Services

show service with operation status

Changed on

Returns the details of a specific service, optionally including its current release operation status.

get/services/{id}

Request

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

Path parameters

idinteger required

id

Query parameters

include_operation_statusboolean

Include release_operation_in_progress status

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

excludes operation status when param is not present

idinteger required
_typestring required
handlestring required
docker_repostring required
docker_refstring required
process_typestring required
commandstring required
container_countinteger required
created_atstring dateTime required
updated_atstring dateTime required
container_memory_limit_mbinteger required
instance_classstring required
force_zero_downtimeboolean required
naive_health_checkboolean required
restart_free_scalingboolean required
stop_timeoutinteger required

Changes

  • 1dc1e5b8c6ebRevision changes
    • info

      added the new optional header request parameter Prefer

    • info

      added the new optional query request parameter no_embed

  • 1a8233ac6563Revision changes
    • info

      added the required property to the response with the status