Creates a new Integration Log Drain

v1.0.0

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.

Input

{
  "type": "object",
  "properties": {
    "branch": {
      "type": "string",
      "description": "The branch regexp of log drain"
    },
    "deliveryFormat": {
      "description": "The delivery log format",
      "enum": [
        "json",
        "ndjson",
        "syslog"
      ],
      "type": "object"
    },
    "environment": {
      "description": "The environment of log drain",
      "enum": [
        "preview",
        "production"
      ],
      "type": "object"
    },
    "headers": {
      "type": "object",
      "description": "Headers to be sent together with the request"
    },
    "name": {
      "type": "string",
      "description": "The name of the log drain"
    },
    "projectIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "secret": {
      "type": "string",
      "description": "A secret to sign log drain notification headers so a consumer can verify their authenticity"
    },
    "sources": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "static",
          "lambda",
          "build",
          "edge",
          "external"
        ]
      }
    },
    "teamId": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "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`."
    }
  },
  "required": [
    "name",
    "url"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "createdAt",
    "id",
    "name",
    "ownerId",
    "type",
    "url"
  ],
  "properties": {
    "branch": {
      "type": "string",
      "description": "The branch regexp of log drain"
    },
    "clientId": {
      "type": "string",
      "description": "The oauth2 client application id that created this log drain"
    },
    "configurationId": {
      "type": "string",
      "description": "The client configuration this log drain was created with"
    },
    "createdAt": {
      "type": "number",
      "description": "A timestamp that tells you when the log drain was created"
    },
    "createdFrom": {
      "type": "string",
      "description": "Whether the log drain was created by an integration or by a user",
      "enum": [
        "self-served",
        "integration"
      ]
    },
    "deliveryFormat": {
      "type": "string",
      "description": "The delivery log format",
      "enum": [
        "json",
        "ndjson",
        "syslog"
      ]
    },
    "environment": {
      "type": "string",
      "description": "The environment of log drain",
      "enum": [
        "preview",
        "production"
      ]
    },
    "headers": {
      "type": "object",
      "description": "Construct a type with a set of properties K of type T"
    },
    "id": {
      "type": "string",
      "description": "The unique identifier of the log drain. Always prefixed with `ld_`"
    },
    "name": {
      "type": "string",
      "description": "The name of the log drain"
    },
    "ownerId": {
      "type": "string",
      "description": "The identifier of the team or user whose events will trigger the log drain"
    },
    "projectId": {
      "type": [
        "string",
        "null"
      ]
    },
    "projectIds": {
      "type": "array",
      "description": "The identifier of the projects this log drain is associated with",
      "items": {
        "type": "string"
      }
    },
    "sources": {
      "type": "array",
      "description": "The sources from which logs are currently being delivered to this log drain.",
      "items": {
        "type": "string",
        "description": "The sources from which logs are currently being delivered to this log drain.",
        "enum": [
          "static",
          "lambda",
          "build",
          "edge",
          "external"
        ]
      }
    },
    "type": {
      "type": "string",
      "description": "The type of log format",
      "enum": [
        "json",
        "ndjson",
        "syslog"
      ]
    },
    "url": {
      "type": "string",
      "description": "The URL to call when logs are generated"
    }
  }
}