LaunchDarkly REST API
  1. Projects
LaunchDarkly REST API
  • Relay proxy configurations
    • Returns a list of relay proxy configurations in the account.
      GET
    • Create a new relay proxy config.
      POST
    • Delete a relay proxy configuration by ID.
      DELETE
    • Get a single relay proxy configuration by ID.
      GET
    • Modify a relay proxy configuration by ID.
      PATCH
    • Reset a relay proxy configuration's secret key with an optional expiry time for the old key.
      POST
  • Audit log
    • Get a list of all audit log entries. The query parameters allow you to restrict the returned results by date ranges, resource specifiers, or a full-text search query.
      GET
    • Use this endpoint to fetch a single audit log entry by its resouce ID.
      GET
  • Data export destinations
    • Returns a list of all data export destinations.
      GET
    • Create a new data export destination
      POST
    • Get a single data export destination by ID
      DELETE
    • Get a single data export destination by ID
      GET
    • Perform a partial update to a data export destination.
      PATCH
  • Feature flags
    • Get the status for a particular feature flag across environments
      GET
    • Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as the state of the flag.
      GET
    • Get the status for a particular feature flag.
      GET
    • Get a list of all features in the given project.
      GET
    • Creates a new feature flag.
      POST
    • Get dependent flags for the flag in the environment specified in path parameters
      GET
    • Delete a feature flag in all environments. Be careful-- only delete feature flags that are no longer being used by your application.
      DELETE
    • Get a single feature flag by key.
      GET
    • Perform a partial update to a feature.
      PATCH
    • Copies the feature flag configuration from one environment to the same feature flag in another environment.
      POST
    • Get dependent flags across all environments for the flag specified in the path parameters
      GET
    • Get expiring user targets for feature flag
      GET
    • Update, add, or delete expiring user targets on feature flag
      PATCH
    • Get all approval requests for a feature flag config
      GET
    • Delete an approval request for a feature flag config
      DELETE
    • Get a single approval request for a feature flag config
      GET
    • Create an approval request for a feature flag config
      POST
    • Apply approval request for a feature flag config
      POST
    • Review approval request for a feature flag config
      POST
    • Get all scheduled workflows for a feature flag by key.
      GET
    • Creates a new scheduled change for a feature flag.
      POST
    • Lists conflicts between the given instructions and any existing scheduled changes for the feature flag. The actual HTTP verb should be REPORT, not POST.
      POST
    • Delete a scheduled change on a feature flag in an environment.
      DELETE
    • Get a scheduled change on a feature flag by id.
      GET
    • Updates an existing scheduled-change on a feature flag in an environment.
      PATCH
  • Integrations
    • Get a list of all configured audit log event integrations associated with this account.
    • Get a list of all configured integrations of a given kind.
    • Create a new integration subscription of a given kind.
    • Delete an integration subscription by ID.
    • Get a single integration subscription by ID.
    • Modify an integration subscription by ID.
  • Team members
    • Returns a list of all members in the account.
    • Invite new members.
    • Get the current team member associated with the token
    • Delete a team member by ID.
    • Get a single team member by ID.
    • Modify a team member by ID.
  • Projects
    • Returns a list of all projects in the account.
      GET
    • Create a new project with the given key and name.
      POST
    • Delete a project by key. Caution-- deleting a project will delete all associated environments and feature flags. You cannot delete the last project in an account.
      DELETE
    • Fetch a single project by key.
      GET
    • Modify a project by ID.
      PATCH
  • Environments
    • Create a new environment in a specified project with a given name, key, and swatch color.
    • Delete an environment in a specific project.
    • Get an environment given a project and key.
    • Modify an environment by ID. If you try to patch the environment by setting both required and requiredApprovalTags, it will result in an error. Users can specify either required approvals for all flags in an environment or those with specific tags, but no
    • Reset an environment's SDK key with an optional expiry time for the old key.
    • Reset an environment's mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately.
  • Custom roles
    • Return a complete list of custom roles.
    • Create a new custom role.
    • Delete a custom role by key.
    • Get one custom role by key.
    • Modify a custom role by key.
  • User segments
    • Get a list of all user segments in the given project.
    • Creates a new user segment.
    • Delete a user segment.
    • Get a single user segment by key.
    • Perform a partial update to a user segment.
    • Update targets included or excluded in a big segment
    • Get expiring user targets for user segment
    • Update, add, or delete expiring user targets on user segment
  • Access tokens
    • Returns a list of tokens in the account.
    • Create a new token.
    • Delete an access token by ID.
    • Get a single access token by ID.
    • Modify an access token by ID.
    • Reset an access token's secret key with an optional expiry time for the old key.
  • Customer Metrics
    • Returns of the usage endpoints available.
    • Get events usage by event id and the feature flag key.
    • Get events usage endpoints.
    • Get events usage by event type.
    • Get monthly active user data.
    • Get monthly active user data by category.
    • Returns a list of all streams.
    • Get a stream endpoint and return timeseries data.
    • Get a stream timeseries data by source show sdk version metadata.
    • Get a stream timeseries data by source and show all sdk version associated.
  • Users
    • Search users in LaunchDarkly based on their last active date, or a search query. It should not be used to enumerate all users in LaunchDarkly-- use the List users API resource.
    • List all users in the environment. Includes the total count of users. In each page, there will be up to 'limit' users returned (default 20). This is useful for exporting all users in the system for further analysis. Paginated collections will include a ne
    • Delete a user by ID.
    • Get a user by key.
  • User settings
    • Fetch a single flag setting for a user by key.
    • Fetch a single flag setting for a user by key.
    • Specifically enable or disable a feature flag for a user based on their key.
    • Get expiring dates on flags for user
    • Update, add, or delete expiring user targets for a single user on all flags
  • Webhooks
    • Fetch a list of all webhooks.
    • Create a webhook.
    • Delete a webhook by ID.
    • Get a webhook by ID.
    • Modify a webhook by ID.
  • /
    GET
  1. Projects

Create a new project with the given key and name.

POST
/projects
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://app.launchdarkly.com/api/v2/projects' \
--header 'Content-Type: application/json' \
--data-raw '{
    "defaultClientSideAvailability": {
        "usingEnvironmentId": true,
        "usingMobileKey": true
    },
    "environments": [
        {
            "color": "417505",
            "confirmChanges": false,
            "defaultTrackEvents": false,
            "defaultTtl": 0,
            "key": "dev",
            "name": "Development",
            "requireComments": false,
            "secureMode": false,
            "tags": [
                "tag1",
                "tag2"
            ]
        }
    ],
    "includeInSnippetByDefault": false,
    "key": "new-project",
    "name": "New Project",
    "tags": [
        "ops",
        "dev"
    ]
}'
Response Response Example
201 - Example 1
{
    "_id": "5a580a01b4ff89217bdf9dc1",
    "_links": {
        "next": {
            "href": "/api/v2/endpoint",
            "type": "application/json"
        },
        "self": {
            "href": "/api/v2/endpoint",
            "type": "application/json"
        }
    },
    "defaultClientSideAvailability": {
        "usingEnvironmentId": true,
        "usingMobileKey": true
    },
    "environments": [
        {
            "_id": "5a580a01b4ff89217bdf9dc1",
            "_links": {
                "next": {
                    "href": "/api/v2/endpoint",
                    "type": "application/json"
                },
                "self": {
                    "href": "/api/v2/endpoint",
                    "type": "application/json"
                }
            },
            "apiKey": "XXX",
            "approvalSettings": {
                "canApplyDeclinedChanges": true,
                "canReviewOwnRequest": true,
                "minNumApprovals": 2,
                "required": true,
                "requiredApprovalTags": [
                    "string"
                ],
                "serviceKind": "launchdarkly"
            },
            "color": "417505",
            "confirmChanges": false,
            "defaultTrackEvents": false,
            "defaultTtl": 0,
            "key": "production",
            "mobileKey": "XXX",
            "name": "Production",
            "requireComments": false,
            "secureMode": false,
            "tags": [
                "string"
            ]
        }
    ],
    "includeInSnippetByDefault": true,
    "key": "zentasks",
    "name": "Zentasks",
    "tags": [
        "string"
    ]
}

Request

Body Params application/json

Examples

Responses

🟢201OK
application/json
Body

🟠400400
🟠401401
🟠409409
Modified at 2022-09-11 22:47:17
Previous
Returns a list of all projects in the account.
Next
Delete a project by key. Caution-- deleting a project will delete all associated environments and feature flags. You cannot delete the last project in an account.
Built with