APaptible
Databases

find database by handle

Changed on

Returns the database matching the specified handle.

get/find/database

Request

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

Query parameters

handlestring required

database handle

environmentstring

account handle to disambiguate when multiple databases share the same 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
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

  • 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

    • 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