APaptible
MetricDrains

create metric_drain

Changed on

Creates a new metric drain for the specified account.

post/accounts/{account_id}/metric_drains

Request

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

Path parameters

account_idinteger required

account_id

Query parameters

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

handlestring required
drain_typestring required
databasestring uri

For Deploy-hosted InfluxDB instances

database_idinteger

For Deploy-hosted InfluxDB instances

Response

successful

idinteger required
_typestring required
handlestring required
created_atstring dateTime required
updated_atstring dateTime required
statusstring required
drain_typestring required
unifiedboolean
aggregator_ca_certificatestring required
aggregator_ca_private_key_blobstring required
aggregator_hoststring required
aggregator_instance_idstring required
aggregator_docker_namestring required
aggregator_allocationstring[] required

Changes

  • ba72edfe0324Revision changes
    • info

      added the optional property to the response with the status

  • 1dc1e5b8c6ebRevision changes
    • 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