Create audit log subscription — LaunchDarkly

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.

Path parameters

integrationKeystringRequired

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.

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 objectsOptional

The location and content type of related resources

_idstringOptional

The ID for this integration audit log subscription

kindstringOptional

The type of integration

namestringOptional

A human-friendly name for the integration

configmap from strings to anyOptional

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 objectsOptional

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

onbooleanOptional

Whether the integration is currently active

tagslist of stringsOptional

An array of tags for this integration

_accessobjectOptional

Details on the allowed and denied actions for this subscription

_statusobjectOptional

Details on the most recent successes and errors for this integration

urlstringOptional

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

apiKeystringOptional

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

Errors

1 curl -X POST https://app.launchdarkly.com/api/v2/integrations/integrationKey \ 2 -H "Authorization: <apiKey>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "name": "Example audit log subscription.", 6 "config": { 7 "optional": "an optional property", 8 "required": "the required property", 9 "url": "https://example.com" 10 }, 11 "statements": [ 12 { 13 "effect": "allow", 14 "resources": [ 15 "proj/*:env/*:flag/*;testing-tag" 16 ], 17 "actions": [ 18 "*" 19 ] 20 } 21 ], 22 "on": false, 23 "tags": [ 24 "testing-tag" 25 ] 26 }'

1 { 2 "_links": { 3 "key": { 4 "href": "href", 5 "type": "type" 6 } 7 }, 8 "_id": "1234a56b7c89d012345e678f", 9 "kind": "datadog", 10 "name": "Example Datadog integration", 11 "config": { 12 "key": "value" 13 }, 14 "statements": [ 15 { 16 "effect": "allow", 17 "resources": [ 18 "proj/*:env/*;qa_*:/flag/*" 19 ], 20 "notResources": [ 21 "notResources" 22 ], 23 "actions": [ 24 "*" 25 ], 26 "notActions": [ 27 "notActions" 28 ] 29 } 30 ], 31 "on": true, 32 "tags": [ 33 "testing" 34 ], 35 "_access": { 36 "denied": [ 37 { 38 "action": "action", 39 "reason": { 40 "effect": "allow" 41 } 42 } 43 ], 44 "allowed": [ 45 { 46 "action": "action", 47 "reason": { 48 "effect": "allow" 49 } 50 } 51 ] 52 }, 53 "_status": { 54 "successCount": 1, 55 "lastSuccess": 1000000, 56 "lastError": 1000000, 57 "errorCount": 1, 58 "errors": [ 59 {} 60 ] 61 }, 62 "url": "url", 63 "apiKey": "apiKey" 64 }

1	curl -X POST https://app.launchdarkly.com/api/v2/integrations/integrationKey \
2	-H "Authorization: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "Example audit log subscription.",
6	"config": {
7	"optional": "an optional property",
8	"required": "the required property",
9	"url": "https://example.com"
10	},
11	"statements": [
12	{
13	"effect": "allow",
14	"resources": [
15	"proj/:env/:flag/*;testing-tag"
16	],
17	"actions": [
18	"*"
19	]
20	}
21	],
22	"on": false,
23	"tags": [
24	"testing-tag"
25	]
26	}'

1	{
2	"_links": {
3	"key": {
4	"href": "href",
5	"type": "type"
6	}
7	},
8	"_id": "1234a56b7c89d012345e678f",
9	"kind": "datadog",
10	"name": "Example Datadog integration",
11	"config": {
12	"key": "value"
13	},
14	"statements": [
15	{
16	"effect": "allow",
17	"resources": [
18	"proj/:env/;qa_:/flag/"
19	],
20	"notResources": [
21	"notResources"
22	],
23	"actions": [
24	"*"
25	],
26	"notActions": [
27	"notActions"
28	]
29	}
30	],
31	"on": true,
32	"tags": [
33	"testing"
34	],
35	"_access": {
36	"denied": [
37	{
38	"action": "action",
39	"reason": {
40	"effect": "allow"
41	}
42	}
43	],
44	"allowed": [
45	{
46	"action": "action",
47	"reason": {
48	"effect": "allow"
49	}
50	}
51	]
52	},
53	"_status": {
54	"successCount": 1,
55	"lastSuccess": 1000000,
56	"lastError": 1000000,
57	"errorCount": 1,
58	"errors": [
59	{}
60	]
61	},
62	"url": "url",
63	"apiKey": "apiKey"
64	}

Path parameters

Request

Response

Errors

zproxy.org