Skip to content
This repository was archived by the owner on Feb 3, 2026. It is now read-only.

Latest commit

 

History

History
331 lines (228 loc) · 11.4 KB

IntegrationAuditLogSubscriptionsApi.md

File metadata and controls

331 lines (228 loc) · 11.4 KB

LaunchDarklyApi\IntegrationAuditLogSubscriptionsApi

All URIs are relative to https://app.launchdarkly.com, except if the operation defines another base path.

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()

createSubscription($integration_key, $subscription_post): \LaunchDarklyApi\Model\Integration

Create audit log subscription

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\IntegrationAuditLogSubscriptionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$integration_key = 'integration_key_example'; // string | The integration key
$subscription_post = {"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"]}; // \LaunchDarklyApi\Model\SubscriptionPost

try {
    $result = $apiInstance->createSubscription($integration_key, $subscription_post);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationAuditLogSubscriptionsApi->createSubscription: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
integration_key string The integration key
subscription_post \LaunchDarklyApi\Model\SubscriptionPost

Return type

\LaunchDarklyApi\Model\Integration

Authorization

ApiKey

HTTP request headers

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

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

deleteSubscription()

deleteSubscription($integration_key, $id)

Delete audit log subscription

Delete an audit log subscription.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\IntegrationAuditLogSubscriptionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$integration_key = 'integration_key_example'; // string | The integration key
$id = 'id_example'; // string | The subscription ID

try {
    $apiInstance->deleteSubscription($integration_key, $id);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationAuditLogSubscriptionsApi->deleteSubscription: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
integration_key string The integration key
id string The subscription ID

Return type

void (empty response body)

Authorization

ApiKey

HTTP request headers

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

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

getSubscriptionByID()

getSubscriptionByID($integration_key, $id): \LaunchDarklyApi\Model\Integration

Get audit log subscription by ID

Get an audit log subscription by ID.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\IntegrationAuditLogSubscriptionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$integration_key = 'integration_key_example'; // string | The integration key
$id = 'id_example'; // string | The subscription ID

try {
    $result = $apiInstance->getSubscriptionByID($integration_key, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationAuditLogSubscriptionsApi->getSubscriptionByID: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
integration_key string The integration key
id string The subscription ID

Return type

\LaunchDarklyApi\Model\Integration

Authorization

ApiKey

HTTP request headers

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

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

getSubscriptions()

getSubscriptions($integration_key): \LaunchDarklyApi\Model\Integrations

Get audit log subscriptions by integration

Get all audit log subscriptions associated with a given integration.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\IntegrationAuditLogSubscriptionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$integration_key = 'integration_key_example'; // string | The integration key

try {
    $result = $apiInstance->getSubscriptions($integration_key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationAuditLogSubscriptionsApi->getSubscriptions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
integration_key string The integration key

Return type

\LaunchDarklyApi\Model\Integrations

Authorization

ApiKey

HTTP request headers

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

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

updateSubscription()

updateSubscription($integration_key, $id, $patch_operation): \LaunchDarklyApi\Model\Integration

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\IntegrationAuditLogSubscriptionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$integration_key = 'integration_key_example'; // string | The integration key
$id = 'id_example'; // string | The ID of the audit log subscription
$patch_operation = [{"op":"replace","path":"/on","value":false}]; // \LaunchDarklyApi\Model\PatchOperation[]

try {
    $result = $apiInstance->updateSubscription($integration_key, $id, $patch_operation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationAuditLogSubscriptionsApi->updateSubscription: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
integration_key string The integration key
id string The ID of the audit log subscription
patch_operation \LaunchDarklyApi\Model\PatchOperation[]

Return type

\LaunchDarklyApi\Model\Integration

Authorization

ApiKey

HTTP request headers

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

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