APaptible
LogDrains

create log_drain

Changed on

Creates a new log drain for the specified account.

post/accounts/{account_id}/log_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
drain_hoststring uri

For syslog-tls-tcp drains

drain_portinteger

For syslog-tls-tcp drains

drain_usernamestring

DEPRECATED: For legacy Elasticsearch drains

drain_passwordstring

For Tail drains

databasestring uri

For Deploy-hosted Elasticsearch drains

database_idinteger

For Deploy-hosted Elasticsearch drains

urlstring uri

For HTTPs Post drains

logging_tokenstring
drain_appsboolean
drain_databasesboolean
drain_ephemeral_sessionsboolean
drain_proxiesboolean

Response

successful

idinteger required
_typestring required
handlestring required
drain_typestring required
drain_hoststring required
drain_portinteger required
created_atstring dateTime required
updated_atstring dateTime required
statusstring required
drain_usernamestring
drain_passwordstring
drain_appsboolean required
drain_databasesboolean required
drain_ephemeral_sessionsboolean required
drain_proxiesboolean required
gentlemanjerry_certificatestring required
gentlemanjerry_docker_namestring required
gentlemanjerry_instance_idstring required
gentlemanjerry_hoststring required
gentlemanjerry_allocationstring[] required
urlstring
logging_tokenstring

Changes

  • 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

    • info

      added the new optional header request parameter Prefer

    • info

      added the new optional query request parameter no_embed