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

Latest commit

 

History

History
184 lines (129 loc) · 8.07 KB

AuditLogApi.md

File metadata and controls

184 lines (129 loc) · 8.07 KB

LaunchDarklyApi.AuditLogApi

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

Method HTTP request Description
getAuditLogEntries GET /api/v2/auditlog List audit log entries
getAuditLogEntry GET /api/v2/auditlog/{id} Get audit log entry
postAuditLogEntries POST /api/v2/auditlog Search audit log entries

getAuditLogEntries

AuditLogEntryListingRepCollection getAuditLogEntries(opts)

List audit log entries

Get a list of all audit log entries. The query parameters let you restrict the results that return by date ranges, resource specifiers, or a full-text search query. LaunchDarkly uses a resource specifier syntax to name resources or collections of resources. To learn more, read About the resource specifier syntax.

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.AuditLogApi();
let opts = {
  'before': 789, // Number | A timestamp filter, expressed as a Unix epoch time in milliseconds.  All entries this returns occurred before the timestamp.
  'after': 789, // Number | A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred after the timestamp.
  'q': "q_example", // String | Text to search for. You can search for the full or partial name of the resource.
  'limit': 789, // Number | A limit on the number of audit log entries that return. Set between 1 and 20. The default is 10.
  'spec': "spec_example" // String | A resource specifier that lets you filter audit log listings by resource
};
apiInstance.getAuditLogEntries(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
before Number A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred before the timestamp. [optional]
after Number A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred after the timestamp. [optional]
q String Text to search for. You can search for the full or partial name of the resource. [optional]
limit Number A limit on the number of audit log entries that return. Set between 1 and 20. The default is 10. [optional]
spec String A resource specifier that lets you filter audit log listings by resource [optional]

Return type

AuditLogEntryListingRepCollection

Authorization

ApiKey

HTTP request headers

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

getAuditLogEntry

AuditLogEntryRep getAuditLogEntry(id)

Get audit log entry

Fetch a detailed audit log entry representation. The detailed representation includes several fields that are not present in the summary representation, including: - `previousVersion`: a JSON representation of the previous version of the entity. - `currentVersion`: a JSON representation of the current version of the entity. - `delta`: the JSON patch body that was used in the request to update the entity. This is only included if the update was made through a JSON patch. It is null when the update was made using semantic patch. Because most flag updates are made using semantic patch, this field is rarely returned.

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.AuditLogApi();
let id = "id_example"; // String | The ID of the audit log entry
apiInstance.getAuditLogEntry(id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
id String The ID of the audit log entry

Return type

AuditLogEntryRep

Authorization

ApiKey

HTTP request headers

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

postAuditLogEntries

AuditLogEntryListingRepCollection postAuditLogEntries(opts)

Search audit log entries

Search your audit log entries. The query parameters let you restrict the results that return by date ranges, or a full-text search query. The request body lets you restrict the results that return by resource specifiers. LaunchDarkly uses a resource specifier syntax to name resources or collections of resources. To learn more, read About the resource specifier syntax.

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.AuditLogApi();
let opts = {
  'before': 789, // Number | A timestamp filter, expressed as a Unix epoch time in milliseconds.  All entries returned occurred before the timestamp.
  'after': 789, // Number | A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned occurred after the timestamp.
  'q': "q_example", // String | Text to search for. You can search for the full or partial name of the resource.
  'limit': 789, // Number | A limit on the number of audit log entries that return. Set between 1 and 20. The default is 10.
  'statementPost': [new LaunchDarklyApi.StatementPost()] // [StatementPost] | 
};
apiInstance.postAuditLogEntries(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
before Number A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned occurred before the timestamp. [optional]
after Number A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned occurred after the timestamp. [optional]
q String Text to search for. You can search for the full or partial name of the resource. [optional]
limit Number A limit on the number of audit log entries that return. Set between 1 and 20. The default is 10. [optional]
statementPost [StatementPost] [optional]

Return type

AuditLogEntryListingRepCollection

Authorization

ApiKey

HTTP request headers

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