Create audit log subscription | LaunchDarkly

import requests
url = "https://app.launchdarkly.com/api/v2/integrations/integrationKey"
payload = {
    "name": "Example audit log subscription.",
    "config": {
        "optional": "an optional property",
        "required": "the required property",
        "url": "https://example.com"
    },
    "statements": [
        {
            "effect": "allow",
            "resources": ["proj/*:env/*:flag/*;testing-tag"],
            "actions": ["*"]
        }
    ],
    "on": False,
    "tags": ["testing-tag"]
}
headers = {
    "Authorization": "<apiKey>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "_links": {},
  "_id": "1234a56b7c89d012345e678f",
  "kind": "datadog",
  "name": "Example Datadog integration",
  "config": {},
  "statements": [
    {
      "effect": "allow",
      "resources": [
        "proj/*:env/*;qa_*:/flag/*"
      ],
      "notResources": [
        "string"
      ],
      "actions": [
        "*"
      ],
      "notActions": [
        "string"
      ]
    }
  ],
  "on": true,
  "tags": [
    "testing"
  ],
  "_access": {
    "denied": [
      {
        "action": "string",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "string"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "string"
          ],
          "role_name": "string"
        }
      }
    ],
    "allowed": [
      {
        "action": "string",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "string"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "string"
          ],
          "role_name": "string"
        }
      }
    ]
  },
  "_status": {
    "successCount": 1,
    "lastSuccess": 1,
    "lastError": 1,
    "errorCount": 1,
    "errors": [
      {
        "statusCode": 1,
        "responseBody": "string",
        "timestamp": 1
      }
    ]
  },
  "url": "string",
  "apiKey": "string"
}

Create an audit log subscription.

For each subscription, you must specify the set of resources you wish to subscribe to audit log notifications for. You can describe these resources using a custom role policy. To learn more, read Custom role concepts.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

integrationKeystringRequiredformat: "string"

The integration key

Request

This endpoint expects an object.

namestringRequired

A human-friendly name for your audit log subscription.

configmap from strings to anyRequired

The unique set of fields required to configure an audit log subscription integration of this type. Refer to the formVariables field in the corresponding manifest.json at https://github.com/launchdarkly/integration-framework/tree/main/integrations for a full list of fields for the integration you wish to configure.

The unique set of fields required to configure an audit log subscription integration of this type. Refer to the <code>formVariables</code> field in the corresponding <code>manifest.json</code> at https://github.com/launchdarkly/integration-framework/tree/main/integrations for a full list of fields for the integration you wish to configure.

statementslist of objectsOptional

The set of resources you wish to subscribe to audit log notifications for.

onbooleanOptional

Whether or not you want your subscription to actively send events.

tagslist of stringsOptional

An array of tags for this subscription.

urlstringOptional

Slack webhook receiver URL. Only necessary for legacy Slack webhook integrations.

apiKeystringOptional

Datadog API key. Only necessary for legacy Datadog webhook integrations.

Response

Integration response

_linksmap from strings to objects

The location and content type of related resources

_idstring

The ID for this integration audit log subscription

kindstring

The type of integration

namestring

A human-friendly name for the integration

configmap from strings to any

Details on configuration for an integration of this type. Refer to the formVariables field in the corresponding manifest.json for a full list of fields for each integration.

statementslist of objects

Represents a Custom role policy, defining a resource kinds filter the integration audit log subscription responds to.

onboolean

Whether the integration is currently active

tagslist of strings

An array of tags for this integration

_accessobject

Details on the allowed and denied actions for this subscription

_statusobject

Details on the most recent successes and errors for this integration

urlstring

Slack webhook receiver URL. Only used for legacy Slack webhook integrations.

apiKeystring

Datadog API key. Only used for legacy Datadog webhook integrations.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error