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 classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.IntegrationAuditLogSubscriptionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    IntegrationAuditLogSubscriptionsApi apiInstance = new IntegrationAuditLogSubscriptionsApi(defaultClient);
    String integrationKey = "integrationKey_example"; // String | The integration key
    SubscriptionPost subscriptionPost = new SubscriptionPost(); // SubscriptionPost | 
    try {
      Integration result = apiInstance.createSubscription(integrationKey, subscriptionPost);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IntegrationAuditLogSubscriptionsApi#createSubscription");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

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

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	-

deleteSubscription

deleteSubscription(integrationKey, id)

Delete audit log subscription

Delete an audit log subscription.

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.IntegrationAuditLogSubscriptionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    IntegrationAuditLogSubscriptionsApi apiInstance = new IntegrationAuditLogSubscriptionsApi(defaultClient);
    String integrationKey = "integrationKey_example"; // String | The integration key
    String id = "id_example"; // String | The subscription ID
    try {
      apiInstance.deleteSubscription(integrationKey, id);
    } catch (ApiException e) {
      System.err.println("Exception when calling IntegrationAuditLogSubscriptionsApi#deleteSubscription");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

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

HTTP response details

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

getSubscriptionByID

Integration getSubscriptionByID(integrationKey, id)

Get audit log subscription by ID

Get an audit log subscription by ID.

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.IntegrationAuditLogSubscriptionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    IntegrationAuditLogSubscriptionsApi apiInstance = new IntegrationAuditLogSubscriptionsApi(defaultClient);
    String integrationKey = "integrationKey_example"; // String | The integration key
    String id = "id_example"; // String | The subscription ID
    try {
      Integration result = apiInstance.getSubscriptionByID(integrationKey, id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IntegrationAuditLogSubscriptionsApi#getSubscriptionByID");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

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

HTTP response details

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

getSubscriptions

Integrations getSubscriptions(integrationKey)

Get audit log subscriptions by integration

Get all audit log subscriptions associated with a given integration.

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.IntegrationAuditLogSubscriptionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    IntegrationAuditLogSubscriptionsApi apiInstance = new IntegrationAuditLogSubscriptionsApi(defaultClient);
    String integrationKey = "integrationKey_example"; // String | The integration key
    try {
      Integrations result = apiInstance.getSubscriptions(integrationKey);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IntegrationAuditLogSubscriptionsApi#getSubscriptions");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

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

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	-

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 classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.IntegrationAuditLogSubscriptionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    IntegrationAuditLogSubscriptionsApi apiInstance = new IntegrationAuditLogSubscriptionsApi(defaultClient);
    String integrationKey = "integrationKey_example"; // String | The integration key
    String id = "id_example"; // String | The ID of the audit log subscription
    List<PatchOperation> patchOperation = Arrays.asList(); // List<PatchOperation> | 
    try {
      Integration result = apiInstance.updateSubscription(integrationKey, id, patchOperation);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling IntegrationAuditLogSubscriptionsApi#updateSubscription");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
integrationKey	String	The integration key
id	String	The ID of the audit log subscription
patchOperation	List<PatchOperation>

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	-

Files

IntegrationAuditLogSubscriptionsApi.md

Latest commit

History

IntegrationAuditLogSubscriptionsApi.md

File metadata and controls

IntegrationAuditLogSubscriptionsApi

createSubscription

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteSubscription

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getSubscriptionByID

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getSubscriptions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateSubscription

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details