Retrieves a list of Integration log drains

v1.0.0

Retrieves a list of all Integration log drains that are defined for the authorized account. When using an OAuth2 token, the list is limited to log drains created by the authenticated integration.

Input

{
  "type": "object",
  "properties": {
    "teamId": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "createdAt",
      "id",
      "type",
      "name",
      "ownerId",
      "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": [
          "production",
          "preview"
        ]
      },
      "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"
      }
    }
  }
}