POST /v2/integrations/log-drains

Creates an Integration log drain. This endpoint must be called with an OAuth2 client (integration), since log drains are tied to integrations. If it is called with a different token type it will produce a 400 error.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
teamId String No

The Team identifier to perform the request on behalf of.

slug String No

The Team slug to perform the request on behalf of.

Request body fields

Name Type Required Description
projectIds[] Array No
environments[] Array No
sources[] Array No
name String Yes

The name of the log drain

url String Yes

The url where you will receive logs. The protocol must be https:// or http:// when type is json and ndjson, and syslog+tls: or syslog: when the type is syslog.

deliveryFormat String No

The delivery log format

Possible values:

  • "ndjson"
  • "json"
  • "syslog"
headers Object No

Headers to be sent together with the request

secret String No

A secret to sign log drain notification headers so a consumer can verify their authenticity

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.