Skip to content

Latest commit

 

History

History
278 lines (189 loc) · 8.68 KB

IntegrationAuditLogSubscriptionsApi.md

File metadata and controls

278 lines (189 loc) · 8.68 KB

LaunchDarklyApi.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(integrationKey, subscriptionPost)

Create audit log subscription

Create an audit log subscription.<br /><br />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 LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.IntegrationAuditLogSubscriptionsApi();
let integrationKey = "integrationKey_example"; // String | The integration key
let subscriptionPost = {"config":{"optional":"an optional property","required":"the required property","url":"https://example.com"},"name":"Example audit log subscription.","on":false,"statements":[{"actions":["*"],"effect":"allow","resources":["proj/*:env/*:flag/*;testing-tag"]}],"tags":["testing-tag"]}; // SubscriptionPost | 
apiInstance.createSubscription(integrationKey, subscriptionPost, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
integrationKey String The integration key
subscriptionPost SubscriptionPost

Return type

Integration

Authorization

ApiKey

HTTP request headers

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

deleteSubscription

deleteSubscription(integrationKey, id)

Delete audit log subscription

Delete an audit log subscription.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.IntegrationAuditLogSubscriptionsApi();
let integrationKey = "integrationKey_example"; // String | The integration key
let id = "id_example"; // String | The subscription ID
apiInstance.deleteSubscription(integrationKey, id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
integrationKey String The integration key
id String The subscription ID

Return type

null (empty response body)

Authorization

ApiKey

HTTP request headers

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

getSubscriptionByID

Integration getSubscriptionByID(integrationKey, id)

Get audit log subscription by ID

Get an audit log subscription by ID.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.IntegrationAuditLogSubscriptionsApi();
let integrationKey = "integrationKey_example"; // String | The integration key
let id = "id_example"; // String | The subscription ID
apiInstance.getSubscriptionByID(integrationKey, id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
integrationKey String The integration key
id String The subscription ID

Return type

Integration

Authorization

ApiKey

HTTP request headers

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

getSubscriptions

Integrations getSubscriptions(integrationKey)

Get audit log subscriptions by integration

Get all audit log subscriptions associated with a given integration.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.IntegrationAuditLogSubscriptionsApi();
let integrationKey = "integrationKey_example"; // String | The integration key
apiInstance.getSubscriptions(integrationKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
integrationKey String The integration key

Return type

Integrations

Authorization

ApiKey

HTTP request headers

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

updateSubscription

Integration updateSubscription(integrationKey, id, patchOperation)

Update audit log subscription

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 LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.IntegrationAuditLogSubscriptionsApi();
let integrationKey = "integrationKey_example"; // String | The integration key
let id = "id_example"; // String | The ID of the audit log subscription
let patchOperation = [{"op":"replace","path":"/on","value":false}]; // [PatchOperation] | 
apiInstance.updateSubscription(integrationKey, id, patchOperation, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
integrationKey String The integration key
id String The ID of the audit log subscription
patchOperation [PatchOperation]

Return type

Integration

Authorization

ApiKey

HTTP request headers

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