APaptible
Databases

show database

Changed on

Returns the details of a specific database by ID.

get/databases/{id}

Request

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

Path parameters

idinteger required

id

Query parameters

with_deletedboolean

when true, returns a database even if it has been deleted

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
handlestring required
typestring required
passphrasestring
connection_urlstring
provisionedboolean required
_typestring required
created_atstring dateTime required
updated_atstring dateTime required
statusstring required
docker_repostring required
initial_disk_sizeinteger required
initial_container_sizeinteger required
current_kms_arnstring required
enable_backupsboolean required
pitr_bucketstring required
oldest_pitr_timestring required
enable_pitrboolean required
pitr_status'unsupported' | 'supported' | 'pending_restart' | 'restricted' required

Changes

  • ba72edfe0324Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property // to the response with the status

  • 0bd1bb990024Revision changes
    • info

      added the new optional query request parameter with_deleted