APaptible
Databases

update database

Changed on

Updates a database's attributes.

put/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.

Request body

current_configurationinteger
handlestring
initial_disk_sizeinteger
initial_continer_sizeinteger
database_image_idinteger
current_kms_arnstring
enable_backupsboolean

Response

successful

Changes

  • 0bd1bb990024Revision changes
    • info

      added the new optional query request parameter with_deleted

  • 1dc1e5b8c6ebRevision changes
    • breaking

      the request property type changed from integer to string

    • info

      added the new optional header request parameter Prefer

    • info

      added the new optional query request parameter no_embed