Skip to content

Latest commit

 

History

History
305 lines (207 loc) · 8.96 KB

IntegrationAuditLogSubscriptionsApi.md

File metadata and controls

305 lines (207 loc) · 8.96 KB

IntegrationAuditLogSubscriptionsApi

All URIs are relative to https://app.launchdarkly.com

Method HTTP request Description
createSubscription POST /api/v2/integrations/{integrationKey} Create audit log subscription
deleteSubscription DELETE /api/v2/integrations/{integrationKey}/{id} Delete audit log subscription
getSubscriptionByID GET /api/v2/integrations/{integrationKey}/{id} Get audit log subscription by ID
getSubscriptions GET /api/v2/integrations/{integrationKey} Get audit log subscriptions by integration
updateSubscription PATCH /api/v2/integrations/{integrationKey}/{id} Update audit log subscription

createSubscription

Integration createSubscription(subscriptionPost)

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.

Example

import {
    IntegrationAuditLogSubscriptionsApi,
    Configuration,
    SubscriptionPost
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new IntegrationAuditLogSubscriptionsApi(configuration);

let integrationKey: string; //The integration key (default to undefined)
let subscriptionPost: SubscriptionPost; //

const { status, data } = await apiInstance.createSubscription(
    integrationKey,
    subscriptionPost
);

Parameters

Name Type Description Notes
subscriptionPost SubscriptionPost
integrationKey [string] The integration key defaults to undefined

Return type

Integration

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Integration response -
400 Invalid request -
401 Invalid access token -
403 Forbidden -
404 Invalid resource identifier -
429 Rate limited -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteSubscription

deleteSubscription()

Delete an audit log subscription.

Example

import {
    IntegrationAuditLogSubscriptionsApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new IntegrationAuditLogSubscriptionsApi(configuration);

let integrationKey: string; //The integration key (default to undefined)
let id: string; //The subscription ID (default to undefined)

const { status, data } = await apiInstance.deleteSubscription(
    integrationKey,
    id
);

Parameters

Name Type Description Notes
integrationKey [string] The integration key defaults to undefined
id [string] The subscription ID defaults to undefined

Return type

void (empty response body)

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 Action succeeded -
401 Invalid access token -
403 Forbidden -
404 Invalid resource identifier -
429 Rate limited -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSubscriptionByID

Integration getSubscriptionByID()

Get an audit log subscription by ID.

Example

import {
    IntegrationAuditLogSubscriptionsApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new IntegrationAuditLogSubscriptionsApi(configuration);

let integrationKey: string; //The integration key (default to undefined)
let id: string; //The subscription ID (default to undefined)

const { status, data } = await apiInstance.getSubscriptionByID(
    integrationKey,
    id
);

Parameters

Name Type Description Notes
integrationKey [string] The integration key defaults to undefined
id [string] The subscription ID defaults to undefined

Return type

Integration

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Integration response -
401 Invalid access token -
403 Forbidden -
404 Invalid resource identifier -
429 Rate limited -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSubscriptions

Integrations getSubscriptions()

Get all audit log subscriptions associated with a given integration.

Example

import {
    IntegrationAuditLogSubscriptionsApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new IntegrationAuditLogSubscriptionsApi(configuration);

let integrationKey: string; //The integration key (default to undefined)

const { status, data } = await apiInstance.getSubscriptions(
    integrationKey
);

Parameters

Name Type Description Notes
integrationKey [string] The integration key defaults to undefined

Return type

Integrations

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Integrations collection response -
401 Invalid access token -
403 Forbidden -
404 Invalid resource identifier -
429 Rate limited -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateSubscription

Integration updateSubscription(patchOperation)

Update an audit log subscription configuration. Updating an audit log subscription uses a JSON patch representation of the desired changes. To learn more, read Updates.

Example

import {
    IntegrationAuditLogSubscriptionsApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new IntegrationAuditLogSubscriptionsApi(configuration);

let integrationKey: string; //The integration key (default to undefined)
let id: string; //The ID of the audit log subscription (default to undefined)
let patchOperation: Array<PatchOperation>; //

const { status, data } = await apiInstance.updateSubscription(
    integrationKey,
    id,
    patchOperation
);

Parameters

Name Type Description Notes
patchOperation Array
integrationKey [string] The integration key defaults to undefined
id [string] The ID of the audit log subscription defaults to undefined

Return type

Integration

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Integration response -
400 Invalid request -
403 Forbidden -
404 Invalid resource identifier -
409 Status conflict -
429 Rate limited -

[Back to top] [Back to API list] [Back to Model list] [Back to README]