Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://app.launchdarkly.com
https://app.launchdarkly.us
/api/v2/tokens/{id}
Delete an access token by ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | The ID of the access token to update |
DELETE /api/v2/tokens/{id}
/api/v2/members/{id}
Delete a single account member by ID. Requests to delete account members will not work if SCIM is enabled for the account.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | The member ID |
DELETE /api/v2/members/{id}
/api/v2/applications/{applicationKey}
Delete an application.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| applicationKey | path | required | string | The application key |
DELETE /api/v2/applications/{applicationKey}
/api/v2/applications/{applicationKey}/versions/{versionKey}
Delete an application version.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| applicationKey | path | required | string | The application key |
| versionKey | path | required | string | The application version key |
DELETE /api/v2/applications/{applicationKey}/versions/{versionKey}
/api/v2/approval-requests/{id}
Delete an approval request.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | The approval request ID |
DELETE /api/v2/approval-requests/{id}
/api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}
Delete an approval request for a feature flag.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| projectKey | path | required | string | The project key |
| featureFlagKey | path | required | string | The feature flag key |
| environmentKey | path | required | string | The environment key |
| id | path | required | string | The feature flag approval request ID |
DELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}
/api/v2/code-refs/repositories/{repo}
Delete a repository with the specified name.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| repo | path | required | string | The repository name |
DELETE /api/v2/code-refs/repositories/{repo}
/api/v2/projects/{projectKey}/environments/{environmentKey}/context-instances/{id}
Delete context instances by ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| projectKey | path | required | string | The project key |
| environmentKey | path | required | string | The environment key |
| id | path | required | string | The context instance ID |
DELETE /api/v2/projects/{projectKey}/environments/{environmentKey}/context-instances/{id}
/api/v2/roles/{customRoleKey}
Delete a custom role by key
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| customRoleKey | path | required | string | The custom role key |
DELETE /api/v2/roles/{customRoleKey}
/api/v2/destinations/{projectKey}/{environmentKey}/{id}
Delete a Data Export destination by ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| projectKey | path | required | string | The project key |
| environmentKey | path | required | string | The environment key |
| id | path | required | string | The Data Export destination ID |
DELETE /api/v2/destinations/{projectKey}/{environmentKey}/{id}
/api/v2/projects/{projectKey}/environments/{environmentKey}
Delete a environment by key.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| projectKey | path | required | string | The project key |
| environmentKey | path | required | string | The environment key |
DELETE /api/v2/projects/{projectKey}/environments/{environmentKey}
/api/v2/flags/{projectKey}/{featureFlagKey}
Delete a feature flag in all environments. Use with caution: only delete feature flags your application no longer uses.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| projectKey | path | required | string | The project key |
| featureFlagKey | path | required | string | The feature flag key. The key identifies the flag in your code. |
DELETE /api/v2/flags/{projectKey}/{featureFlagKey}
/api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}/{id}
Delete a flag link by ID or key.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| projectKey | path | required | string | The project key |
| featureFlagKey | path | required | string | The feature flag key |
| id | path | required | string | The flag link ID or Key |
DELETE /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}/{id}
/api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}
Delete a flag trigger by ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| projectKey | path | required | string | The project key |
| environmentKey | path | required | string | The environment key |
| featureFlagKey | path | required | string | The feature flag key |
| id | path | required | string | The flag trigger ID |
DELETE /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}
/api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/followers/{memberId}
Remove a member as a follower to a flag in a project and environment
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| projectKey | path | required | string | The project key |
| featureFlagKey | path | required | string | The feature flag key |
| environmentKey | path | required | string | The environment key |
| memberId | path | required | string | The memberId of the member to remove as a follower of the flag. Reader roles can only remove themselves. |
DELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/followers/{memberId}
/api/v2/engineering-insights/repositories/{repositoryKey}/projects/{projectKey}
Remove repository project association
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| repositoryKey | path | required | string | The repository key |
| projectKey | path | required | string | The project key |
DELETE /api/v2/engineering-insights/repositories/{repositoryKey}/projects/{projectKey}
/api/v2/engineering-insights/insights/groups/{insightGroupKey}
Delete insight group
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| insightGroupKey | path | required | string | The insight group key |
DELETE /api/v2/engineering-insights/insights/groups/{insightGroupKey}
/api/v2/integrations/{integrationKey}/{id}
Delete an audit log subscription.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| integrationKey | path | required | string | The integration key |
| id | path | required | string | The subscription ID |
DELETE /api/v2/integrations/{integrationKey}/{id}
/api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}
Delete a delivery configuration.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| projectKey | path | required | string | The project key |
| environmentKey | path | required | string | The environment key |
| integrationKey | path | required | string | The integration key |
| id | path | required | string | The configuration ID |
DELETE /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}
/api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId}
Delete a persistent store integration. Each integration uses either Redis or DynamoDB.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| projectKey | path | required | string | The project key |
| environmentKey | path | required | string | The environment key |
| integrationKey | path | required | string | The integration key, either `redis` or `dynamodb` |
| integrationId | path | required | string | The integration ID |
DELETE /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId}
/api/v2/metrics/{projectKey}/{metricKey}
Delete a metric by key.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| projectKey | path | required | string | The project key |
| metricKey | path | required | string | The metric key |
DELETE /api/v2/metrics/{projectKey}/{metricKey}
/api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}
Delete a metric group by key.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| projectKey | path | required | string | The project key |
| metricGroupKey | path | required | string | The metric group key |
DELETE /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}
/api/v2/oauth/clients/{clientId}
Delete an existing OAuth 2.0 client by unique client ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| clientId | path | required | string | The client ID |
DELETE /api/v2/oauth/clients/{clientId}
/api/v2/projects/{projectKey}
Delete a project by key. Use this endpoint with caution. Deleting a project will delete all associated environments and feature flags. You cannot delete the last project in an account.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| projectKey | path | required | string | The project key |
DELETE /api/v2/projects/{projectKey}
/api/v2/account/relay-auto-configs/{id}
Delete a Relay Proxy config.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | The relay auto config id |
DELETE /api/v2/account/relay-auto-configs/{id}
/api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}
Deletes a release pipeline. You cannot delete the default release pipeline. If you want to delete a release pipeline that is currently the default, create a second release pipeline and set it as the default. Then delete the first release pipeline. To change the default release pipeline, use the [Update project](https://apidocs.launchdarkly.com) API to set the `defaultReleasePipelineKey`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| projectKey | path | required | string | The project key |
| pipelineKey | path | required | string | The release pipeline key |
DELETE /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}
/api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id}
Delete a scheduled changes workflow.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| projectKey | path | required | string | The project key |
| featureFlagKey | path | required | string | The feature flag key |
| environmentKey | path | required | string | The environment key |
| id | path | required | string | The scheduled change id |
DELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id}
/api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}
Delete a segment.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| projectKey | path | required | string | The project key |
| environmentKey | path | required | string | The environment key |
| segmentKey | path | required | string | The segment key |
DELETE /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}
/api/v2/teams/{teamKey}
Delete a team by key. To learn more, read [Deleting a team](https://docs.launchdarkly.com/home/teams/managing#deleting-a-team).
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| teamKey | path | required | string | The team key |
DELETE /api/v2/teams/{teamKey}
/api/v2/webhooks/{id}
Delete a webhook by ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | The ID of the webhook to delete |
DELETE /api/v2/webhooks/{id}
/api/v2/templates/{templateKey}
Delete a workflow template
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| templateKey | path | required | string | The template key |
DELETE /api/v2/templates/{templateKey}
/api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows/{workflowId}
Delete a workflow from a feature flag.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| projectKey | path | required | string | The project key |
| featureFlagKey | path | required | string | The feature flag key |
| environmentKey | path | required | string | The environment key |
| workflowId | path | required | string | The workflow id |
DELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows/{workflowId}
Access
{
"type": "object",
"required": [
"denied",
"allowed"
],
"properties": {
"denied": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccessDenied"
}
},
"allowed": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccessAllowedRep"
}
}
}
}
AccessAllowedReason
{
"type": "object",
"required": [
"effect"
],
"properties": {
"effect": {
"enum": [
"allow",
"deny"
],
"type": "string",
"example": "allow",
"description": "Whether this statement should allow or deny actions on the resources."
},
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActionSpecifier"
},
"example": [
"*"
],
"description": "Actions to perform on a resource"
},
"resources": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"proj/*:env/*;qa_*:/flag/*"
],
"description": "Resource specifier strings"
},
"role_name": {
"type": "string"
},
"notActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActionSpecifier"
},
"description": "Targeted actions are the actions NOT in this list. The <code>actions</code> and <code>notResources</code> fields must be empty to use this field."
},
"notResources": {
"type": "array",
"items": {
"type": "string"
},
"description": "Targeted resources are the resources NOT in this list. The <code>resources</code> and <code>notActions</code> fields must be empty to use this field."
}
}
}
AccessAllowedRep
{
"type": "object",
"required": [
"action",
"reason"
],
"properties": {
"action": {
"$ref": "#/components/schemas/ActionIdentifier"
},
"reason": {
"$ref": "#/components/schemas/AccessAllowedReason"
}
}
}
AccessDenied
{
"type": "object",
"required": [
"action",
"reason"
],
"properties": {
"action": {
"$ref": "#/components/schemas/ActionIdentifier"
},
"reason": {
"$ref": "#/components/schemas/AccessDeniedReason"
}
}
}
AccessDeniedReason
{
"type": "object",
"required": [
"effect"
],
"properties": {
"effect": {
"enum": [
"allow",
"deny"
],
"type": "string",
"example": "allow",
"description": "Whether this statement should allow or deny actions on the resources."
},
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActionSpecifier"
},
"example": [
"*"
],
"description": "Actions to perform on a resource"
},
"resources": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"proj/*:env/*;qa_*:/flag/*"
],
"description": "Resource specifier strings"
},
"role_name": {
"type": "string"
},
"notActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActionSpecifier"
},
"description": "Targeted actions are the actions NOT in this list. The <code>actions</code> and <code>notResources</code> fields must be empty to use this field."
},
"notResources": {
"type": "array",
"items": {
"type": "string"
},
"description": "Targeted resources are the resources NOT in this list. The <code>resources</code> and <code>notActions</code> fields must be empty to use this field."
}
}
}
AccessTokenPost
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "A human-friendly name for the access token"
},
"role": {
"enum": [
"reader",
"writer",
"admin"
],
"type": "string",
"description": "Built-in role for the token"
},
"inlineRole": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatementPost"
},
"description": "A JSON array of statements represented as JSON objects with three attributes: effect, resources, actions. May be used in place of a built-in or custom role."
},
"description": {
"type": "string",
"description": "A description for the access token"
},
"serviceToken": {
"type": "boolean",
"description": "Whether the token is a service token https://docs.launchdarkly.com/home/account-security/api-access-tokens#service-tokens"
},
"customRoleIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of custom role IDs to use as access limits for the access token"
},
"defaultApiVersion": {
"type": "integer",
"description": "The default API version for this token"
}
}
}
ActionIdentifier
{
"type": "string"
}
ActionInput
{
"type": "object",
"properties": {
"instructions": {
"example": "{\"instructions\": [{ \"kind\": \"turnFlagOn\"}]}",
"description": "An array of instructions for the stage. Each object in the array uses the semantic patch format for updating a feature flag."
}
}
}
ActionOutput
{
"type": "object",
"required": [
"kind",
"instructions"
],
"properties": {
"kind": {
"type": "string",
"example": "patch",
"description": "The type of action for this stage"
},
"instructions": {
"$ref": "#/components/schemas/Instructions",
"example": "[{\"kind\": \"turnFlagOn\"}]",
"description": "An array of instructions for the stage. Each object in the array uses the semantic patch format for updating a feature flag."
}
}
}
ActionSpecifier
{
"type": "string"
}
AllVariationsSummary
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/VariationSummary"
}
}
ApplicationCollectionRep
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationRep"
},
"description": "A list of applications"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"example": 1,
"description": "The number of applications"
}
}
}
ApplicationFlagCollectionRep
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagListingRep"
},
"description": "A list of the flags that have been evaluated by the application"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"example": 1,
"description": "The number of flags that have been evaluated by the application"
}
}
}
ApplicationRep
{
"type": "object",
"required": [
"autoAdded",
"key",
"kind",
"name"
],
"properties": {
"key": {
"type": "string",
"example": "com.launchdarkly.cafe",
"description": "The unique identifier of this application"
},
"kind": {
"enum": [
"browser",
"mobile",
"server"
],
"type": "string",
"example": "mobile",
"description": "To distinguish the kind of application"
},
"name": {
"type": "string",
"example": "LaunchDarklyCafe",
"description": "The name of the application"
},
"flags": {
"$ref": "#/components/schemas/ApplicationFlagCollectionRep",
"description": "Details about the flags that have been evaluated by the application"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"_access": {
"$ref": "#/components/schemas/Access",
"description": "Details on the allowed and denied actions for this application"
},
"_version": {
"type": "integer",
"description": "Version of the application"
},
"autoAdded": {
"type": "boolean",
"example": true,
"description": "Whether the application was automatically created because it was included in a context when a LaunchDarkly SDK evaluated a feature flag, or was created through the LaunchDarkly UI or REST API."
},
"_maintainer": {
"$ref": "#/components/schemas/MaintainerRep",
"description": "Associated maintainer member or team info for the application"
},
"description": {
"type": "string",
"example": "The LaunchDarkly Cafe app",
"description": "The application description"
},
"creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when the application version was created"
}
}
}
ApplicationVersionRep
{
"type": "object",
"required": [
"autoAdded",
"key",
"name"
],
"properties": {
"key": {
"type": "string",
"example": "2",
"description": "The unique identifier of this application version"
},
"name": {
"type": "string",
"example": "01.02.03",
"description": "The name of this version"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"_access": {
"$ref": "#/components/schemas/Access",
"description": "Details on the allowed and denied actions for this application version"
},
"_version": {
"type": "integer",
"description": "Version of the application version"
},
"autoAdded": {
"type": "boolean",
"example": true,
"description": "Whether the application version was automatically created, because it was included in a context when a LaunchDarkly SDK evaluated a feature flag, or if the application version was created through the LaunchDarkly UI or REST API. "
},
"supported": {
"type": "boolean",
"example": true,
"description": "Whether this version is supported. Only applicable if the application <code>kind</code> is <code>mobile</code>."
},
"creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when the application version was created"
}
}
}
ApplicationVersionsCollectionRep
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationVersionRep"
},
"description": "A list of the versions for this application"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"example": 1,
"description": "The number of versions for this application"
}
}
}
ApprovalRequestResponse
{
"type": "object",
"required": [
"_id",
"_version",
"creationDate",
"serviceKind",
"reviewStatus",
"allReviews",
"notifyMemberIds",
"status",
"instructions",
"conflicts",
"_links"
],
"properties": {
"_id": {
"type": "string",
"example": "12ab3c45de678910abc12345",
"description": "The ID of this approval request"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {}
},
"source": {
"$ref": "#/components/schemas/CopiedFromEnv",
"description": "Details about the source feature flag, if copied"
},
"status": {
"enum": [
"pending",
"completed",
"failed",
"scheduled"
],
"type": "string",
"example": "pending",
"description": "Current status of the approval request"
},
"_version": {
"type": "integer",
"example": 1,
"description": "Version of the approval request"
},
"conflicts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Conflict"
},
"description": "Details on any conflicting approval requests"
},
"allReviews": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReviewResponse"
},
"description": "An array of individual reviews of this approval request"
},
"resourceId": {
"type": "string",
"description": "String representation of a resource"
},
"appliedDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when the approval request was applied"
},
"description": {
"type": "string",
"example": "example: request approval from someone",
"description": "A human-friendly name for the approval request"
},
"requestorId": {
"type": "string",
"example": "12ab3c45de678910abc12345",
"description": "The ID of the member who requested the approval"
},
"serviceKind": {
"$ref": "#/components/schemas/ApprovalRequestServiceKind",
"example": "launchdarkly",
"description": "The approval service for this request. May be LaunchDarkly or an external approval service, such as ServiceNow or JIRA."
},
"creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when the approval request was created"
},
"instructions": {
"$ref": "#/components/schemas/Instructions",
"example": "[{\"kind\": \"turnFlagOn\"}]",
"description": "List of instructions in semantic patch format to be applied to the feature flag"
},
"reviewStatus": {
"enum": [
"approved",
"declined",
"pending"
],
"type": "string",
"example": "pending",
"description": "Current status of the review of this approval request"
},
"executionDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp for when instructions will be executed"
},
"operatingOnId": {
"type": "string",
"example": "12ab3c45de678910abc12345",
"description": "ID of scheduled change to edit or delete"
},
"notifyMemberIds": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"1234a56b7c89d012345e678f"
],
"description": "An array of member IDs. These members are notified to review the approval request."
},
"approvalSettings": {
"$ref": "#/components/schemas/ApprovalSettings",
"description": "The settings for this approval"
},
"appliedByMemberId": {
"type": "string",
"example": "1234a56b7c89d012345e678f",
"description": "The member ID of the member who applied the approval request"
},
"integrationMetadata": {
"$ref": "#/components/schemas/IntegrationMetadata",
"description": "Details about the object in an external service corresponding to this approval request, such as a ServiceNow change request or a JIRA ticket, if an external approval service is being used"
},
"customWorkflowMetadata": {
"$ref": "#/components/schemas/CustomWorkflowMeta",
"description": "Details about the custom workflow, if this approval request is part of a custom workflow"
},
"appliedByServiceTokenId": {
"type": "string",
"example": "1234a56b7c89d012345e678f",
"description": "The service token ID of the service token which applied the approval request"
}
}
}
ApprovalRequestServiceKind
{
"type": "string"
}
ApprovalSettings
{
"type": "object",
"required": [
"required",
"bypassApprovalsForPendingChanges",
"minNumApprovals",
"canReviewOwnRequest",
"canApplyDeclinedChanges",
"serviceKind",
"serviceConfig",
"requiredApprovalTags"
],
"properties": {
"required": {
"type": "boolean",
"example": true,
"description": "If approvals are required for this environment"
},
"serviceKind": {
"type": "string",
"example": "launchdarkly",
"description": "Which service to use for managing approvals"
},
"serviceConfig": {
"type": "object",
"example": {},
"additionalProperties": {}
},
"minNumApprovals": {
"type": "integer",
"example": 1,
"description": "Sets the amount of approvals required before a member can apply a change. The minimum is one and the maximum is five."
},
"canReviewOwnRequest": {
"type": "boolean",
"example": false,
"description": "Allow someone who makes an approval request to apply their own change"
},
"requiredApprovalTags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"require-approval"
],
"description": "Require approval only on flags with the provided tags. Otherwise all flags will require approval."
},
"canApplyDeclinedChanges": {
"type": "boolean",
"example": true,
"description": "Allow applying the change as long as at least one person has approved"
},
"bypassApprovalsForPendingChanges": {
"type": "boolean",
"example": false,
"description": "Whether to skip approvals for pending changes"
}
}
}
Audience
{
"type": "object",
"required": [
"environment",
"name"
],
"properties": {
"name": {
"type": "string",
"example": "Phase 1 - Testing",
"description": "The release phase name"
},
"environment": {
"$ref": "#/components/schemas/EnvironmentSummary",
"description": "Details about the environment"
}
}
}
AudiencePost
{
"type": "object",
"required": [
"environmentKey",
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The audience name"
},
"environmentKey": {
"type": "string",
"description": "A project-unique key for the environment."
}
}
}
Audiences
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Audience"
}
}
AuditLogEntryListingRep
{
"type": "object",
"required": [
"_links",
"_id",
"_accountId",
"date",
"accesses",
"kind",
"name",
"description",
"shortDescription"
],
"properties": {
"_id": {
"type": "string",
"example": "1234a56b7c89d012345e678f",
"description": "The ID of the audit log entry"
},
"app": {
"$ref": "#/components/schemas/AuthorizedAppDataRep",
"description": "Details of the authorized application that initiated the action described in the audit log entry"
},
"date": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of the audit log entry"
},
"kind": {
"$ref": "#/components/schemas/ResourceKind",
"example": "flag",
"description": "The type of resource this audit log entry refers to"
},
"name": {
"type": "string",
"example": "Example feature flag",
"description": "The name of the resource this audit log entry refers to"
},
"title": {
"type": "string",
"description": "A description of what occurred, in the format <code>member</code> <code>titleVerb</code> <code>target</code>"
},
"token": {
"$ref": "#/components/schemas/TokenSummary",
"description": "Details of the access token that initiated the action described in the audit log entry"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"member": {
"$ref": "#/components/schemas/MemberDataRep",
"description": "Details of the member who initiated the action described in the audit log entry"
},
"parent": {
"$ref": "#/components/schemas/ParentResourceRep"
},
"target": {
"$ref": "#/components/schemas/TargetResourceRep",
"example": "[Ariel Flores](mailto:ariel@acme.com) turned on the flag [example-flag](https://app.launchdarkly.com/example-project/production/features/example-flag) in Production",
"description": "Details of the resource acted upon in this audit log entry"
},
"comment": {
"type": "string",
"example": "This is an automated test",
"description": "Optional comment for the audit log entry"
},
"subject": {
"$ref": "#/components/schemas/SubjectDataRep",
"description": "Details of the subject who initiated the action described in the audit log entry"
},
"accesses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceAccess"
},
"description": "Details on the actions performed and resources acted on in this audit log entry"
},
"titleVerb": {
"type": "string",
"example": "turned on the flag",
"description": "The action and resource recorded in this audit log entry"
},
"_accountId": {
"type": "string",
"example": "1234a56b7c89d012345e678f",
"description": "The ID of the account to which this audit log entry belongs"
},
"description": {
"type": "string",
"example": "Example, turning on the flag for testing",
"description": "Description of the change recorded in the audit log entry"
},
"shortDescription": {
"type": "string",
"example": "Example, turning on the flag",
"description": "Shorter version of the change recorded in the audit log entry"
}
}
}
AuditLogEntryListingRepCollection
{
"type": "object",
"required": [
"items",
"_links"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditLogEntryListingRep"
},
"description": "An array of audit log entries"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
AuditLogEntryRep
{
"type": "object",
"required": [
"_links",
"_id",
"_accountId",
"date",
"accesses",
"kind",
"name",
"description",
"shortDescription"
],
"properties": {
"_id": {
"type": "string",
"example": "1234a56b7c89d012345e678f",
"description": "The ID of the audit log entry"
},
"app": {
"$ref": "#/components/schemas/AuthorizedAppDataRep",
"description": "Details of the authorized application that initiated the action described in the audit log entry"
},
"date": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of the audit log entry"
},
"kind": {
"$ref": "#/components/schemas/ResourceKind",
"example": "flag",
"description": "The type of resource this audit log entry refers to"
},
"name": {
"type": "string",
"example": "Example feature flag",
"description": "The name of the resource this audit log entry refers to"
},
"delta": {
"description": "If the audit log entry has been updated, this is the JSON patch body that was used in the request to update the entity"
},
"merge": {
"description": "A JSON representation of the merge information for this audit log entry, if any"
},
"title": {
"type": "string",
"description": "A description of what occurred, in the format <code>member</code> <code>titleVerb</code> <code>target</code>"
},
"token": {
"$ref": "#/components/schemas/TokenSummary",
"description": "Details of the access token that initiated the action described in the audit log entry"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"member": {
"$ref": "#/components/schemas/MemberDataRep",
"description": "Details of the member who initiated the action described in the audit log entry"
},
"parent": {
"$ref": "#/components/schemas/ParentResourceRep"
},
"target": {
"$ref": "#/components/schemas/TargetResourceRep",
"example": "[Ariel Flores](mailto:ariel@acme.com) turned on the flag [example-flag](https://app.launchdarkly.com/example-project/production/features/example-flag) in Production",
"description": "Details of the resource acted upon in this audit log entry"
},
"comment": {
"type": "string",
"example": "This is an automated test",
"description": "Optional comment for the audit log entry"
},
"subject": {
"$ref": "#/components/schemas/SubjectDataRep",
"description": "Details of the subject who initiated the action described in the audit log entry"
},
"accesses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceAccess"
},
"description": "Details on the actions performed and resources acted on in this audit log entry"
},
"titleVerb": {
"type": "string",
"example": "turned on the flag",
"description": "The action and resource recorded in this audit log entry"
},
"_accountId": {
"type": "string",
"example": "1234a56b7c89d012345e678f",
"description": "The ID of the account to which this audit log entry belongs"
},
"subentries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditLogEntryListingRep"
}
},
"description": {
"type": "string",
"example": "Example, turning on the flag for testing",
"description": "Description of the change recorded in the audit log entry"
},
"triggerBody": {
"description": "A JSON representation of the external trigger for this audit log entry, if any"
},
"currentVersion": {
"description": "If the audit log entry has been updated, this is a JSON representation of the current version of the entity"
},
"previousVersion": {
"description": "If the audit log entry has been updated, this is a JSON representation of the previous version of the entity"
},
"shortDescription": {
"type": "string",
"example": "Example, turning on the flag",
"description": "Shorter version of the change recorded in the audit log entry"
}
}
}
AuthorizedAppDataRep
{
"type": "object",
"properties": {
"_id": {
"type": "string",
"description": "The ID of the authorized application"
},
"name": {
"type": "string",
"description": "The authorized application name"
},
"_links": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"isScim": {
"type": "boolean",
"description": "Whether the application is authorized through SCIM"
},
"maintainerName": {
"type": "string",
"description": "The name of the maintainer for this authorized application"
}
}
}
BigSegmentStoreIntegration
{
"type": "object",
"required": [
"_links",
"_id",
"integrationKey",
"projectKey",
"environmentKey",
"config",
"on",
"tags",
"name",
"version",
"_status"
],
"properties": {
"on": {
"type": "boolean",
"example": true,
"description": "Whether the configuration is turned on"
},
"_id": {
"type": "string",
"example": "12ab3c4d5ef1a2345bcde67f",
"description": "The integration ID"
},
"name": {
"type": "string",
"example": "Development environment configuration",
"description": "Name of the configuration"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [],
"description": "List of tags for this configuration"
},
"_links": {
"$ref": "#/components/schemas/BigSegmentStoreIntegrationLinks",
"description": "The location and content type of related resources"
},
"config": {
"$ref": "#/components/schemas/FormVariableConfig",
"description": "The delivery configuration for the given integration provider. Only included when requesting a single integration by ID. Refer to the <code>formVariables</code> field in the corresponding <code>manifest.json</code> for a full list of fields for each integration."
},
"_access": {
"$ref": "#/components/schemas/Access",
"description": "Details on the allowed and denied actions for this configuration"
},
"_status": {
"$ref": "#/components/schemas/BigSegmentStoreStatus",
"description": "Details on the connection status of the persistent store integration"
},
"version": {
"type": "integer",
"example": 1,
"description": "Version of the current configuration"
},
"projectKey": {
"type": "string",
"example": "default",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"example": "development",
"description": "The environment key"
},
"integrationKey": {
"enum": [
"redis",
"dynamodb"
],
"type": "string",
"example": "redis",
"description": "The integration key"
}
}
}
BigSegmentStoreIntegrationCollection
{
"type": "object",
"required": [
"_links",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BigSegmentStoreIntegration"
},
"description": "An array of persistent store integration configurations"
},
"_links": {
"$ref": "#/components/schemas/BigSegmentStoreIntegrationCollectionLinks",
"description": "The location and content type of related resources"
}
}
}
BigSegmentStoreIntegrationCollectionLinks
{
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"$ref": "#/components/schemas/Link"
},
"parent": {
"$ref": "#/components/schemas/Link"
}
}
}
BigSegmentStoreIntegrationLinks
{
"type": "object",
"required": [
"self",
"parent",
"project",
"environment"
],
"properties": {
"self": {
"$ref": "#/components/schemas/Link"
},
"parent": {
"$ref": "#/components/schemas/Link"
},
"project": {
"$ref": "#/components/schemas/Link"
},
"environment": {
"$ref": "#/components/schemas/Link"
}
}
}
BigSegmentStoreStatus
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StoreIntegrationError"
}
},
"lastSync": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1717263000000",
"description": "Timestamp of when the most recent successful sync occurred between the persistent store integration and the LaunchDarkly environment."
},
"available": {
"type": "boolean",
"example": true,
"description": "Whether the persistent store integration is fully synchronized with the LaunchDarkly environment, and the <code>lastSync</code> occurred within a few minutes"
},
"lastError": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1714584600000",
"description": "Timestamp of when the most recent synchronization error occurred, if any"
},
"potentiallyStale": {
"type": "boolean",
"example": false,
"description": "Whether the persistent store integration may not be fully synchronized with the LaunchDarkly environment. <code>true</code> if the integration could be stale."
}
}
}
BigSegmentTarget
{
"type": "object",
"required": [
"userKey",
"included",
"excluded"
],
"properties": {
"userKey": {
"type": "string",
"description": "The target key"
},
"excluded": {
"type": "boolean",
"description": "Indicates whether the target is excluded.<br />Segment rules bypass excluded targets, so they will never be included based on rules. Excluded targets may still be included explicitly."
},
"included": {
"type": "boolean",
"description": "Indicates whether the target is included.<br />Included targets are always segment members, regardless of segment rules."
}
}
}
BooleanDefaults
{
"type": "object",
"properties": {
"onVariation": {
"type": "integer",
"example": 0,
"description": "The variation index of the flag variation to use for the default targeting behavior when a flag's targeting is on and the target did not match any rules"
},
"offVariation": {
"type": "integer",
"example": 1,
"description": "The variation index of the flag variation to use for the default targeting behavior when a flag's targeting is off"
},
"trueDescription": {
"type": "string",
"example": "serve true",
"description": "The description for the true variation"
},
"trueDisplayName": {
"type": "string",
"example": "True",
"description": "The display name for the true variation, displayed in the LaunchDarkly user interface"
},
"falseDescription": {
"type": "string",
"example": "serve false",
"description": "The description for the false variation"
},
"falseDisplayName": {
"type": "string",
"example": "False",
"description": "The display name for the false variation, displayed in the LaunchDarkly user interface"
}
}
}
BooleanFlagDefaults
{
"type": "object",
"required": [
"trueDisplayName",
"falseDisplayName",
"trueDescription",
"falseDescription",
"onVariation",
"offVariation"
],
"properties": {
"onVariation": {
"type": "integer",
"example": 0,
"description": "The variation index of the flag variation to use for the default targeting behavior when a flag's targeting is on and the target did not match any rules"
},
"offVariation": {
"type": "integer",
"example": 1,
"description": "The variation index of the flag variation to use for the default targeting behavior when a flag's targeting is off"
},
"trueDescription": {
"type": "string",
"example": "serve true",
"description": "The description for the true variation"
},
"trueDisplayName": {
"type": "string",
"example": "True",
"description": "The display name for the true variation, displayed in the LaunchDarkly user interface"
},
"falseDescription": {
"type": "string",
"example": "serve false",
"description": "The description for the false variation"
},
"falseDisplayName": {
"type": "string",
"example": "False",
"description": "The display name for the false variation, displayed in the LaunchDarkly user interface"
}
}
}
BranchCollectionRep
{
"type": "object",
"required": [
"_links",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BranchRep"
},
"description": "An array of branches"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
BranchRep
{
"type": "object",
"required": [
"name",
"head",
"syncTime",
"_links"
],
"properties": {
"head": {
"type": "string",
"example": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3",
"description": "An ID representing the branch HEAD. For example, a commit SHA."
},
"name": {
"type": "string",
"example": "main",
"description": "The branch name"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {}
},
"syncTime": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1636558831870",
"description": "A timestamp indicating when the branch was last synced"
},
"references": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceRep"
},
"description": "An array of flag references found on the branch"
},
"updateSequenceId": {
"type": "integer",
"format": "int64",
"example": 25,
"description": "An optional ID used to prevent older data from overwriting newer data"
}
}
}
BulkEditMembersRep
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"example": [
{
"507f1f77bcf86cd799439011": "you cannot modify your own role"
}
],
"description": "A list of member IDs and errors for the members whose updates failed."
},
"members": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"1234a56b7c89d012345e678f"
],
"description": "A list of members IDs of the members who were successfully updated."
}
}
}
BulkEditTeamsRep
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"example": [
{
"example-team-2": "example failure message"
}
],
"description": "A list of team keys and errors for the teams whose updates failed."
},
"teamKeys": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"example-team-1"
],
"description": "A list of team keys of the teams that were successfully updated."
},
"memberIDs": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"1234a56b7c89d012345e678f"
],
"description": "A list of member IDs of the members who were added to the teams."
}
}
}
Clause
{
"type": "object",
"required": [
"attribute",
"op",
"values",
"negate"
],
"properties": {
"op": {
"$ref": "#/components/schemas/Operator"
},
"_id": {
"type": "string"
},
"negate": {
"type": "boolean"
},
"values": {
"type": "array",
"items": {}
},
"attribute": {
"type": "string"
},
"contextKind": {
"type": "string"
}
}
}
Client
{
"type": "object",
"required": [
"_links",
"name",
"_accountId",
"_clientId",
"redirectUri",
"_creationDate"
],
"properties": {
"name": {
"type": "string",
"description": "Client name"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/oauth/clients/50666563-9144-4125-b822-33f308227e45",
"type": "application/json"
},
"parent": {
"href": "/api/v2/oauth/clients",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"_clientId": {
"type": "string",
"description": "The client's unique ID"
},
"_accountId": {
"type": "string",
"description": "The account ID the client is registered under"
},
"description": {
"type": "string",
"description": "Client description"
},
"redirectUri": {
"type": "string",
"description": "The client's redirect URI"
},
"_clientSecret": {
"type": "string",
"description": "The client secret. This will only be shown upon creation."
},
"_creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1494437420312",
"description": "Timestamp of client creation date"
}
}
}
ClientCollection
{
"type": "object",
"required": [
"_links",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Client"
},
"description": "List of client objects"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/oauth/clients",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
ClientSideAvailability
{
"type": "object",
"properties": {
"usingMobileKey": {
"type": "boolean"
},
"usingEnvironmentId": {
"type": "boolean"
}
}
}
ClientSideAvailabilityPost
{
"type": "object",
"required": [
"usingEnvironmentId",
"usingMobileKey"
],
"properties": {
"usingMobileKey": {
"type": "boolean",
"example": true,
"description": "Whether to enable availability for mobile SDKs. Defaults to <code>true</code>."
},
"usingEnvironmentId": {
"type": "boolean",
"example": true,
"description": "Whether to enable availability for client-side SDKs. Defaults to <code>false</code>."
}
}
}
CodeReferencesAsynchronouslyDeleteBranchesRequest
{
"type": "array",
"items": {
"type": "string"
}
}
CompletedBy
{
"type": "object",
"properties": {
"token": {
"$ref": "#/components/schemas/TokenSummary",
"description": "The service token used to mark this phase as complete"
},
"member": {
"$ref": "#/components/schemas/MemberSummary",
"description": "The LaunchDarkly member who marked this phase as complete"
}
}
}
ConditionInput
{
"type": "object",
"properties": {
"kind": {
"$ref": "#/components/schemas/ConditionKind",
"example": "schedule",
"description": "The type of condition to meet before executing this stage of the workflow. Use <code>schedule</code> to schedule a workflow stage. Use <code>ld-approval</code> to add an approval request to a workflow stage."
},
"executeNow": {
"type": "boolean",
"example": false,
"description": "Whether the workflow stage should be executed immediately"
},
"description": {
"type": "string",
"example": "Require example-team approval for final stage",
"description": "A description of the approval required for this stage"
},
"scheduleKind": {
"$ref": "#/components/schemas/ScheduleKind",
"enum": [
"absolute",
"relative"
],
"example": "relative",
"description": "Whether the scheduled execution of the workflow stage is relative or absolute. If relative, the <code>waitDuration</code> and <code>waitDurationUnit</code> specify when the execution occurs. If absolute, the <code>executionDate</code> specifies when the execution occurs."
},
"waitDuration": {
"type": "integer",
"example": 2,
"description": "For workflow stages whose scheduled execution is relative, how far in the future the stage should start."
},
"executionDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1706810400000",
"description": "For workflow stages whose scheduled execution is absolute, the time, in Unix milliseconds, when the stage should start."
},
"notifyTeamKeys": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"example-team"
],
"description": "A list of team keys for the teams to request approval from for this stage"
},
"notifyMemberIds": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"507f1f77bcf86cd799439011"
],
"description": "A list of member IDs for the members to request approval from for this stage"
},
"waitDurationUnit": {
"$ref": "#/components/schemas/DurationUnit",
"enum": [
"minute",
"hour",
"calendarDay",
"calendarWeek"
],
"example": "calendarDay",
"description": "For workflow stages whose scheduled execution is relative, the unit of measure for the <code>waitDuration</code>."
}
}
}
ConditionKind
{
"type": "string"
}
ConditionOutput
{
"type": "object",
"required": [
"_id",
"_execution",
"description",
"notifyMemberIds",
"allReviews",
"reviewStatus"
],
"properties": {
"_id": {
"type": "string"
},
"kind": {
"type": "string"
},
"_execution": {
"$ref": "#/components/schemas/ExecutionOutput"
},
"allReviews": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReviewOutput"
}
},
"appliedDate": {
"$ref": "#/components/schemas/UnixMillis"
},
"description": {
"type": "string"
},
"reviewStatus": {
"type": "string"
},
"scheduleKind": {
"$ref": "#/components/schemas/ScheduleKind"
},
"waitDuration": {
"type": "integer"
},
"executionDate": {
"$ref": "#/components/schemas/UnixMillis"
},
"notifyMemberIds": {
"type": "array",
"items": {
"type": "string"
}
},
"waitDurationUnit": {
"$ref": "#/components/schemas/DurationUnit"
}
}
}
ConfidenceIntervalRep
{
"type": "object",
"properties": {
"lower": {
"type": "number"
},
"upper": {
"type": "number"
}
}
}
Conflict
{
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "Reason why the conflict exists"
},
"instruction": {
"$ref": "#/components/schemas/Instruction",
"description": "Instruction in semantic patch format to be applied to the feature flag"
}
}
}
ConflictOutput
{
"type": "object",
"required": [
"stageId",
"message"
],
"properties": {
"message": {
"type": "string",
"description": "Message about the conflict"
},
"stageId": {
"type": "string",
"example": "12ab3c4d5ef1a2345bcde67f",
"description": "The stage ID"
}
}
}
ContextAttributeName
{
"type": "object",
"required": [
"name",
"weight"
],
"properties": {
"name": {
"type": "string",
"example": "/firstName",
"description": "A context attribute's name."
},
"weight": {
"type": "integer",
"example": 2225,
"description": "A relative estimate of the number of contexts seen recently that have an attribute with the associated name."
},
"redacted": {
"type": "boolean",
"example": false,
"description": "Whether or not the attribute has one or more redacted values."
}
}
}
ContextAttributeNames
{
"type": "object",
"required": [
"kind",
"names"
],
"properties": {
"kind": {
"type": "string",
"example": "user",
"description": "The kind associated with this collection of context attribute names."
},
"names": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContextAttributeName"
},
"description": "A collection of context attribute names."
}
}
}
ContextAttributeNamesCollection
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContextAttributeNames"
},
"description": "A collection of context attribute name data grouped by kind."
}
}
}
ContextAttributeValue
{
"type": "object",
"required": [
"name",
"weight"
],
"properties": {
"name": {
"example": "Sandy",
"description": "A value for a context attribute."
},
"weight": {
"type": "integer",
"example": 35,
"description": "A relative estimate of the number of contexts seen recently that have a matching value for a given attribute."
}
}
}
ContextAttributeValues
{
"type": "object",
"required": [
"kind",
"values"
],
"properties": {
"kind": {
"type": "string",
"example": "user",
"description": "The kind associated with this collection of context attribute values."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContextAttributeValue"
},
"description": "A collection of context attribute values."
}
}
}
ContextAttributeValuesCollection
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContextAttributeValues"
},
"description": "A collection of context attribute value data grouped by kind."
}
}
}
ContextInstance
{
"type": "object",
"additionalProperties": {}
}
ContextInstanceEvaluation
{
"type": "object",
"required": [
"name",
"key",
"_value",
"_links"
],
"properties": {
"key": {
"type": "string",
"example": "flag-key-123abc",
"description": "Key of the flag."
},
"name": {
"type": "string",
"example": "My Flag",
"description": "Name of the flag."
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/projects/{projectKey}/environments/{environmentKey}/flags/evaluate",
"type": "application/json"
},
"site": {
"href": "/my-project/my-environment/features/sort.order/targeting",
"type": "text/html"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"_value": {
"example": "true",
"description": "The value of the flag variation that the context receives. If there is no defined default rule, this is null."
},
"reason": {
"$ref": "#/components/schemas/ContextInstanceEvaluationReason",
"example": "{\"kind\": \"RULE_MATCH\"}",
"description": "Contains information about why that variation was selected."
}
}
}
ContextInstanceEvaluationReason
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"example": "OFF",
"description": "Describes the general reason that LaunchDarkly selected this variation."
},
"ruleID": {
"type": "string",
"example": "1234567890",
"description": "The unique identifier of the matching rule if the kind is 'RULE_MATCH'."
},
"errorKind": {
"type": "string",
"example": "tried to use uninitialized Context",
"description": "The specific error type if the kind is 'ERROR'."
},
"ruleIndex": {
"type": "integer",
"example": 3,
"description": "The positional index of the matching rule if the kind is 'RULE_MATCH'. The index is 0-based."
},
"inExperiment": {
"type": "boolean",
"example": true,
"description": "Indicates whether the context was evaluated as part of an experiment."
},
"prerequisiteKey": {
"type": "string",
"example": "someotherflagkey",
"description": "The key of the flag that failed if the kind is 'PREREQUISITE_FAILED'."
}
}
}
ContextInstanceEvaluations
{
"type": "object",
"required": [
"items",
"_links"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContextInstanceEvaluation"
},
"example": [
{
"key": "sort.order",
"name": "SortOrder",
"_links": {
"self": {
"href": "/api/v2/projects/{projectKey}/environments/{environmentKey}/flags/evaluate",
"type": "application/json"
},
"site": {
"href": "/my-project/my-environment/features/sort.order/targeting",
"type": "text/html"
}
},
"_value": true,
"reason": {
"kind": "FALLTHROUGH"
}
},
{
"key": "alternate.page",
"name": "AlternatePage",
"_links": {
"self": {
"href": "/api/v2/projects/{projectKey}/environments/{environmentKey}/flags/evaluate",
"type": "application/json"
},
"site": {
"href": "/my-project/my-environment/features/alternate.page/targeting",
"type": "text/html"
}
},
"_value": false,
"reason": {
"kind": "RULE_MATCH",
"ruleID": "b2530cdf-14c6-4e16-b660-00239e08f19b",
"ruleIndex": 1
}
}
],
"description": "Details on the flag evaluations for this context instance"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/projects/{projectKey}/environments/{environmentKey}/flags/evaluate",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"example": 2,
"description": "The number of flags"
}
}
}
ContextInstanceRecord
{
"type": "object",
"required": [
"id",
"context"
],
"properties": {
"id": {
"type": "string",
"example": "b3JnOmxhdW5jaGRhcmtseQ",
"description": "The context instance ID"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/projects/my-project/environments/my-env/context-instances/organization:launch-darkly:user:henry?filter=applicationId:\"GoSDK/1.2\"",
"type": "application/json"
},
"site": {
"href": "/my-project/my-environment/context-instances/organization:launch-darkly:user:henry",
"type": "text/html"
},
"parent": {
"href": "/api/v2/projects/my-project/environments/my-environment",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"_access": {
"$ref": "#/components/schemas/Access",
"description": "Details on the allowed and denied actions for this context instance"
},
"context": {
"example": "{\"kind\": \"user\", \"key\": \"context-key-123abc\", \"name\": \"Sandy Smith\", \"email\": \"sandy@example.com\"}",
"description": "The context, including its kind and attributes"
},
"lastSeen": {
"type": "string",
"format": "date-time",
"example": "2022-04-15T15:00:57.526470334Z",
"description": "Timestamp of the last time an evaluation occurred for this context instance"
},
"applicationId": {
"type": "string",
"example": "GoSDK/1.2",
"description": "An identifier representing the application where the LaunchDarkly SDK is running"
},
"anonymousKinds": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"device",
"privateKind"
],
"description": "A list of the context kinds this context was associated with that the SDK removed because they were marked as anonymous at flag evaluation"
}
}
}
ContextInstanceSearch
{
"type": "object",
"properties": {
"sort": {
"type": "string",
"example": "-ts",
"description": "Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying <code>ts</code> for this value, or descending order by specifying <code>-ts</code>."
},
"limit": {
"type": "integer",
"example": 10,
"description": "Specifies the maximum number of items in the collection to return (max: 50, default: 20)"
},
"filter": {
"type": "string",
"example": "{\"filter\": \"kindKeys:{\"contains\": [\"user:Henry\"]},\"sort\": \"-ts\",\"limit\": 50}",
"description": "A collection of context instance filters"
},
"continuationToken": {
"type": "string",
"example": "QAGFKH1313KUGI2351",
"description": "Limits results to context instances with sort values after the value specified. You can use this for pagination, however, we recommend using the <code>next</code> link instead, because this value is an obfuscated string."
}
}
}
ContextInstanceSegmentMembership
{
"type": "object",
"required": [
"name",
"key",
"description",
"unbounded",
"external",
"isMember",
"isIndividuallyTargeted",
"isRuleTargeted",
"_links"
],
"properties": {
"key": {
"type": "string",
"example": "segment-key-123abc",
"description": "A unique key used to reference the segment"
},
"name": {
"type": "string",
"example": "Segment Name",
"description": "A human-friendly name for the segment"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"external": {
"type": "string",
"example": "https://amplitude.com/myCohort",
"description": "If the segment is a synced segment, the name of the external source"
},
"isMember": {
"type": "boolean",
"example": true,
"description": "Whether the context is a member of this segment, either by explicit inclusion or by rule matching"
},
"unbounded": {
"type": "boolean",
"example": false,
"description": "Whether this is an unbounded segment. Unbounded segments, also called big segments, may be list-based segments with more than 15,000 entries, or synced segments."
},
"description": {
"type": "string",
"example": "Segment description",
"description": "A description of the segment's purpose"
},
"isRuleTargeted": {
"type": "boolean",
"example": false,
"description": "Whether the context is captured by this segment's rules. The value of this field is undefined if the context is also explicitly included (<code>isIndividuallyTargeted</code> is <code>true</code>)."
},
"isIndividuallyTargeted": {
"type": "boolean",
"example": true,
"description": "Whether the context is explicitly included in this segment"
}
}
}
ContextInstanceSegmentMemberships
{
"type": "object",
"required": [
"items",
"_links"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContextInstanceSegmentMembership"
}
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
ContextInstances
{
"type": "object",
"required": [
"_environmentId",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContextInstanceRecord"
},
"description": "A collection of context instances. Can include multiple versions of context instances that have the same <code>id</code>, but different <code>applicationId</code>s."
},
"_links": {
"type": "object",
"example": {
"next": {
"href": "/api/v2/projects/my-project/environments/my-env/context-instances/organization:launch-darkly:user:henry?limit=2&continuationToken=2022-04-15T15:00:57.526470334Z",
"type": "application/json"
},
"self": {
"href": "/api/v2/projects/my-proj/environments/my-env/context-instances/organization:launch-darkly:user:henry-jacobs?limit=2",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"example": 100,
"description": "The number of unique context instances"
},
"_environmentId": {
"type": "string",
"example": "57be1db38b75bf0772d11384",
"description": "The environment ID"
},
"continuationToken": {
"type": "string",
"example": "QAGFKH1313KUGI2351",
"description": "An obfuscated string that references the last context instance on the previous page of results. You can use this for pagination, however, we recommend using the <code>next</code> link instead."
}
}
}
ContextKindCreatedFrom
{
"type": "string"
}
ContextKindRep
{
"type": "object",
"required": [
"key",
"name",
"description",
"version",
"creationDate",
"lastModified",
"createdFrom"
],
"properties": {
"key": {
"type": "string",
"example": "organization-key-123abc",
"description": "The context kind key"
},
"name": {
"type": "string",
"example": "Organization",
"description": "The context kind name"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"version": {
"type": "integer",
"example": 4,
"description": "The context kind version"
},
"archived": {
"type": "boolean",
"example": false,
"description": "Whether the context kind is archived. Archived context kinds are unavailable for targeting."
},
"lastSeen": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1671563538193",
"description": "Timestamp of when a context of this context kind was most recently evaluated"
},
"createdFrom": {
"$ref": "#/components/schemas/ContextKindCreatedFrom",
"enum": [
"default",
"auto-add",
"manual"
],
"example": "auto-add",
"description": "How the context kind was created"
},
"description": {
"type": "string",
"example": "An example context kind, to enable targeting based on organization",
"description": "The context kind description"
},
"creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1668530155141",
"description": "Timestamp of when the context kind was created"
},
"lastModified": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1670341705251",
"description": "Timestamp of when the context kind was most recently changed"
},
"hideInTargeting": {
"type": "boolean",
"example": false,
"description": "Alias for archived."
}
}
}
ContextKindsCollectionRep
{
"type": "object",
"required": [
"items",
"_links"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContextKindRep"
},
"description": "An array of context kinds"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
ContextRecord
{
"type": "object",
"required": [
"context"
],
"properties": {
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/projects/my-project/environments/my-env/contexts/organization:launch-darkly:user:henry?filter=applicationId:\"GoSDK/1.2\"",
"type": "application/json"
},
"site": {
"href": "/my-project/my-environment/context/organization:launch-darkly:user:henry",
"type": "text/html"
},
"parent": {
"href": "/api/v2/projects/my-project/environments/my-environment",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"_access": {
"$ref": "#/components/schemas/Access",
"description": "Details on the allowed and denied actions for this context instance"
},
"context": {
"example": "{\"kind\": \"user\", \"key\": \"context-key-123abc\", \"name\": \"Sandy Smith\", \"email\": \"sandy@example.com\"}",
"description": "The context, including its kind and attributes"
},
"lastSeen": {
"type": "string",
"format": "date-time",
"example": "2022-04-15T15:00:57.526470334Z",
"description": "Timestamp of the last time an evaluation occurred for this context"
},
"applicationId": {
"type": "string",
"example": "GoSDK/1.2",
"description": "An identifier representing the application where the LaunchDarkly SDK is running"
},
"associatedContexts": {
"type": "integer",
"example": 0,
"description": "The total number of associated contexts. Associated contexts are contexts that have appeared in the same context instance, that is, they were part of the same flag evaluation."
}
}
}
ContextSearch
{
"type": "object",
"properties": {
"sort": {
"type": "string",
"example": "-ts",
"description": "Specifies a field by which to sort. LaunchDarkly supports sorting by timestamp in ascending order by specifying <code>ts</code> for this value, or descending order by specifying <code>-ts</code>."
},
"limit": {
"type": "integer",
"example": 10,
"description": "Specifies the maximum number of items in the collection to return (max: 50, default: 20)"
},
"filter": {
"type": "string",
"example": "*.name startsWith Jo,kind anyOf [\"user\",\"organization\"]",
"description": "A collection of context filters"
},
"continuationToken": {
"type": "string",
"example": "QAGFKH1313KUGI2351",
"description": "Limits results to contexts with sort values after the value specified. You can use this for pagination, however, we recommend using the <code>next</code> link instead, because this value is an obfuscated string."
}
}
}
Contexts
{
"type": "object",
"required": [
"_environmentId",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContextRecord"
},
"description": "A collection of contexts. Can include multiple versions of contexts that have the same <code>kind</code> and <code>key</code>, but different <code>applicationId</code>s."
},
"_links": {
"type": "object",
"example": {
"next": {
"href": "/app.launchdarkly.com/api/v2/projects/my-project/environments/my-environment/contexts?filter=kind:{\"equals\": [\"organization\"]}&limit=2&continuationToken=QAGFKH1313KUGI2351",
"type": "application/json"
},
"self": {
"href": "/api/v2/projects/my-proj/environments/my-env/contexts?filter=kind:{\"equals\": [\"organization\"]}&limit=2&continuationToken=QAGFKH1313KUGI2351",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"example": 100,
"description": "The number of contexts"
},
"_environmentId": {
"type": "string",
"example": "57be1db38b75bf0772d11384",
"description": "The environment ID where the context was evaluated"
},
"continuationToken": {
"type": "string",
"example": "QAGFKH1313KUGI2351",
"description": "An obfuscated string that references the last context instance on the previous page of results. You can use this for pagination, however, we recommend using the <code>next</code> link instead."
}
}
}
CopiedFromEnv
{
"type": "object",
"required": [
"key"
],
"properties": {
"key": {
"type": "string",
"example": "source-flag-key-123abc",
"description": "Key of feature flag copied"
},
"version": {
"type": "integer",
"example": 1,
"description": "Version of feature flag copied"
}
}
}
CreatePhaseInput
{
"type": "object",
"required": [
"audiences",
"name"
],
"properties": {
"name": {
"type": "string",
"example": "Phase 1 - Testing",
"description": "The release phase name"
},
"audiences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudiencePost"
},
"description": "An ordered list of the audiences for this release phase. Each audience corresponds to a LaunchDarkly environment."
}
}
}
CreateReleasePipelineInput
{
"type": "object",
"required": [
"key",
"name",
"phases"
],
"properties": {
"key": {
"type": "string",
"example": "standard-pipeline",
"description": "The unique identifier of this release pipeline"
},
"name": {
"type": "string",
"example": "Standard Pipeline",
"description": "The name of the release pipeline"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"example-tag"
],
"description": "A list of tags for this release pipeline"
},
"phases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreatePhaseInput"
},
"description": "A logical grouping of one or more environments that share attributes for rolling out changes"
},
"description": {
"type": "string",
"example": "Standard pipeline to roll out to production",
"description": "The release pipeline description"
}
}
}
CreateWorkflowTemplateInput
{
"type": "object",
"required": [
"key"
],
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"stages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StageInput"
}
},
"flagKey": {
"type": "string"
},
"projectKey": {
"type": "string"
},
"workflowId": {
"$ref": "#/components/schemas/FeatureWorkflowId"
},
"description": {
"type": "string"
},
"environmentKey": {
"type": "string"
}
}
}
CredibleIntervalRep
{
"type": "object",
"properties": {
"lower": {
"type": "number",
"example": 0.4060771673663068,
"description": "The lower bound"
},
"upper": {
"type": "number",
"example": 0.6713222134386467,
"description": "The upper bound"
}
}
}
CustomProperties
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/customProperty"
}
}
CustomRole
{
"type": "object",
"required": [
"_id",
"_links",
"key",
"name",
"policy"
],
"properties": {
"_id": {
"type": "string",
"example": "1234a56b7c89d012345e678f",
"description": "The ID of the custom role"
},
"key": {
"type": "string",
"example": "example-custom-role",
"description": "The key of the custom role"
},
"name": {
"type": "string",
"example": "Example custom role",
"description": "The name of the custom role"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"policy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Statement"
},
"description": "An array of the policies that comprise this custom role"
},
"_access": {
"$ref": "#/components/schemas/Access",
"description": "Details on the allowed and denied actions for this custom role"
},
"description": {
"type": "string",
"example": "This custom role is just an example",
"description": "The description of the custom role"
},
"basePermissions": {
"$ref": "#/components/schemas/RoleType",
"example": "reader",
"description": "Base permissions to use for this role"
}
}
}
CustomRolePost
{
"type": "object",
"required": [
"name",
"key",
"policy"
],
"properties": {
"key": {
"type": "string",
"example": "role-key-123abc",
"description": "The custom role key"
},
"name": {
"type": "string",
"example": "Ops team",
"description": "A human-friendly name for the custom role"
},
"policy": {
"$ref": "#/components/schemas/StatementPostList",
"description": "Resource statements for custom role"
},
"description": {
"type": "string",
"example": "An example role for members of the ops team",
"description": "Description of custom role"
},
"basePermissions": {
"$ref": "#/components/schemas/RoleType",
"enum": [
"reader",
"no_access"
],
"example": "reader",
"description": "Base permissions to use for this role."
}
}
}
CustomRoles
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomRole"
},
"description": "An array of custom roles"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
CustomWorkflowInput
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "Progressive rollout starting in two days",
"description": "The workflow name"
},
"stages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StageInput"
},
"description": "A list of the workflow stages"
},
"description": {
"type": "string",
"example": "Turn flag on for 10% of users each day",
"description": "The workflow description"
},
"templateKey": {
"type": "string",
"description": "The template key"
},
"maintainerId": {
"$ref": "#/components/schemas/ObjectId",
"example": "12ab3c45de678910abc12345",
"description": "The ID of the workflow maintainer. Defaults to the workflow creator."
}
}
}
CustomWorkflowMeta
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Example workflow name",
"description": "The name of the workflow stage that required this approval request"
},
"stage": {
"$ref": "#/components/schemas/CustomWorkflowStageMeta",
"description": "Details on the stage of the workflow where this approval request is required"
}
}
}
CustomWorkflowOutput
{
"type": "object",
"required": [
"_id",
"_version",
"_conflicts",
"_creationDate",
"_maintainerId",
"_links",
"name",
"_execution"
],
"properties": {
"_id": {
"type": "string",
"example": "12ab3c4d5ef1a2345bcde67f",
"description": "The ID of the workflow"
},
"kind": {
"type": "string",
"example": "custom",
"description": "The kind of workflow"
},
"meta": {
"$ref": "#/components/schemas/WorkflowTemplateMetadata",
"description": "For workflows being created from a workflow template, this value holds any parameters that could potentially be incompatible with the current project, environment, or flag"
},
"name": {
"type": "string",
"example": "Progressive rollout starting in two days",
"description": "The name of the workflow"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"stages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StageOutput"
},
"description": "The stages that make up the workflow. Each stage contains conditions and actions."
},
"_version": {
"type": "integer",
"example": 1,
"description": "The version of the workflow"
},
"_conflicts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConflictOutput"
},
"description": "Any conflicts that are present in the workflow stages"
},
"_execution": {
"$ref": "#/components/schemas/ExecutionOutput",
"example": "{\"status\": \"completed\"}",
"description": "The current execution status of the workflow"
},
"description": {
"type": "string",
"example": "Turn flag on for 10% of customers each day",
"description": "A brief description of the workflow"
},
"templateKey": {
"type": "string",
"example": "example-workflow-template",
"description": "For workflows being created from a workflow template, this value is the template's key"
},
"_creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when the workflow was created"
},
"_maintainerId": {
"type": "string",
"example": "12ab3c45de678910abc12345",
"description": "The member ID of the maintainer of the workflow. Defaults to the workflow creator."
}
}
}
CustomWorkflowStageMeta
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Stage 1",
"description": "The name of the workflow stage"
},
"index": {
"type": "integer",
"example": 0,
"description": "The zero-based index of the workflow stage"
}
}
}
CustomWorkflowsListingOutput
{
"type": "object",
"required": [
"items",
"totalCount",
"_links"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomWorkflowOutput"
},
"description": "An array of workflows"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"example": 1,
"description": "Total number of workflows"
}
}
}
DateVersion
{
"type": "integer"
}
DefaultClientSideAvailability
{
"type": "object",
"required": [
"usingMobileKey",
"usingEnvironmentId"
],
"properties": {
"usingMobileKey": {
"type": "boolean",
"example": true,
"description": "Whether to enable availability for mobile SDKs"
},
"usingEnvironmentId": {
"type": "boolean",
"example": true,
"description": "Whether to enable availability for client-side SDKs"
}
}
}
DefaultClientSideAvailabilityPost
{
"type": "object",
"required": [
"usingEnvironmentId",
"usingMobileKey"
],
"properties": {
"usingMobileKey": {
"type": "boolean",
"example": true,
"description": "Whether to enable availability for mobile SDKs."
},
"usingEnvironmentId": {
"type": "boolean",
"example": true,
"description": "Whether to enable availability for client-side SDKs."
}
}
}
Defaults
{
"type": "object",
"required": [
"onVariation",
"offVariation"
],
"properties": {
"onVariation": {
"type": "integer",
"example": 0,
"description": "The index, from the array of variations for this flag, of the variation to serve by default when targeting is on."
},
"offVariation": {
"type": "integer",
"example": 1,
"description": "The index, from the array of variations for this flag, of the variation to serve by default when targeting is off."
}
}
}
DependentExperimentListRep
{
"type": "array",
"items": {
"$ref": "#/components/schemas/DependentExperimentRep"
}
}
DependentExperimentRep
{
"type": "object",
"required": [
"key",
"name",
"environmentId",
"environmentKey",
"creationDate",
"_links"
],
"properties": {
"key": {
"type": "string",
"example": "experiment-key-123abc",
"description": "The experiment key"
},
"name": {
"type": "string",
"example": "Example experiment",
"description": "The experiment name"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/projects/my-project/environments/my-environment/experiments/example-experiment",
"type": "application/json"
},
"parent": {
"href": "/api/v2/projects/my-project/environments/my-environment",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"archivedDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when the experiment was archived"
},
"creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when the experiment was created"
},
"environmentId": {
"type": "string",
"example": "1234a56b7c89d012345e678f",
"description": "The environment ID"
},
"environmentKey": {
"type": "string",
"example": "production",
"description": "The environment key"
}
}
}
DependentFlag
{
"type": "object",
"required": [
"key",
"_links",
"_site"
],
"properties": {
"key": {
"type": "string",
"example": "dependent-flag-key-123abc",
"description": "The flag key"
},
"name": {
"type": "string",
"example": "Example dependent flag",
"description": "The flag name"
},
"_site": {
"$ref": "#/components/schemas/Link",
"example": "{ \"href\": \"/example-project/example-environment/features/example-dependent-flag\", \"type\": \"text/html\" }",
"description": "Details on how to access the dependent flag in the LaunchDarkly UI"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
DependentFlagEnvironment
{
"type": "object",
"required": [
"key",
"_links",
"_site"
],
"properties": {
"key": {
"type": "string",
"example": "environment-key-123abc",
"description": "The environment key"
},
"name": {
"type": "string",
"example": "Example environment",
"description": "The environment name"
},
"_site": {
"$ref": "#/components/schemas/Link",
"example": "{ \"href\": \"/example-project/example-environment/features/example-dependent-flag\", \"type\": \"text/html\" }",
"description": "Details on how to access the dependent flag in this environment in the LaunchDarkly UI"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
DependentFlagsByEnvironment
{
"type": "object",
"required": [
"items",
"_links",
"_site"
],
"properties": {
"_site": {
"$ref": "#/components/schemas/Link",
"example": "{ \"href\": \"/example-project/~/features/example-prereq-flag\", \"type\": \"text/html\" }",
"description": "Details on how to access the prerequisite flag in the LaunchDarkly UI"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DependentFlag"
},
"description": "A list of dependent flags, which are flags that use the requested flag as a prerequisite"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
DependentMetricGroupRep
{
"type": "object",
"required": [
"key",
"name",
"kind",
"_links"
],
"properties": {
"key": {
"type": "string",
"example": "metric-group-key-123abc",
"description": "A unique key to reference the metric group"
},
"kind": {
"enum": [
"funnel"
],
"type": "string",
"example": "funnel",
"description": "The type of the metric group"
},
"name": {
"type": "string",
"example": "My metric group",
"description": "A human-friendly name for the metric group"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
"type": "application/json"
},
"parent": {
"href": "/api/v2/projects/my-project",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
DependentMetricGroupRepWithMetrics
{
"type": "object",
"required": [
"key",
"name",
"kind",
"_links"
],
"properties": {
"key": {
"type": "string",
"example": "metric-group-key-123abc",
"description": "A unique key to reference the metric group"
},
"kind": {
"enum": [
"funnel"
],
"type": "string",
"example": "funnel",
"description": "The type of the metric group"
},
"name": {
"type": "string",
"example": "My metric group",
"description": "A human-friendly name for the metric group"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
"type": "application/json"
},
"parent": {
"href": "/api/v2/projects/my-project",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricInGroupRep"
},
"description": "The metrics in the metric group"
}
}
}
DependentMetricOrMetricGroupRep
{
"type": "object",
"required": [
"key",
"_versionId",
"name",
"kind",
"_links",
"isGroup"
],
"properties": {
"key": {
"type": "string",
"example": "metric-key-123abc",
"description": "A unique key to reference the metric or metric group"
},
"kind": {
"enum": [
"pageview",
"click",
"custom",
"funnel",
"standard"
],
"type": "string",
"example": "custom",
"description": "If this is a metric, then it represents the kind of event the metric tracks. If this is a metric group, then it represents the group type"
},
"name": {
"type": "string",
"example": "My metric",
"description": "A human-friendly name for the metric or metric group"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/metrics/my-project/my-metric",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"isGroup": {
"type": "boolean",
"description": "Whether this is a metric group or a metric"
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricInGroupRep"
},
"description": "An ordered list of the metrics in this metric group"
},
"isNumeric": {
"type": "boolean",
"example": true,
"description": "For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>)."
},
"_versionId": {
"type": "string",
"description": "The version ID of the metric or metric group"
}
}
}
DeploymentCollectionRep
{
"type": "object",
"required": [
"totalCount",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeploymentRep"
},
"description": "A list of deployments"
},
"_links": {
"type": "object",
"example": {
"next": {
"href": "/api/v2/engineering-insights/deployments?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5",
"type": "application/json"
},
"self": {
"href": "/api/v2/engineering-insights/deployments",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"example": 25,
"description": "The total number of deployments"
}
}
}
DeploymentKind
{
"type": "string"
}
DeploymentRep
{
"type": "object",
"required": [
"id",
"applicationKey",
"applicationVersion",
"startedAt",
"status",
"kind",
"active",
"archived",
"environmentKey",
"numberOfContributors",
"numberOfPullRequests",
"linesAdded",
"linesDeleted",
"leadTime"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
"description": "The deployment ID"
},
"kind": {
"$ref": "#/components/schemas/DeploymentKind",
"example": "redeployment",
"description": "The kind of deployment"
},
"active": {
"type": "boolean",
"example": true,
"description": "Whether the deployment is active"
},
"status": {
"$ref": "#/components/schemas/DeploymentStatus",
"example": "finished",
"description": "The status of the deployment"
},
"endedAt": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1706712518000",
"description": "The time the deployment ended"
},
"archived": {
"type": "boolean",
"example": false,
"description": "Whether the deployment is archived"
},
"leadTime": {
"type": "integer",
"format": "int64",
"example": 20237000,
"description": "The total lead time from first commit to deployment end in milliseconds"
},
"metadata": {
"type": "object",
"example": {
"buildNumber": "1234"
},
"description": "The metadata associated with the deployment",
"additionalProperties": {}
},
"startedAt": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1706701522000",
"description": "The time the deployment started"
},
"durationMs": {
"type": "integer",
"format": "int64",
"example": 10996000,
"description": "The duration of the deployment in milliseconds"
},
"linesAdded": {
"type": "integer",
"format": "int64",
"example": 100,
"description": "The number of lines added"
},
"linesDeleted": {
"type": "integer",
"format": "int64",
"example": 50,
"description": "The number of lines deleted"
},
"pullRequests": {
"$ref": "#/components/schemas/PullRequestCollectionRep",
"description": "The pull requests contained in the deployment"
},
"applicationKey": {
"type": "string",
"example": "billing-service",
"description": "The application key"
},
"environmentKey": {
"type": "string",
"example": "production",
"description": "The environment key"
},
"flagReferences": {
"$ref": "#/components/schemas/FlagReferenceCollectionRep",
"description": "The flag references contained in the deployment"
},
"leadTimeStages": {
"$ref": "#/components/schemas/LeadTimeStagesRep",
"description": "The lead time stages for the deployment"
},
"applicationVersion": {
"type": "string",
"example": "a90a8a2",
"description": "The application version"
},
"numberOfContributors": {
"type": "integer",
"example": 1,
"description": "The number of contributors"
},
"numberOfPullRequests": {
"type": "integer",
"example": 2,
"description": "The number of pull requests"
}
}
}
DeploymentStatus
{
"type": "string"
}
Destination
{
"type": "object",
"properties": {
"on": {
"type": "boolean",
"example": true,
"description": "Whether the export is on, that is, the status of the integration"
},
"_id": {
"type": "string",
"example": "610addeadbeefaa86ec9a7d4",
"description": "The ID of this Data Export destination"
},
"kind": {
"enum": [
"google-pubsub",
"kinesis",
"mparticle",
"segment",
"azure-event-hubs"
],
"type": "string",
"example": "google-pubsub",
"description": "The type of Data Export destination"
},
"name": {
"type": "string",
"example": "example-destination",
"description": "A human-readable name for your Data Export destination"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/destinations/my-project/my-environment/610addeadbeefaa86ec9a7d4",
"type": "application/json"
},
"parent": {
"href": "/api/v2/destinations",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"config": {
"example": "{\"project\":\"test-prod\",\"topic\":\"ld-pubsub-test-192301\"}",
"description": "An object with the configuration parameters required for the destination type"
},
"_access": {
"$ref": "#/components/schemas/Access",
"description": "Details on the allowed and denied actions for this Data Export destination"
},
"version": {
"type": "number",
"example": 1
}
}
}
DestinationPost
{
"type": "object",
"properties": {
"on": {
"type": "boolean",
"example": true,
"description": "Whether the export is on. Displayed as the integration status in the LaunchDarkly UI."
},
"kind": {
"enum": [
"google-pubsub",
"kinesis",
"mparticle",
"segment",
"azure-event-hubs"
],
"type": "string",
"example": "google-pubsub",
"description": "The type of Data Export destination"
},
"name": {
"type": "string",
"example": "example-destination",
"description": "A human-readable name for your Data Export destination"
},
"config": {
"example": "{\"project\":\"test-prod\",\"topic\":\"ld-pubsub-test-192301\"}",
"description": "An object with the configuration parameters required for the destination type"
}
}
}
Destinations
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Destination"
},
"description": "An array of Data Export destinations"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/destinations",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
Distribution
{
"type": "object",
"properties": {
"kind": {
"enum": [
"normal",
"beta"
],
"type": "string",
"example": "normal",
"description": "The type of distribution."
},
"parameters": {
"type": "object",
"description": "The parameters of the distribution. The parameters are different for each distribution type. When <code>kind</code> is <code>normal</code>, the parameters of the distribution are 'mu' and 'sigma'. When <code>kind</code> is <code>beta</code>, the parameters of the distribution are 'alpha' and 'beta.'",
"additionalProperties": {}
}
}
}
DurationUnit
{
"type": "string"
}
Environment
{
"type": "object",
"required": [
"_links",
"_id",
"key",
"name",
"apiKey",
"mobileKey",
"color",
"defaultTtl",
"secureMode",
"defaultTrackEvents",
"requireComments",
"confirmChanges",
"tags",
"critical"
],
"properties": {
"_id": {
"type": "string",
"example": "57be1db38b75bf0772d11384",
"description": "The ID for the environment. Use this as the client-side ID for authorization in some client-side SDKs, and to associate LaunchDarkly environments with CDN integrations in edge SDKs."
},
"key": {
"type": "string",
"example": "environment-key-123abc",
"description": "A project-unique key for the new environment"
},
"name": {
"type": "string",
"example": "My Environment",
"description": "A human-friendly name for the new environment"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"ops"
],
"description": "A list of tags for this environment"
},
"color": {
"type": "string",
"example": "F5A623",
"description": "The color used to indicate this environment in the UI"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/projects/my-project/environments/my-environment",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"apiKey": {
"type": "string",
"example": "sdk-xxx",
"description": "The SDK key for the environment. Use this for authorization in server-side SDKs."
},
"critical": {
"type": "boolean",
"example": true,
"description": "Whether the environment is critical"
},
"mobileKey": {
"type": "string",
"example": "mob-xxx",
"description": "The mobile key for the environment. Use this for authorization in mobile SDKs."
},
"defaultTtl": {
"type": "integer",
"example": 5,
"description": "The default time (in minutes) that the PHP SDK can cache feature flag rules locally"
},
"secureMode": {
"type": "boolean",
"example": true,
"description": "Ensures that one end user of the client-side SDK cannot inspect the variations for another end user"
},
"confirmChanges": {
"type": "boolean",
"example": true,
"description": "Whether members who modify flags and segments through the LaunchDarkly user interface are required to confirm those changes"
},
"requireComments": {
"type": "boolean",
"example": true,
"description": "Whether members who modify flags and segments through the LaunchDarkly user interface are required to add a comment"
},
"approvalSettings": {
"$ref": "#/components/schemas/ApprovalSettings",
"description": "Details on the approval settings for this environment"
},
"defaultTrackEvents": {
"type": "boolean",
"example": false,
"description": "Enables tracking detailed information for new flags by default"
}
}
}
EnvironmentPost
{
"type": "object",
"required": [
"name",
"key",
"color"
],
"properties": {
"key": {
"type": "string",
"example": "environment-key-123abc",
"description": "A project-unique key for the new environment"
},
"name": {
"type": "string",
"example": "My Environment",
"description": "A human-friendly name for the new environment"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"ops"
],
"description": "Tags to apply to the new environment"
},
"color": {
"type": "string",
"example": "F5A623",
"description": "A color to indicate this environment in the UI"
},
"source": {
"$ref": "#/components/schemas/SourceEnv",
"description": "Indicates that the new environment created will be cloned from the provided source environment"
},
"critical": {
"type": "boolean",
"example": true,
"description": "Whether the environment is critical"
},
"defaultTtl": {
"type": "integer",
"example": 5,
"description": "The default time (in minutes) that the PHP SDK can cache feature flag rules locally"
},
"secureMode": {
"type": "boolean",
"example": true,
"description": "Ensures that one end user of the client-side SDK cannot inspect the variations for another end user"
},
"confirmChanges": {
"type": "boolean",
"example": false,
"description": "Requires confirmation for all flag and segment changes via the UI in this environment"
},
"requireComments": {
"type": "boolean",
"example": false,
"description": "Requires comments for all flag and segment changes via the UI in this environment"
},
"defaultTrackEvents": {
"type": "boolean",
"example": false,
"description": "Enables tracking detailed information for new flags by default"
}
}
}
EnvironmentSummary
{
"type": "object",
"required": [
"_links",
"key",
"name",
"color"
],
"properties": {
"key": {
"type": "string",
"example": "environment-key-123abc",
"description": "A project-unique key for the environment"
},
"name": {
"type": "string",
"example": "My Environment",
"description": "A human-friendly name for the environment"
},
"color": {
"type": "string",
"example": "F5A623",
"description": "The color used to indicate this environment in the UI"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/projects/my-project/environments/my-environment",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
Environments
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Environment"
},
"description": "An array of environments"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"example": 2,
"description": "The number of environments returned"
}
}
}
EvaluationReason
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"example": "OFF",
"description": "Describes the general reason that LaunchDarkly selected this variation."
},
"ruleID": {
"type": "string",
"example": "1234567890",
"description": "The unique identifier of the matching rule if the kind is 'RULE_MATCH'."
},
"errorKind": {
"type": "string",
"example": "USER_NOT_SPECIFIED",
"description": "The specific error type if the kind is 'ERROR'."
},
"ruleIndex": {
"type": "integer",
"example": 3,
"description": "The positional index of the matching rule if the kind is 'RULE_MATCH'. The index is 0-based."
},
"inExperiment": {
"type": "boolean",
"example": true,
"description": "Indicates whether the evaluation occurred as part of an experiment."
},
"prerequisiteKey": {
"type": "string",
"example": "someotherflagkey",
"description": "The key of the flag that failed if the kind is 'PREREQUISITE_FAILED'."
}
}
}
EvaluationsSummary
{
"type": "object",
"properties": {
"variations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VariationEvalSummary"
},
"description": "A list of variation evaluations"
}
}
}
EventType
{
"type": "string"
}
ExecutionOutput
{
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "string",
"example": "completed",
"description": "The status of the execution of this workflow stage"
},
"stopDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1718467200000",
"description": "Timestamp of when the workflow was completed."
}
}
}
ExpandableApprovalRequestResponse
{
"type": "object",
"required": [
"_id",
"_version",
"creationDate",
"serviceKind",
"reviewStatus",
"allReviews",
"notifyMemberIds",
"status",
"instructions",
"conflicts",
"_links"
],
"properties": {
"_id": {
"type": "string",
"example": "12ab3c45de678910abc12345",
"description": "The ID of this approval request"
},
"flag": {
"$ref": "#/components/schemas/ExpandedFlagRep",
"description": "Flag the approval request belongs to"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {}
},
"source": {
"$ref": "#/components/schemas/CopiedFromEnv",
"description": "Details about the source feature flag, if copied"
},
"status": {
"enum": [
"pending",
"completed",
"failed",
"scheduled"
],
"type": "string",
"example": "pending",
"description": "Current status of the approval request"
},
"project": {
"$ref": "#/components/schemas/Project",
"description": "Project the approval request belongs to"
},
"_version": {
"type": "integer",
"example": 1,
"description": "Version of the approval request"
},
"conflicts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Conflict"
},
"description": "Details on any conflicting approval requests"
},
"allReviews": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReviewResponse"
},
"description": "An array of individual reviews of this approval request"
},
"resourceId": {
"type": "string",
"description": "String representation of a resource"
},
"appliedDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when the approval request was applied"
},
"description": {
"type": "string",
"example": "example: request approval from someone",
"description": "A human-friendly name for the approval request"
},
"requestorId": {
"type": "string",
"example": "12ab3c45de678910abc12345",
"description": "The ID of the member who requested the approval"
},
"serviceKind": {
"$ref": "#/components/schemas/ApprovalRequestServiceKind",
"example": "launchdarkly",
"description": "The approval service for this request. May be LaunchDarkly or an external approval service, such as ServiceNow or JIRA."
},
"creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when the approval request was created"
},
"environments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Environment"
},
"description": "List of environments the approval impacts"
},
"instructions": {
"$ref": "#/components/schemas/Instructions",
"example": "[{\"kind\": \"turnFlagOn\"}]",
"description": "List of instructions in semantic patch format to be applied to the feature flag"
},
"reviewStatus": {
"enum": [
"approved",
"declined",
"pending"
],
"type": "string",
"example": "pending",
"description": "Current status of the review of this approval request"
},
"executionDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp for when instructions will be executed"
},
"operatingOnId": {
"type": "string",
"example": "12ab3c45de678910abc12345",
"description": "ID of scheduled change to edit or delete"
},
"notifyMemberIds": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"1234a56b7c89d012345e678f"
],
"description": "An array of member IDs. These members are notified to review the approval request."
},
"approvalSettings": {
"$ref": "#/components/schemas/ApprovalSettings",
"description": "The settings for this approval"
},
"appliedByMemberId": {
"type": "string",
"example": "1234a56b7c89d012345e678f",
"description": "The member ID of the member who applied the approval request"
},
"integrationMetadata": {
"$ref": "#/components/schemas/IntegrationMetadata",
"description": "Details about the object in an external service corresponding to this approval request, such as a ServiceNow change request or a JIRA ticket, if an external approval service is being used"
},
"customWorkflowMetadata": {
"$ref": "#/components/schemas/CustomWorkflowMeta",
"description": "Details about the custom workflow, if this approval request is part of a custom workflow"
},
"appliedByServiceTokenId": {
"type": "string",
"example": "1234a56b7c89d012345e678f",
"description": "The service token ID of the service token which applied the approval request"
}
}
}
ExpandableApprovalRequestsResponse
{
"type": "object",
"required": [
"items",
"totalCount",
"_links"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandableApprovalRequestResponse"
},
"description": "An array of approval requests"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"example": 1,
"description": "Total number of approval requests"
}
}
}
ExpandedFlagRep
{
"type": "object",
"required": [
"name",
"kind",
"key",
"_version",
"creationDate",
"variations",
"temporary",
"tags",
"_links",
"customProperties",
"archived"
],
"properties": {
"key": {
"type": "string",
"example": "flag-key-123abc",
"description": "A unique key used to reference the flag in your code"
},
"kind": {
"enum": [
"boolean",
"multivariate"
],
"type": "string",
"example": "boolean",
"description": "Kind of feature flag"
},
"name": {
"type": "string",
"example": "My Flag",
"description": "A human-friendly name for the feature flag"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"example-tag"
],
"description": "Tags for the feature flag"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/flags/my-project/my-flag",
"type": "application/json"
},
"parent": {
"href": "/api/v2/flags/my-project",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"_version": {
"type": "integer",
"example": 1,
"description": "Version of the feature flag"
},
"archived": {
"type": "boolean",
"example": false,
"description": "Boolean indicating if the feature flag is archived"
},
"defaults": {
"$ref": "#/components/schemas/Defaults",
"example": "{\"onVariation\":0,\"offVariation\":1}",
"description": "The indices, from the array of variations, for the variations to serve by default when targeting is on and when targeting is off. These variations will be used for this flag in new environments. If omitted, the first and last variation will be used."
},
"temporary": {
"type": "boolean",
"example": true,
"description": "Whether the flag is a temporary flag"
},
"variations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Variation"
},
"example": [
{
"_id": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
"value": true
},
{
"_id": "a00bf58d-d252-476c-b915-15a74becacb4",
"value": false
}
],
"description": "An array of possible variations for the flag"
},
"_maintainer": {
"$ref": "#/components/schemas/MemberSummary",
"description": "Details on the member who maintains this feature flag"
},
"description": {
"type": "string",
"example": "This flag controls the example widgets",
"description": "Description of the feature flag"
},
"archivedDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1494437420312",
"description": "If archived is true, date of archive"
},
"creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1494437420312",
"description": "Timestamp of flag creation date"
},
"maintainerId": {
"type": "string",
"example": "569f183514f4432160000007",
"description": "The ID of the member who maintains the flag"
},
"customProperties": {
"$ref": "#/components/schemas/CustomProperties",
"example": "{\"jira.issues\":{\"name\":\"Jira issues\",\"value\":[\"is-123\",\"is-456\"]}}",
"description": "Metadata attached to the feature flag, in the form of the property key associated with a name and array of values for the metadata to associate with this flag. Typically used to store data related to an integration."
},
"includeInSnippet": {
"type": "boolean",
"example": true,
"deprecated": true,
"description": "Deprecated, use <code>clientSideAvailability</code>. Whether this flag should be made available to the client-side JavaScript SDK"
},
"clientSideAvailability": {
"$ref": "#/components/schemas/ClientSideAvailability",
"example": "{\"usingMobileKey\":true,\"usingEnvironmentId\":false}",
"description": "Which type of client-side SDKs the feature flag is available to"
}
}
}
Experiment
{
"type": "object",
"required": [
"key",
"name",
"_maintainerId",
"_creationDate",
"_links"
],
"properties": {
"_id": {
"type": "string",
"example": "12ab3c45de678910fgh12345",
"description": "The experiment ID"
},
"key": {
"type": "string",
"example": "experiment-key-123abc",
"description": "The experiment key"
},
"name": {
"type": "string",
"example": "Example experiment",
"description": "The experiment name"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/projects/my-project/environments/my-environment/experiments/my-experiment",
"type": "application/json"
},
"parent": {
"href": "/api/v2/projects/my-project/environments/my-environment",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"description": {
"type": "string",
"example": "An example experiment, used in testing",
"description": "The experiment description"
},
"archivedDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when the experiment was archived"
},
"_creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when the experiment was created"
},
"_maintainerId": {
"type": "string",
"example": "12ab3c45de678910fgh12345",
"description": "The ID of the member who maintains this experiment."
},
"draftIteration": {
"$ref": "#/components/schemas/IterationRep",
"description": "Details on the current iteration. This iteration may be already started, or may still be a draft."
},
"environmentKey": {
"type": "string"
},
"currentIteration": {
"$ref": "#/components/schemas/IterationRep",
"description": "Details on the current iteration"
},
"previousIterations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IterationRep"
},
"description": "Details on the previous iterations for this experiment."
}
}
}
ExperimentAllocationRep
{
"type": "object",
"required": [
"defaultVariation",
"canReshuffle"
],
"properties": {
"canReshuffle": {
"type": "boolean"
},
"defaultVariation": {
"type": "integer"
}
}
}
ExperimentBayesianResultsRep
{
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SlicedResultsRep"
},
"description": "A list of attribute values and their corresponding treatment results"
},
"metricSeen": {
"$ref": "#/components/schemas/MetricSeen"
},
"treatmentResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TreatmentResultRep"
},
"deprecated": true,
"description": "Deprecated, use <code>results</code> instead. Only populated when response does not contain results sliced by multiple attributes."
},
"probabilityOfMismatch": {
"type": "number",
"example": 0.9999999999999738,
"description": "The probability of a Sample Ratio Mismatch"
}
}
}
ExperimentCollectionRep
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Experiment"
},
"description": "An array of experiments"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"total_count": {
"type": "integer",
"description": "The total number of experiments in this project and environment. Does not include legacy experiments."
}
}
}
ExperimentEnabledPeriodRep
{
"type": "object",
"properties": {
"stopDate": {
"$ref": "#/components/schemas/UnixMillis"
},
"startDate": {
"$ref": "#/components/schemas/UnixMillis"
}
}
}
ExperimentEnvironmentSettingRep
{
"type": "object",
"properties": {
"stopDate": {
"$ref": "#/components/schemas/UnixMillis"
},
"startDate": {
"$ref": "#/components/schemas/UnixMillis"
},
"enabledPeriods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExperimentEnabledPeriodRep"
}
}
}
}
ExperimentInfoRep
{
"type": "object",
"required": [
"baselineIdx",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LegacyExperimentRep"
}
},
"baselineIdx": {
"type": "integer"
}
}
}
ExperimentMetadataRep
{
"type": "object",
"properties": {
"key": {}
}
}
ExperimentPatchInput
{
"type": "object",
"required": [
"instructions"
],
"properties": {
"comment": {
"type": "string",
"example": "Optional comment",
"description": "Optional comment describing the update"
},
"instructions": {
"$ref": "#/components/schemas/Instructions",
"example": "[{\"kind\": \"updateName\", \"value\": \"Updated experiment name\"}]",
"description": "The instructions to perform when updating. This should be an array with objects that look like <code>{\"kind\": \"update_action\"}</code>. Some instructions also require a <code>value</code> field in the array element."
}
}
}
ExperimentPost
{
"type": "object",
"required": [
"name",
"key",
"iteration"
],
"properties": {
"key": {
"type": "string",
"example": "experiment-key-123abc",
"description": "The experiment key"
},
"name": {
"type": "string",
"example": "Example experiment",
"description": "The experiment name"
},
"iteration": {
"$ref": "#/components/schemas/IterationInput",
"description": "Details on the construction of the initial iteration"
},
"description": {
"type": "string",
"example": "An example experiment, used in testing",
"description": "The experiment description"
},
"maintainerId": {
"type": "string",
"example": "12ab3c45de678910fgh12345",
"description": "The ID of the member who maintains this experiment"
}
}
}
ExperimentResults
{
"type": "object",
"properties": {
"stats": {
"$ref": "#/components/schemas/ExperimentStatsRep"
},
"_links": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"series": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExperimentTimeSeriesSlice"
}
},
"totals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExperimentTotalsRep"
}
},
"metadata": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExperimentMetadataRep"
}
},
"metricSeen": {
"$ref": "#/components/schemas/MetricSeen"
},
"granularity": {
"type": "string"
}
}
}
ExperimentStatsRep
{
"type": "object",
"properties": {
"chi2": {
"type": "number"
},
"pValue": {
"type": "number"
},
"minSampleSizeMet": {
"type": "boolean"
},
"winningVariationIdx": {
"type": "integer"
}
}
}
ExperimentTimeSeriesSlice
{
"type": "object",
"properties": {
"Time": {
"$ref": "#/components/schemas/UnixMillis"
},
"VariationData": {
"$ref": "#/components/schemas/ExperimentTimeSeriesVariationSlices"
}
}
}
ExperimentTimeSeriesVariationSlice
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int64"
},
"value": {
"type": "number"
},
"conversionRate": {
"type": "number"
},
"cumulativeCount": {
"type": "integer",
"format": "int64"
},
"cumulativeValue": {
"type": "number"
},
"confidenceInterval": {
"$ref": "#/components/schemas/ConfidenceIntervalRep"
},
"cumulativeConversionRate": {
"type": "number"
},
"cumulativeConfidenceInterval": {
"$ref": "#/components/schemas/ConfidenceIntervalRep"
}
}
}
ExperimentTimeSeriesVariationSlices
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ExperimentTimeSeriesVariationSlice"
}
}
ExperimentTotalsRep
{
"type": "object",
"properties": {
"pValue": {
"type": "number"
},
"improvement": {
"type": "number"
},
"minSampleSize": {
"type": "integer",
"format": "int64"
},
"cumulativeCount": {
"type": "integer",
"format": "int64"
},
"cumulativeValue": {
"type": "number"
},
"cumulativeConversionRate": {
"type": "number"
},
"cumulativeImpressionCount": {
"type": "integer",
"format": "int64"
},
"cumulativeConfidenceInterval": {
"$ref": "#/components/schemas/ConfidenceIntervalRep"
}
}
}
ExpiringTarget
{
"type": "object",
"required": [
"_id",
"_version",
"expirationDate",
"contextKind",
"contextKey",
"_resourceId"
],
"properties": {
"_id": {
"type": "string",
"example": "12ab3c45de678910abc12345",
"description": "The ID of this expiring target"
},
"_version": {
"type": "integer",
"example": 1,
"description": "The version of this expiring target"
},
"contextKey": {
"type": "string",
"example": "context-key-123abc",
"description": "A unique key used to represent the context to be removed"
},
"targetType": {
"type": "string",
"example": "included",
"description": "A segment's target type, <code>included</code> or <code>excluded</code>. Included when expiring targets are updated on a segment."
},
"_resourceId": {
"$ref": "#/components/schemas/ResourceId",
"description": "Details on the segment or flag this expiring target belongs to, its environment, and its project"
},
"contextKind": {
"type": "string",
"example": "user",
"description": "The context kind of the context to be removed"
},
"variationId": {
"type": "string",
"example": "cc4332e2-bd4d-4fe0-b509-dfd2caf8dd73",
"description": "A unique ID used to represent the flag variation. Included when expiring targets are updated on a feature flag."
},
"expirationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1672358400000",
"description": "A timestamp for when the target expires"
}
}
}
ExpiringTargetError
{
"type": "object",
"required": [
"instructionIndex",
"message"
],
"properties": {
"message": {
"type": "string",
"example": "example error message",
"description": "The error message related to a failed PATCH instruction"
},
"instructionIndex": {
"type": "integer",
"example": 1,
"description": "The index of the PATCH instruction where the error occurred"
}
}
}
ExpiringTargetGetResponse
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpiringTarget"
},
"description": "A list of expiring targets"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
ExpiringTargetPatchResponse
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpiringTarget"
},
"description": "A list of the results from each instruction"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpiringTargetError"
}
},
"totalInstructions": {
"type": "integer"
},
"failedInstructions": {
"type": "integer"
},
"successfulInstructions": {
"type": "integer"
}
}
}
ExpiringUserTargetGetResponse
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpiringUserTargetItem"
},
"description": "An array of expiring user targets"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
ExpiringUserTargetItem
{
"type": "object",
"required": [
"_id",
"_version",
"expirationDate",
"userKey",
"_resourceId"
],
"properties": {
"_id": {
"type": "string",
"example": "12ab3c45de678910fgh12345",
"description": "The ID of this expiring user target"
},
"userKey": {
"type": "string",
"example": "example-user-key",
"description": "A unique key used to represent the user"
},
"_version": {
"type": "integer",
"example": 1,
"description": "The version of this expiring user target"
},
"targetType": {
"type": "string",
"example": "included",
"description": "A segment's target type. Included when expiring user targets are updated on a segment."
},
"_resourceId": {
"$ref": "#/components/schemas/ResourceIDResponse",
"description": "Details on the resource from which the user is expiring"
},
"variationId": {
"type": "string",
"example": "ce67d625-a8b9-4fb5-a344-ab909d9d4f4d",
"description": "A unique key used to represent the flag variation. Included when expiring user targets are updated on a feature flag."
},
"expirationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1658192820000",
"description": "A timestamp for when the user target expires"
}
}
}
ExpiringUserTargetPatchResponse
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpiringUserTargetItem"
},
"description": "An array of expiring user targets"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpiringTargetError"
},
"description": "An array of error messages for the failed instructions"
},
"totalInstructions": {
"type": "integer",
"example": 1,
"description": "The total count of instructions sent in the PATCH request"
},
"failedInstructions": {
"type": "integer",
"example": 0,
"description": "The total count of the failed instructions sent in the PATCH request"
},
"successfulInstructions": {
"type": "integer",
"example": 1,
"description": "The total count of successful instructions sent in the PATCH request"
}
}
}
Export
{
"type": "object",
"required": [
"id",
"segmentKey",
"creationTime",
"status",
"sizeBytes",
"size",
"initiator",
"_links"
],
"properties": {
"id": {
"type": "string",
"example": "1234a567-bcd8-9123-4567-abcd1234567f",
"description": "The export ID"
},
"size": {
"type": "string",
"example": "18 B",
"description": "The export size, with units"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources, including the location of the exported file",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"status": {
"type": "string",
"example": "complete",
"description": "The export status"
},
"initiator": {
"$ref": "#/components/schemas/InitiatorRep",
"example": "{\"name\": \"Ariel Flores\", \"email\": \"ariel@acme.com\"}",
"description": "Details on the member who initiated the export"
},
"sizeBytes": {
"type": "integer",
"format": "int64",
"example": 18,
"description": "The export size, in bytes"
},
"segmentKey": {
"type": "string",
"example": "example-big-segment",
"description": "The segment key"
},
"creationTime": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when this export was created"
}
}
}
Extinction
{
"type": "object",
"required": [
"revision",
"message",
"time",
"flagKey",
"projKey"
],
"properties": {
"time": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1636558831870",
"description": "Time of extinction"
},
"flagKey": {
"type": "string",
"example": "enable-feature",
"description": "The feature flag key"
},
"message": {
"type": "string",
"example": "Remove flag for launched feature",
"description": "Description of the extinction. For example, the commit message for the revision."
},
"projKey": {
"type": "string",
"example": "default",
"description": "The project key"
},
"revision": {
"type": "string",
"example": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3",
"description": "The identifier for the revision where flag became extinct. For example, a commit SHA."
}
}
}
ExtinctionCollectionRep
{
"type": "object",
"required": [
"_links",
"items"
],
"properties": {
"items": {
"type": "object",
"description": "An array of extinction events",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Extinction"
}
}
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
ExtinctionListPost
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Extinction"
}
}
FailureReasonRep
{
"type": "object",
"required": [
"attribute",
"reason"
],
"properties": {
"reason": {
"type": "string",
"example": "must be present",
"description": "The reason the attribute failed validation"
},
"attribute": {
"type": "string",
"example": "projectKey",
"description": "The attribute that failed validation"
}
}
}
FeatureFlag
{
"type": "object",
"required": [
"name",
"kind",
"key",
"_version",
"creationDate",
"variations",
"temporary",
"tags",
"_links",
"experiments",
"customProperties",
"archived",
"deprecated",
"environments"
],
"properties": {
"key": {
"type": "string",
"example": "flag-key-123abc",
"description": "A unique key used to reference the flag in your code"
},
"kind": {
"enum": [
"boolean",
"multivariate"
],
"type": "string",
"example": "boolean",
"description": "Kind of feature flag"
},
"name": {
"type": "string",
"example": "My Flag",
"description": "A human-friendly name for the feature flag"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"example-tag"
],
"description": "Tags for the feature flag"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/flags/my-project/my-flag",
"type": "application/json"
},
"parent": {
"href": "/api/v2/flags/my-project",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"goalIds": {
"type": "array",
"items": {
"type": "string"
},
"example": [],
"deprecated": true,
"description": "Deprecated, use <code>experiments</code> instead"
},
"_purpose": {
"type": "string"
},
"_version": {
"type": "integer",
"example": 1,
"description": "Version of the feature flag"
},
"archived": {
"type": "boolean",
"example": false,
"description": "Boolean indicating if the feature flag is archived"
},
"defaults": {
"$ref": "#/components/schemas/Defaults",
"example": "{\"onVariation\":0,\"offVariation\":1}",
"description": "The indices, from the array of variations, for the variations to serve by default when targeting is on and when targeting is off. These variations will be used for this flag in new environments. If omitted, the first and last variation will be used."
},
"temporary": {
"type": "boolean",
"example": true,
"description": "Whether the flag is a temporary flag"
},
"deprecated": {
"type": "boolean",
"example": false,
"description": "Boolean indicating if the feature flag is deprecated"
},
"variations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Variation"
},
"example": [
{
"_id": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
"value": true
},
{
"_id": "a00bf58d-d252-476c-b915-15a74becacb4",
"value": false
}
],
"description": "An array of possible variations for the flag"
},
"_maintainer": {
"$ref": "#/components/schemas/MemberSummary",
"description": "Associated maintainer member info for the feature flag"
},
"description": {
"type": "string",
"example": "This flag controls the example widgets",
"description": "Description of the feature flag"
},
"experiments": {
"$ref": "#/components/schemas/ExperimentInfoRep",
"example": "{\"baselineIdx\": 0,\"items\": []}",
"description": "Experimentation data for the feature flag"
},
"archivedDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1494437420312",
"description": "If archived is true, date of archive"
},
"creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1494437420312",
"description": "Timestamp of flag creation date"
},
"environments": {
"type": "object",
"example": {
"my-environment": {
"on": false,
"sel": "810edeadbeef4844facecafe438f2999492",
"salt": "61eddeadbeef4da1facecafe3a60a397",
"_site": {
"href": "/default/my-environment/features/client-side-flag",
"type": "text/html"
},
"rules": [],
"targets": [
{
"values": [
"user-key-123abc"
],
"variation": 0,
"contextKind": "user"
}
],
"version": 1,
"_summary": {
"variations": {
"0": {
"rules": 0,
"targets": 1,
"nullRules": 0,
"isFallthrough": true,
"contextTargets": 1
},
"1": {
"isOff": true,
"rules": 0,
"targets": 0,
"nullRules": 0
}
},
"prerequisites": 0
},
"archived": false,
"fallthrough": {
"variation": 0
},
"trackEvents": false,
"lastModified": 1627071171347,
"offVariation": 1,
"prerequisites": [],
"contextTargets": [
{
"values": [
"device-key-123abc"
],
"variation": 0,
"contextKind": "device"
}
],
"_environmentName": "My Environment",
"trackEventsFallthrough": false
}
},
"description": "Details on the environments for this flag. Only returned if the request is filtered by environment, using the <code>filterEnv</code> query parameter.",
"additionalProperties": {
"$ref": "#/components/schemas/FeatureFlagConfig"
}
},
"maintainerId": {
"type": "string",
"example": "569f183514f4432160000007",
"description": "Associated maintainerId for the feature flag"
},
"deprecatedDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1494437420312",
"description": "If deprecated is true, date of deprecation"
},
"_maintainerTeam": {
"$ref": "#/components/schemas/MaintainerTeam",
"description": "Associated maintainer team info for the feature flag"
},
"customProperties": {
"$ref": "#/components/schemas/CustomProperties",
"example": "{\"jira.issues\":{\"name\":\"Jira issues\",\"value\":[\"is-123\",\"is-456\"]}}",
"description": "Metadata attached to the feature flag, in the form of the property key associated with a name and array of values for the metadata to associate with this flag. Typically used to store data related to an integration."
},
"includeInSnippet": {
"type": "boolean",
"example": true,
"deprecated": true,
"description": "Deprecated, use <code>clientSideAvailability</code>. Whether this flag should be made available to the client-side JavaScript SDK"
},
"maintainerTeamKey": {
"type": "string",
"example": "team-1",
"description": "The key of the associated team that maintains this feature flag"
},
"migrationSettings": {
"$ref": "#/components/schemas/FlagMigrationSettingsRep",
"description": "Migration-related settings for the flag"
},
"clientSideAvailability": {
"$ref": "#/components/schemas/ClientSideAvailability",
"example": "{\"usingMobileKey\":true,\"usingEnvironmentId\":false}",
"description": "Which type of client-side SDKs the feature flag is available to"
}
}
}
FeatureFlagBody
{
"type": "object",
"required": [
"name",
"key"
],
"properties": {
"key": {
"type": "string",
"example": "flag-key-123abc",
"description": "A unique key used to reference the flag in your code"
},
"name": {
"type": "string",
"example": "My flag",
"description": "A human-friendly name for the feature flag"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"example-tag"
],
"description": "Tags for the feature flag. Defaults to an empty array."
},
"purpose": {
"enum": [
"migration"
],
"type": "string",
"example": "migration",
"description": "Purpose of the flag"
},
"defaults": {
"$ref": "#/components/schemas/Defaults",
"example": "{\"onVariation\":0, \"offVariation\":1}",
"description": "The indices, from the array of variations, for the variations to serve by default when targeting is on and when targeting is off. These variations will be used for this flag in new environments. If omitted, the first and last variation will be used."
},
"temporary": {
"type": "boolean",
"example": false,
"description": "Whether the flag is a temporary flag. Defaults to <code>true</code>."
},
"variations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Variation"
},
"example": [
{
"value": true
},
{
"value": false
}
],
"description": "An array of possible variations for the flag. The variation values must be unique. If omitted, two boolean variations of <code>true</code> and <code>false</code> will be used."
},
"description": {
"type": "string",
"example": "This flag controls the example widgets",
"description": "Description of the feature flag. Defaults to an empty string."
},
"maintainerId": {
"type": "string",
"example": "12ab3c45de678910fgh12345",
"description": "The ID of the member who maintains this feature flag"
},
"customProperties": {
"$ref": "#/components/schemas/CustomProperties",
"example": "{ \"jira.issues\": {\"name\": \"Jira issues\", \"value\": [\"is-123\", \"is-456\"]} }",
"description": "Metadata attached to the feature flag, in the form of the property key associated with a name and array of values for the metadata to associate with this flag. Typically used to store data related to an integration."
},
"includeInSnippet": {
"type": "boolean",
"deprecated": true,
"description": "Deprecated, use <code>clientSideAvailability</code>. Whether this flag should be made available to the client-side JavaScript SDK. Defaults to <code>false</code>."
},
"maintainerTeamKey": {
"type": "string",
"example": "team-1",
"description": "The key of the team that maintains this feature flag"
},
"migrationSettings": {
"$ref": "#/components/schemas/MigrationSettingsPost",
"description": "Settings relevant to flags where <code>purpose</code> is <code>migration</code>"
},
"clientSideAvailability": {
"$ref": "#/components/schemas/ClientSideAvailabilityPost",
"example": "{\"usingMobileKey\":true,\"usingEnvironmentId\":false}",
"description": "Which type of client-side SDKs the feature flag is available to"
}
}
}
FeatureFlagConfig
{
"type": "object",
"required": [
"on",
"archived",
"salt",
"sel",
"lastModified",
"version",
"_site",
"_environmentName",
"trackEvents",
"trackEventsFallthrough"
],
"properties": {
"on": {
"type": "boolean",
"description": "Whether the flag is on"
},
"sel": {
"type": "string"
},
"salt": {
"type": "string"
},
"_site": {
"$ref": "#/components/schemas/Link",
"description": "Details on how to access the flag configuration in the LaunchDarkly UI"
},
"rules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Rule"
},
"description": "An array of the rules for how to serve a variation to specific targets based on their attributes"
},
"_access": {
"$ref": "#/components/schemas/Access",
"description": "Details on the allowed and denied actions for this flag"
},
"targets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Target"
},
"description": "An array of the individual targets that will receive a specific variation based on their key. Individual targets with a context kind of 'user' are included here."
},
"version": {
"type": "integer",
"description": "Version of the feature flag"
},
"_summary": {
"$ref": "#/components/schemas/FlagSummary",
"description": "A summary of the prerequisites and variations for this flag"
},
"archived": {
"type": "boolean",
"description": "Boolean indicating if the feature flag is archived"
},
"evaluation": {
"$ref": "#/components/schemas/FlagConfigEvaluation",
"description": "Evaluation information for the flag"
},
"fallthrough": {
"$ref": "#/components/schemas/VariationOrRolloutRep",
"description": "Details on the variation or rollout to serve as part of the flag's default rule"
},
"trackEvents": {
"type": "boolean",
"description": "Whether LaunchDarkly tracks events for the feature flag, for all rules"
},
"lastModified": {
"$ref": "#/components/schemas/UnixMillis",
"description": "Timestamp of when the flag configuration was most recently modified"
},
"offVariation": {
"type": "integer",
"description": "The ID of the variation to serve when the flag is off"
},
"prerequisites": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Prerequisite"
},
"description": "An array of the prerequisite flags and their variations that are required before this flag takes effect"
},
"contextTargets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Target"
},
"description": "An array of the individual targets that will receive a specific variation based on their key. Individual targets with context kinds other than 'user' are included here."
},
"_environmentName": {
"type": "string",
"description": "The environment name"
},
"migrationSettings": {
"$ref": "#/components/schemas/FlagConfigMigrationSettingsRep",
"description": "Migration-related settings for the flag configuration"
},
"_debugEventsUntilDate": {
"$ref": "#/components/schemas/UnixMillis"
},
"trackEventsFallthrough": {
"type": "boolean",
"description": "Whether LaunchDarkly tracks events for the feature flag, for the default rule"
}
}
}
FeatureFlagScheduledChange
{
"type": "object",
"required": [
"_id",
"_creationDate",
"_maintainerId",
"_version",
"executionDate",
"instructions"
],
"properties": {
"_id": {
"$ref": "#/components/schemas/FeatureWorkflowId",
"example": "12ab3c45de678910abc12345",
"description": "The ID of this scheduled change"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"_version": {
"type": "integer",
"example": 1,
"description": "Version of the scheduled change"
},
"conflicts": {
"description": "Details on any conflicting scheduled changes"
},
"instructions": {
"$ref": "#/components/schemas/Instructions",
"example": "[ { \"kind\": \"turnFlagOn\" }]",
"description": "The actions to perform on the execution date for these scheduled changes"
},
"_creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654123897062",
"description": "Timestamp of when the scheduled change was created"
},
"_maintainerId": {
"type": "string",
"example": "12ab3c45de678910abc12345",
"description": "The ID of the scheduled change maintainer"
},
"executionDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1636558831870",
"description": "When the scheduled changes should be executed"
}
}
}
FeatureFlagScheduledChanges
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeatureFlagScheduledChange"
},
"description": "Array of scheduled changes"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
FeatureFlagStatus
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "inactive",
"description": "Status of the flag"
},
"default": {
"description": "Default value seen from code"
},
"lastRequested": {
"type": "string",
"format": "date-time",
"example": "2020-02-05T18:17:01.514Z",
"description": "Timestamp of last time flag was requested"
}
}
}
FeatureFlagStatusAcrossEnvironments
{
"type": "object",
"required": [
"environments",
"key",
"_links"
],
"properties": {
"key": {
"type": "string",
"example": "flag-key-123abc",
"description": "feature flag key"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/flag-status/my-project/my-flag",
"type": "application/json"
},
"parent": {
"href": "/api/v2/flag-status",
"type": "application/json"
}
},
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"environments": {
"type": "object",
"example": {
"production": {
"name": "inactive",
"lastRequested": "2020-02-05T18:17:01.514Z"
}
},
"description": "Flag status for environment.",
"additionalProperties": {
"$ref": "#/components/schemas/FeatureFlagStatus"
}
}
}
}
FeatureFlagStatuses
{
"type": "object",
"required": [
"_links"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagStatusRep"
}
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/flag-statuses/my-project/my-environment",
"type": "application/json"
}
},
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
FeatureFlags
{
"type": "object",
"required": [
"items",
"_links"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeatureFlag"
},
"description": "An array of feature flags"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/flags/default",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"example": 1,
"description": "The total number of flags"
},
"totalCountWithDifferences": {
"type": "integer",
"example": 0,
"description": "The number of flags that have differences between environments. Only shown when query parameter <code>compare</code> is <code>true</code>."
}
}
}
FeatureFlagsBetaGetMigrationSafetyIssuesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/MigrationSafetyIssueRep"
}
}
FeatureWorkflowId
{
"type": "string"
}
FileRep
{
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "complete",
"description": "The imported file status"
},
"filename": {
"type": "string",
"example": "bigsegimport.csv",
"description": "The imported file name, including the extension"
}
}
}
FlagConfigApprovalRequestResponse
{
"type": "object",
"required": [
"_id",
"_version",
"creationDate",
"serviceKind",
"reviewStatus",
"allReviews",
"notifyMemberIds",
"status",
"instructions",
"conflicts",
"_links"
],
"properties": {
"_id": {
"type": "string",
"example": "12ab3c45de678910abc12345",
"description": "The ID of this approval request"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {}
},
"source": {
"$ref": "#/components/schemas/CopiedFromEnv",
"description": "Details about the source feature flag, if copied"
},
"status": {
"enum": [
"pending",
"completed",
"failed",
"scheduled"
],
"type": "string",
"example": "pending",
"description": "Current status of the approval request"
},
"_version": {
"type": "integer",
"example": 1,
"description": "Version of the approval request"
},
"conflicts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Conflict"
},
"description": "Details on any conflicting approval requests"
},
"allReviews": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReviewResponse"
},
"description": "An array of individual reviews of this approval request"
},
"appliedDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when the approval request was applied"
},
"description": {
"type": "string",
"example": "example: request approval from someone",
"description": "A human-friendly name for the approval request"
},
"requestorId": {
"type": "string",
"example": "12ab3c45de678910abc12345",
"description": "The ID of the member who requested the approval"
},
"serviceKind": {
"$ref": "#/components/schemas/ApprovalRequestServiceKind",
"example": "launchdarkly",
"description": "The approval service for this request. May be LaunchDarkly or an external approval service, such as ServiceNow or JIRA."
},
"creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when the approval request was created"
},
"instructions": {
"$ref": "#/components/schemas/Instructions",
"example": "[{\"kind\": \"turnFlagOn\"}]",
"description": "List of instructions in semantic patch format to be applied to the feature flag"
},
"reviewStatus": {
"enum": [
"approved",
"declined",
"pending"
],
"type": "string",
"example": "pending",
"description": "Current status of the review of this approval request"
},
"executionDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp for when instructions will be executed"
},
"operatingOnId": {
"type": "string",
"example": "12ab3c45de678910abc12345",
"description": "ID of scheduled change to edit or delete"
},
"notifyMemberIds": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"1234a56b7c89d012345e678f"
],
"description": "An array of member IDs. These members are notified to review the approval request."
},
"appliedByMemberId": {
"type": "string",
"example": "1234a56b7c89d012345e678f",
"description": "The member ID of the member who applied the approval request"
},
"integrationMetadata": {
"$ref": "#/components/schemas/IntegrationMetadata",
"description": "Details about the object in an external service corresponding to this approval request, such as a ServiceNow change request or a JIRA ticket, if an external approval service is being used"
},
"customWorkflowMetadata": {
"$ref": "#/components/schemas/CustomWorkflowMeta",
"description": "Details about the custom workflow, if this approval request is part of a custom workflow"
},
"appliedByServiceTokenId": {
"type": "string",
"example": "1234a56b7c89d012345e678f",
"description": "The service token ID of the service token which applied the approval request"
}
}
}
FlagConfigApprovalRequestsResponse
{
"type": "object",
"required": [
"items",
"_links"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagConfigApprovalRequestResponse"
},
"description": "An array of approval requests"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
FlagConfigEvaluation
{
"type": "object",
"properties": {
"contextKinds": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
FlagConfigMigrationSettingsRep
{
"type": "object",
"properties": {
"checkRatio": {
"type": "integer"
}
}
}
FlagCopyConfigEnvironment
{
"type": "object",
"required": [
"key"
],
"properties": {
"key": {
"type": "string",
"description": "The environment key"
},
"currentVersion": {
"type": "integer",
"description": "Optional flag version. If you include this, the operation only succeeds if the current flag version in the environment matches this version."
}
}
}
FlagCopyConfigPost
{
"type": "object",
"required": [
"source",
"target"
],
"properties": {
"source": {
"$ref": "#/components/schemas/FlagCopyConfigEnvironment",
"example": "{\"key\": \"source-env-key-123abc\", \"currentVersion\": 1}",
"description": "The source environment"
},
"target": {
"$ref": "#/components/schemas/FlagCopyConfigEnvironment",
"example": "{\"key\": \"target-env-key-123abc\", \"currentVersion\": 1}",
"description": "The target environment"
},
"comment": {
"type": "string",
"description": "Optional comment"
},
"excludedActions": {
"type": "array",
"items": {
"enum": [
"updateOn",
"updateRules",
"updateFallthrough",
"updateOffVariation",
"updatePrerequisites",
"updateTargets",
"updateFlagConfigMigrationSettings"
],
"type": "string"
},
"example": [
"updateOn"
],
"description": "Optional list of the flag changes NOT to copy from the source environment to the target environment. You may include either <code>includedActions</code> or <code>excludedActions</code>, but not both. If you include neither, then all flag changes will be copied."
},
"includedActions": {
"type": "array",
"items": {
"enum": [
"updateOn",
"updateRules",
"updateFallthrough",
"updateOffVariation",
"updatePrerequisites",
"updateTargets",
"updateFlagConfigMigrationSettings"
],
"type": "string"
},
"example": [
"updateOn"
],
"description": "Optional list of the flag changes to copy from the source environment to the target environment. You may include either <code>includedActions</code> or <code>excludedActions</code>, but not both. If you include neither, then all flag changes will be copied."
}
}
}
FlagEventCollectionRep
{
"type": "object",
"required": [
"totalCount",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagEventRep"
},
"description": "A list of flag events"
},
"_links": {
"type": "object",
"example": {
"next": {
"href": "/api/v2/engineering-insights/flag-events?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5",
"type": "application/json"
},
"self": {
"href": "/api/v2/engineering-insights/flag-events",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"example": 1200,
"description": "The total number of flag events"
}
}
}
FlagEventExperiment
{
"type": "object",
"required": [
"key",
"name",
"iteration"
],
"properties": {
"key": {
"type": "string",
"example": "experiment-1",
"description": "The experiment key"
},
"name": {
"type": "string",
"example": "Experiment 1",
"description": "The experiment name"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"iteration": {
"$ref": "#/components/schemas/FlagEventExperimentIteration",
"description": "The experiment iteration"
}
}
}
FlagEventExperimentCollection
{
"type": "object",
"required": [
"totalCount",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagEventExperiment"
},
"description": "A list of experiments"
},
"totalCount": {
"type": "integer",
"example": 1,
"description": "The total number of experiments"
}
}
}
FlagEventExperimentIteration
{
"type": "object",
"required": [
"id",
"status",
"startedAt"
],
"properties": {
"id": {
"type": "string",
"example": "65baa44ecc4b5bce113bb4f7",
"description": "The experiment iteration ID"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"status": {
"$ref": "#/components/schemas/IterationStatus",
"enum": [
"running",
"stopped"
],
"example": "running",
"description": "The experiment iteration status"
},
"endedAt": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1656610200000",
"description": "Timestamp of when the iteration ended"
},
"startedAt": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1655314200000",
"description": "Timestamp of when the iteration started"
}
}
}
FlagEventImpactRep
{
"type": "object",
"properties": {
"size": {
"enum": [
"none",
"small",
"medium",
"large"
],
"type": "string",
"example": "medium",
"description": "The size of the flag event impact. Sizes are defined as: none (0%), small (0-20%), medium (20-80%), large (>80%)"
},
"reason": {
"$ref": "#/components/schemas/ImpactReason",
"enum": [
"evaluations",
"global",
"waiting"
],
"example": "evaluations",
"description": "The reason for the flag event impact"
},
"percentage": {
"type": "number",
"example": 50,
"description": "The percentage of the flag event impact"
},
"evaluationsSummary": {
"$ref": "#/components/schemas/EvaluationsSummary",
"description": "A summary of the change in variation evaluations after the flag event"
}
}
}
FlagEventMemberRep
{
"type": "object",
"required": [
"id",
"email",
"firstName",
"lastName"
],
"properties": {
"id": {
"type": "string",
"example": "65baa44ecc4b5bce113bb4f7",
"description": "The member ID"
},
"email": {
"type": "string",
"example": "test@launchdarkly.com",
"description": "The member email"
},
"lastName": {
"type": "string",
"description": "The member last name"
},
"firstName": {
"type": "string",
"description": "The member first name"
}
}
}
FlagEventRep
{
"type": "object",
"required": [
"id",
"projectId",
"projectKey",
"flagKey",
"eventType",
"eventTime",
"description",
"impact"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "e3b2b0e0-9e9b-4c9a-8e9a-0e0e0e0e0e0e",
"description": "The flag event ID"
},
"impact": {
"$ref": "#/components/schemas/FlagEventImpactRep",
"description": "The flag event evaluation impact"
},
"member": {
"$ref": "#/components/schemas/FlagEventMemberRep",
"description": "The member data"
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "The resource actions"
},
"flagKey": {
"type": "string",
"example": "enable-new-payment-method",
"description": "The flag key"
},
"eventTime": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1616425200000",
"description": "A Unix timestamp in milliseconds"
},
"eventType": {
"$ref": "#/components/schemas/EventType",
"example": "enabled_targeting",
"description": "The event type"
},
"projectId": {
"type": "string",
"example": "65baa44ecc4b5bce113bb4f7",
"description": "The project ID"
},
"projectKey": {
"type": "string",
"example": "default",
"description": "The project key"
},
"description": {
"type": "string",
"example": "Targeting rule enabled",
"description": "The event description"
},
"experiments": {
"$ref": "#/components/schemas/FlagEventExperimentCollection",
"description": "A list of experiment iterations related to the flag event"
},
"environmentId": {
"type": "string",
"example": "65baa44ecc4b5bce113bb4f7",
"description": "The environment ID"
},
"environmentKey": {
"type": "string",
"example": "production",
"description": "The environment key"
},
"auditLogEntryId": {
"type": "string",
"example": "e3b2b0e0-9e9b-4c9a-8e9a-0e0e0e0e0e0e",
"description": "The audit log entry ID"
}
}
}
FlagFollowersByProjEnvGetRep
{
"type": "object",
"required": [
"_links"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/followersPerFlag"
},
"description": "An array of flags and their followers"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/projects/my-project/flags/my-flay/environments/my-environment/followers",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
FlagFollowersGetRep
{
"type": "object",
"required": [
"_links",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FollowFlagMember"
},
"description": "An array of members who are following this flag"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/projects/my-project/flags/my-flay/environments/my-environment/followers",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
FlagInput
{
"type": "object",
"required": [
"ruleId",
"flagConfigVersion"
],
"properties": {
"ruleId": {
"type": "string",
"example": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
"description": "The ID of the variation or rollout of the flag to use. Use \"fallthrough\" for the default targeting behavior when the flag is on."
},
"flagConfigVersion": {
"type": "integer",
"example": 12,
"description": "The flag version"
}
}
}
FlagLinkCollectionRep
{
"type": "object",
"required": [
"items",
"_links"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagLinkRep"
},
"description": "An array of flag links"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
FlagLinkMember
{
"type": "object",
"required": [
"_links",
"_id"
],
"properties": {
"_id": {
"type": "string"
},
"_links": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"lastName": {
"type": "string"
},
"firstName": {
"type": "string"
}
}
}
FlagLinkRep
{
"type": "object",
"required": [
"_links",
"_id",
"_deepLink",
"_timestamp",
"_createdAt"
],
"properties": {
"_id": {
"type": "string",
"example": "1234a56b7c89d012345e678f",
"description": "The ID of this flag link"
},
"_key": {
"type": "string",
"example": "flag-link-key-123abc",
"description": "The flag link key"
},
"title": {
"type": "string",
"example": "Example link title",
"description": "The title of the flag link"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"_member": {
"$ref": "#/components/schemas/FlagLinkMember",
"description": "Details on the member associated with this flag link"
},
"_deepLink": {
"type": "string",
"example": "https://example.com/archives/123123123",
"description": "The URL for the external resource the flag is linked to"
},
"_metadata": {
"type": "object",
"description": "The metadata required by this integration in order to create a flag link, if this is a flag link for an existing integration. Defined in the integration's <code>manifest.json</code> file under <code>flagLink</code>.",
"additionalProperties": {
"type": "string"
}
},
"_createdAt": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when the flag link was created"
},
"_timestamp": {
"$ref": "#/components/schemas/TimestampRep",
"example": "{\"milliseconds\": 1655342199935, \"seconds\": 1655342199, \"rfc3339\": \"2022-06-16T01:16:39Z\", \"simple\": \"2022-06-16 01:16:39\"}",
"description": "The time to mark this flag link as associated with the external URL. Defaults to the creation time of the flag link, but can be set to another time during creation."
},
"description": {
"type": "string",
"example": "Example link description",
"description": "The description of the flag link"
},
"_integrationKey": {
"type": "string",
"description": "The integration key for an integration whose <code>manifest.json</code> includes the <code>flagLink</code> capability, if this is a flag link for an existing integration"
}
}
}
FlagListingRep
{
"type": "object",
"required": [
"name",
"key"
],
"properties": {
"key": {
"type": "string",
"example": "flag-key-123abc",
"description": "The flag key"
},
"name": {
"type": "string",
"example": "Example flag",
"description": "The flag name"
},
"_site": {
"$ref": "#/components/schemas/Link"
},
"_links": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
FlagMigrationSettingsRep
{
"type": "object",
"properties": {
"stageCount": {
"type": "integer",
"example": 6,
"description": "The number of stages for this migration flag"
},
"contextKind": {
"type": "string",
"example": "device",
"description": "The context kind targeted by this migration flag. Only applicable for six-stage migrations."
}
}
}
FlagReferenceCollectionRep
{
"type": "object",
"required": [
"totalCount",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagReferenceRep"
},
"description": "A list of flag references"
},
"totalCount": {
"type": "integer",
"example": 25,
"description": "The total number of flag references"
}
}
}
FlagReferenceRep
{
"type": "object",
"required": [
"projectKey",
"flagKey",
"referencesAdded",
"referencesRemoved"
],
"properties": {
"flagKey": {
"type": "string",
"example": "enable-new-payment-structure",
"description": "The flag key"
},
"projectKey": {
"type": "string",
"example": "default",
"description": "The project key"
},
"referencesAdded": {
"type": "integer",
"example": 2,
"description": "The number of references added"
},
"referencesRemoved": {
"type": "integer",
"example": 5,
"description": "The number of references removed"
}
}
}
FlagRep
{
"type": "object",
"required": [
"_links"
],
"properties": {
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/flags/my-project/my-flag",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"targetingRule": {
"type": "string",
"example": "fallthrough",
"description": "The targeting rule"
},
"flagConfigVersion": {
"type": "integer",
"example": 12,
"description": "The flag version"
},
"targetingRuleClauses": {
"type": "array",
"items": {},
"description": "An array of clauses used for individual targeting based on attributes"
},
"targetingRuleDescription": {
"type": "string",
"example": "Customers who live in Canada",
"description": "The rule description"
}
}
}
FlagScheduledChangesInput
{
"type": "object",
"required": [
"instructions"
],
"properties": {
"comment": {
"type": "string",
"example": "optional comment",
"description": "Optional comment describing the update to the scheduled changes"
},
"instructions": {
"$ref": "#/components/schemas/Instructions",
"example": "[ { \"kind\": \"replaceScheduledChangesInstructions\", \"value\": [ { \"kind\": \"turnFlagOff\" } ] } ]",
"description": "The instructions to perform when updating. This should be an array with objects that look like <code>{\"kind\": \"update_action\"}</code>. Some instructions also require a <code>value</code> field in the array element."
}
}
}
FlagStatusRep
{
"type": "object",
"required": [
"_links"
],
"properties": {
"name": {
"type": "string",
"example": "inactive",
"description": "Status of the flag"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/flag-statuses/my-project/my-flag",
"type": "application/json"
},
"parent": {
"href": "/api/v2/flags/my-project/my-flag",
"type": "application/json"
}
},
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"default": {
"description": "Default value seen from code"
},
"lastRequested": {
"type": "string",
"format": "date-time",
"example": "2020-02-05T18:17:01.514Z",
"description": "Timestamp of last time flag was requested"
}
}
}
FlagSummary
{
"type": "object",
"required": [
"variations",
"prerequisites"
],
"properties": {
"variations": {
"$ref": "#/components/schemas/AllVariationsSummary",
"description": "A summary of the variations for this flag"
},
"prerequisites": {
"type": "integer",
"description": "The number of prerequisites for this flag"
}
}
}
FlagTriggerInput
{
"type": "object",
"properties": {
"comment": {
"type": "string",
"example": "optional comment",
"description": "Optional comment describing the update"
},
"instructions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Instruction"
},
"example": [
{
"kind": "disableTrigger"
}
],
"description": "The instructions to perform when updating. This should be an array with objects that look like <code>{\"kind\": \"trigger_action\"}</code>."
}
}
}
FlagsInput
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/FlagInput"
}
}
FollowFlagMember
{
"type": "object",
"required": [
"_links",
"_id",
"role",
"email"
],
"properties": {
"_id": {
"type": "string",
"example": "569f183514f4432160000007",
"description": "The member's ID"
},
"role": {
"type": "string",
"example": "admin",
"description": "The member's built-in role. If the member has no custom roles, this role will be in effect."
},
"email": {
"type": "string",
"example": "ariel@acme.com",
"description": "The member's email address"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/members/569f183514f4432160000007",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"lastName": {
"type": "string",
"example": "Flores",
"description": "The member's last name"
},
"firstName": {
"type": "string",
"example": "Ariel",
"description": "The member's first name"
}
}
}
ForbiddenErrorRep
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"example": "forbidden",
"description": "Specific error code encountered"
},
"message": {
"type": "string",
"example": "Forbidden. Access to the requested resource was denied.",
"description": "Description of the error"
}
}
}
FormVariableConfig
{
"type": "object",
"additionalProperties": {}
}
HunkRep
{
"type": "object",
"required": [
"startingLineNumber"
],
"properties": {
"lines": {
"type": "string",
"example": "var enableFeature = 'enable-feature';",
"description": "Contextual lines of code that include the referenced feature flag"
},
"aliases": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"enableFeature",
"EnableFeature"
],
"description": "An array of flag key aliases"
},
"flagKey": {
"type": "string",
"example": "enable-feature",
"description": "The feature flag key"
},
"projKey": {
"type": "string",
"example": "default",
"description": "The project key"
},
"startingLineNumber": {
"type": "integer",
"example": 45,
"description": "Line number of beginning of code reference hunk"
}
}
}
ImpactReason
{
"type": "string"
}
Import
{
"type": "object",
"required": [
"id",
"segmentKey",
"creationTime",
"mode",
"status",
"_links"
],
"properties": {
"id": {
"type": "string",
"example": "1234a567-bcd8-9123-4567-abcd1234567f",
"description": "The import ID"
},
"mode": {
"type": "string",
"example": "replace",
"description": "The import mode used, either <code>merge</code> or <code>replace</code>"
},
"files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileRep"
},
"example": [
{
"status": "complete",
"filename": "bigsegimport.csv"
}
],
"description": "The imported files and their status"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"status": {
"type": "string",
"example": "complete",
"description": "The import status"
},
"segmentKey": {
"type": "string",
"example": "example-big-segment",
"description": "The segment key"
},
"creationTime": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when this import was created"
}
}
}
InitiatorRep
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Bob Loblaw",
"description": "The name of the member who initiated the export"
},
"email": {
"type": "string",
"example": "ariel@acme.com",
"description": "The email address of the member who initiated the export"
}
}
}
InsightGroup
{
"type": "object",
"required": [
"key",
"name",
"projectKey",
"environmentKey",
"createdAt"
],
"properties": {
"key": {
"type": "string",
"example": "default-production-all-apps",
"description": "The insight group key"
},
"name": {
"type": "string",
"example": "Production - All Apps",
"description": "The insight group name"
},
"scores": {
"$ref": "#/components/schemas/InsightGroupScores",
"description": "The scores for the insight group"
},
"createdAt": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1706701522000",
"description": "The time the insight group was created"
},
"projectKey": {
"type": "string",
"example": "default",
"description": "The project key"
},
"environment": {
"$ref": "#/components/schemas/Environment",
"description": "Expanded details about the environment"
},
"scoreMetadata": {
"$ref": "#/components/schemas/InsightGroupCollectionScoreMetadata",
"description": "Metadata about the insight scores, when expanded"
},
"environmentKey": {
"type": "string",
"example": "production",
"description": "The environment key"
},
"applicationKeys": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"billing-service",
"inventory-service"
],
"description": "The application keys"
}
}
}
InsightGroupCollection
{
"type": "object",
"required": [
"totalCount",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InsightGroup"
},
"description": "A list of insight groups"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"metadata": {
"$ref": "#/components/schemas/InsightGroupCollectionMetadata",
"description": "Metadata about the insight groups"
},
"totalCount": {
"type": "integer",
"example": 15,
"description": "The total number of insight groups"
},
"scoreMetadata": {
"$ref": "#/components/schemas/InsightGroupCollectionScoreMetadata",
"description": "Metadata about the insight scores, when expanded"
}
}
}
InsightGroupCollectionMetadata
{
"type": "object",
"required": [
"countByIndicator"
],
"properties": {
"countByIndicator": {
"$ref": "#/components/schemas/InsightGroupsCountByIndicator"
}
}
}
InsightGroupCollectionScoreMetadata
{
"type": "object",
"required": [
"period",
"lastPeriod"
],
"properties": {
"period": {
"$ref": "#/components/schemas/InsightPeriod",
"description": "The time period for the score calculations"
},
"lastPeriod": {
"$ref": "#/components/schemas/InsightPeriod",
"description": "The time period for the score calculations in the last period"
}
}
}
InsightGroupScores
{
"type": "object",
"required": [
"overall",
"deploymentFrequency",
"deploymentFailureRate",
"leadTime",
"impactSize",
"experimentationCoverage",
"flagHealth",
"velocity",
"risk",
"efficiency"
],
"properties": {
"risk": {
"$ref": "#/components/schemas/InsightsMetricScore",
"description": "The risk score for the insight group"
},
"overall": {
"$ref": "#/components/schemas/InsightsMetricScore",
"description": "The overall score for the insight group"
},
"leadTime": {
"$ref": "#/components/schemas/InsightsMetricScore",
"description": "The lead time score for the insight group"
},
"velocity": {
"$ref": "#/components/schemas/InsightsMetricScore",
"description": "The velocity score for the insight group"
},
"efficiency": {
"$ref": "#/components/schemas/InsightsMetricScore",
"description": "The efficiency score for the insight group"
},
"flagHealth": {
"$ref": "#/components/schemas/InsightsMetricScore",
"description": "The flag health score for the insight group"
},
"impactSize": {
"$ref": "#/components/schemas/InsightsMetricScore",
"description": "The impact size score for the insight group"
},
"creationRatio": {
"$ref": "#/components/schemas/InsightsMetricScore",
"description": "The creation ratio score for the insight group"
},
"deploymentFrequency": {
"$ref": "#/components/schemas/InsightsMetricScore",
"description": "The deployment frequency score for the insight group"
},
"deploymentFailureRate": {
"$ref": "#/components/schemas/InsightsMetricScore",
"description": "The deployment failure rate score for the insight group"
},
"experimentationCoverage": {
"$ref": "#/components/schemas/InsightsMetricScore",
"description": "The Experimentation coverage score for the insight group"
}
}
}
InsightGroupsCountByIndicator
{
"type": "object",
"required": [
"excellent",
"good",
"fair",
"needsAttention",
"notCalculated",
"unknown",
"total"
],
"properties": {
"fair": {
"type": "integer",
"example": 1,
"description": "The number of insight groups with a fair indicator"
},
"good": {
"type": "integer",
"example": 1,
"description": "The number of insight groups with a good indicator"
},
"total": {
"type": "integer",
"example": 6,
"description": "The total number of insight groups"
},
"unknown": {
"type": "integer",
"example": 1,
"description": "The number of insight groups with an unknown indicator"
},
"excellent": {
"type": "integer",
"example": 1,
"description": "The number of insight groups with an excellent indicator"
},
"notCalculated": {
"type": "integer",
"example": 1,
"description": "The number of insight groups with a not calculated indicator"
},
"needsAttention": {
"type": "integer",
"example": 1,
"description": "The number of insight groups with a needs attention indicator"
}
}
}
InsightPeriod
{
"type": "object",
"required": [
"startTime",
"endTime"
],
"properties": {
"endTime": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1706701522000",
"description": "The end time of the period"
},
"startTime": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1706701522000",
"description": "The start time of the period"
}
}
}
InsightScores
{
"type": "object",
"required": [
"period",
"lastPeriod",
"scores"
],
"properties": {
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"period": {
"$ref": "#/components/schemas/InsightPeriod",
"description": "The time period for the scores"
},
"scores": {
"$ref": "#/components/schemas/InsightGroupScores",
"description": "The scores for the insight groups"
},
"lastPeriod": {
"$ref": "#/components/schemas/InsightPeriod",
"description": "The time period for the scores in the last period"
}
}
}
InsightsChart
{
"type": "object",
"required": [
"metadata",
"series"
],
"properties": {
"series": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InsightsChartSeries"
},
"description": "Series data for the chart"
},
"metadata": {
"$ref": "#/components/schemas/InsightsChartMetadata",
"description": "Metadata for the chart"
}
}
}
InsightsChartBounds
{
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"example": "equal",
"description": "Name of the bound"
},
"value": {
"type": "integer",
"format": "int64",
"example": 100,
"description": "Value of the bound"
}
}
}
InsightsChartMetadata
{
"type": "object",
"required": [
"summary",
"xAxis",
"yAxis"
],
"properties": {
"name": {
"type": "string",
"example": "deploymentFrequency",
"description": "Name of the chart"
},
"xAxis": {
"$ref": "#/components/schemas/InsightsChartSeriesMetadataAxis",
"example": "timestamp",
"description": "X-axis metadata"
},
"yAxis": {
"$ref": "#/components/schemas/InsightsChartSeriesMetadataAxis",
"example": "count",
"description": "Y-axis metadata"
},
"metrics": {
"$ref": "#/components/schemas/InsightsChartMetrics",
"description": "Metrics for the given chart data, included when expanded"
},
"summary": {
"$ref": "#/components/schemas/InsightsChartMetadataCustomValues",
"description": "Metadata values"
}
}
}
InsightsChartMetadataCustomValues
{
"type": "object",
"additionalProperties": {}
}
InsightsChartMetric
{
"type": "object",
"required": [
"indicator",
"value",
"unit",
"modifier",
"tiers"
],
"properties": {
"unit": {
"type": "string",
"example": "count",
"description": "Metric unit"
},
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InsightsMetricTierDefinition"
},
"description": "Metric indicator tiers"
},
"value": {
"type": "number",
"example": 5,
"description": "Metric value"
},
"modifier": {
"type": "string",
"example": "per day",
"description": "Metric modifier"
},
"indicator": {
"type": "string",
"example": "excellent",
"description": "Metric indicator tier"
}
}
}
InsightsChartMetrics
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/InsightsChartMetric"
}
}
InsightsChartSeries
{
"type": "object",
"required": [
"metadata",
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InsightsChartSeriesDataPoint"
},
"description": "Data points for the series"
},
"metadata": {
"$ref": "#/components/schemas/InsightsChartSeriesMetadata",
"description": "Metadata for the series"
}
}
}
InsightsChartSeriesDataPoint
{
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"type": "integer",
"format": "int64",
"example": 1617225600000,
"description": "X-axis value"
},
"y": {
"type": "integer",
"format": "int64",
"example": 100,
"description": "Y-axis value"
},
"values": {
"type": "object",
"description": "Additional values for the data point",
"additionalProperties": {}
}
}
}
InsightsChartSeriesMetadata
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the series"
},
"count": {
"type": "integer",
"format": "int64",
"description": "Aggregate count of the series values"
},
"bounds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InsightsChartBounds"
},
"description": "Bounds for the series data"
}
}
}
InsightsChartSeriesMetadataAxis
{
"type": "object",
"required": [
"unit"
],
"properties": {
"unit": {
"type": "string",
"example": "count",
"description": "Unit of the axis"
}
}
}
InsightsMetricIndicatorRange
{
"type": "object",
"required": [
"min",
"max"
],
"properties": {
"max": {
"type": "integer",
"example": 100,
"description": "The maximum value for the indicator range"
},
"min": {
"type": "integer",
"example": 0,
"description": "The minimum value for the indicator range"
}
}
}
InsightsMetricScore
{
"type": "object",
"required": [
"score",
"indicator",
"indicatorRange"
],
"properties": {
"score": {
"type": "integer",
"example": 100,
"description": "The score for the metric"
},
"indicator": {
"$ref": "#/components/schemas/InsightsMetricScoreIndicator",
"enum": [
"excellent",
"good",
"fair",
"needsAttention",
"notCalculated",
"unknown"
],
"example": "excellent",
"description": "The indicator for the score"
},
"lastPeriod": {
"$ref": "#/components/schemas/InsightsMetricScore",
"description": "The score for the metric in the last period"
},
"aggregateOf": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"deploymentFrequency",
"leadTime"
],
"description": "The keys of the metrics that were aggregated to calculate this score"
},
"indicatorRange": {
"$ref": "#/components/schemas/InsightsMetricIndicatorRange",
"description": "The indicator range for the score"
},
"diffVsLastPeriod": {
"type": "integer"
}
}
}
InsightsMetricScoreIndicator
{
"type": "string"
}
InsightsMetricTierDefinition
{
"type": "object",
"required": [
"indicator",
"description"
],
"properties": {
"indicator": {
"type": "string",
"example": "excellent",
"description": "Metric indicator tier"
},
"description": {
"type": "string",
"example": "at least 1 per day",
"description": "Metric indicator description"
}
}
}
InsightsRepository
{
"type": "object",
"required": [
"_id",
"version",
"key",
"type",
"url",
"mainBranch"
],
"properties": {
"_id": {
"type": "string",
"format": "uuid",
"example": "5f9a9b1a-5b9a-4b9a-9a9a-9a9a9a9a9a9a",
"description": "The repository ID"
},
"key": {
"type": "string",
"example": "launchdarkly/LaunchDarkly-Docs",
"description": "The repository key"
},
"url": {
"type": "string",
"example": "https://github.com/launchdarkly/LaunchDarkly-Docs",
"description": "The repository URL"
},
"type": {
"type": "string",
"example": "github",
"description": "The repository type"
},
"version": {
"type": "integer",
"example": 1,
"description": "The repository version"
},
"projects": {
"$ref": "#/components/schemas/ProjectSummaryCollection"
},
"mainBranch": {
"type": "string",
"example": "main",
"description": "The repository main branch"
}
}
}
InsightsRepositoryCollection
{
"type": "object",
"required": [
"totalCount",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InsightsRepository"
},
"description": "List of repositories"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"example": 1,
"description": "Total number of repositories"
}
}
}
InsightsRepositoryProject
{
"type": "object",
"required": [
"repositoryKey",
"projectKey"
],
"properties": {
"projectKey": {
"type": "string",
"example": "default",
"description": "The project key"
},
"repositoryKey": {
"type": "string",
"example": "launchdarkly/LaunchDarkly-Docs",
"description": "The repository key"
}
}
}
InsightsRepositoryProjectCollection
{
"type": "object",
"required": [
"totalCount",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InsightsRepositoryProject"
},
"description": "List of repository project associations"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"example": 1,
"description": "Total number of repository project associations"
}
}
}
InsightsRepositoryProjectMappings
{
"type": "object",
"required": [
"mappings"
],
"properties": {
"mappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InsightsRepositoryProject"
}
}
}
}
Instruction
{
"type": "object",
"additionalProperties": {}
}
Instructions
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Instruction"
}
}
Integration
{
"type": "object",
"properties": {
"on": {
"type": "boolean",
"example": true,
"description": "Whether the integration is currently active"
},
"_id": {
"type": "string",
"example": "1234a56b7c89d012345e678f",
"description": "The ID for this integration audit log subscription"
},
"url": {
"type": "string",
"description": "Slack webhook receiver URL. Only used for legacy Slack webhook integrations."
},
"kind": {
"type": "string",
"example": "datadog",
"description": "The type of integration"
},
"name": {
"type": "string",
"example": "Example Datadog integration",
"description": "A human-friendly name for the integration"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"testing"
],
"description": "An array of tags for this integration"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"apiKey": {
"type": "string",
"description": "Datadog API key. Only used for legacy Datadog webhook integrations."
},
"config": {
"type": "object",
"description": "Details on configuration for an integration of this type. Refer to the <code>formVariables</code> field in the corresponding <code>manifest.json</code> for a full list of fields for each integration.",
"additionalProperties": {}
},
"_access": {
"$ref": "#/components/schemas/Access",
"description": "Details on the allowed and denied actions for this subscription"
},
"_status": {
"$ref": "#/components/schemas/IntegrationSubscriptionStatusRep",
"description": "Details on the most recent successes and errors for this integration"
},
"statements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Statement"
},
"description": "Represents a Custom role policy, defining a resource kinds filter the integration audit log subscription responds to."
}
}
}
IntegrationDeliveryConfiguration
{
"type": "object",
"required": [
"_links",
"_id",
"integrationKey",
"projectKey",
"environmentKey",
"config",
"on",
"tags",
"name",
"version"
],
"properties": {
"on": {
"type": "boolean",
"example": true,
"description": "Whether the configuration is turned on"
},
"_id": {
"type": "string",
"example": "12ab3c4d5ef1a2345bcde67f",
"description": "The integration ID"
},
"name": {
"type": "string",
"example": "Development environment configuration",
"description": "Name of the configuration"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [],
"description": "List of tags for this configuration"
},
"_links": {
"$ref": "#/components/schemas/IntegrationDeliveryConfigurationLinks",
"description": "The location and content type of related resources"
},
"config": {
"$ref": "#/components/schemas/FormVariableConfig",
"description": "The delivery configuration for the given integration provider. Only included when requesting a single integration by ID. Refer to the <code>formVariables</code> field in the corresponding <code>manifest.json</code> for a full list of fields for each integration."
},
"_access": {
"$ref": "#/components/schemas/Access",
"description": "Details on the allowed and denied actions for this configuration"
},
"version": {
"type": "integer",
"example": 1,
"description": "Version of the current configuration"
},
"projectKey": {
"type": "string",
"example": "default",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"example": "development",
"description": "The environment key"
},
"integrationKey": {
"type": "string",
"example": "example-integration-key",
"description": "The integration key"
}
}
}
IntegrationDeliveryConfigurationCollection
{
"type": "object",
"required": [
"_links",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationDeliveryConfiguration"
},
"description": "An array of integration delivery configurations"
},
"_links": {
"$ref": "#/components/schemas/IntegrationDeliveryConfigurationCollectionLinks",
"description": "The location and content type of related resources"
}
}
}
IntegrationDeliveryConfigurationCollectionLinks
{
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"$ref": "#/components/schemas/Link"
},
"parent": {
"$ref": "#/components/schemas/Link"
}
}
}
IntegrationDeliveryConfigurationLinks
{
"type": "object",
"required": [
"self",
"parent",
"project",
"environment"
],
"properties": {
"self": {
"$ref": "#/components/schemas/Link"
},
"parent": {
"$ref": "#/components/schemas/Link"
},
"project": {
"$ref": "#/components/schemas/Link"
},
"environment": {
"$ref": "#/components/schemas/Link"
}
}
}
IntegrationDeliveryConfigurationPost
{
"type": "object",
"required": [
"config"
],
"properties": {
"on": {
"type": "boolean",
"example": false,
"description": "Whether the integration configuration is active. Default value is false."
},
"name": {
"type": "string",
"example": "Sample integration",
"description": "Name to identify the integration"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"example-tag"
],
"description": "Tags to associate with the integration"
},
"config": {
"$ref": "#/components/schemas/FormVariableConfig",
"example": "{\"required\": \"example value for required formVariables property for sample-integration\", \"optional\": \"example value for optional formVariables property for sample-integration\"}",
"description": "The global integration settings, as specified by the <code>formVariables</code> in the <code>manifest.json</code> for this integration."
}
}
}
IntegrationDeliveryConfigurationResponse
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"timestamp": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when the validation was performed"
},
"statusCode": {
"type": "integer",
"example": 200,
"description": "The status code returned by the validation"
},
"responseBody": {
"type": "string",
"description": "JSON response to the validation request"
}
}
}
IntegrationMetadata
{
"type": "object",
"required": [
"externalId",
"externalStatus",
"externalUrl",
"lastChecked"
],
"properties": {
"externalId": {
"type": "string"
},
"externalUrl": {
"type": "string"
},
"lastChecked": {
"$ref": "#/components/schemas/UnixMillis"
},
"externalStatus": {
"$ref": "#/components/schemas/IntegrationStatus"
}
}
}
IntegrationStatus
{
"type": "object",
"required": [
"display",
"value"
],
"properties": {
"value": {
"type": "string"
},
"display": {
"type": "string"
}
}
}
IntegrationStatusRep
{
"type": "object",
"properties": {
"timestamp": {
"$ref": "#/components/schemas/UnixMillis"
},
"statusCode": {
"type": "integer"
},
"responseBody": {
"type": "string"
}
}
}
IntegrationSubscriptionStatusRep
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationStatusRep"
}
},
"lastError": {
"$ref": "#/components/schemas/UnixMillis"
},
"errorCount": {
"type": "integer"
},
"lastSuccess": {
"$ref": "#/components/schemas/UnixMillis"
},
"successCount": {
"type": "integer"
}
}
}
Integrations
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Integration"
}
},
"_links": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
InvalidRequestErrorRep
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"example": "invalid_request",
"description": "Specific error code encountered"
},
"message": {
"type": "string",
"example": "Invalid request body",
"description": "Description of the error"
}
}
}
IterationInput
{
"type": "object",
"required": [
"hypothesis",
"metrics",
"treatments",
"flags"
],
"properties": {
"flags": {
"$ref": "#/components/schemas/FlagsInput",
"description": "Details on the feature flag and targeting rules for this iteration"
},
"metrics": {
"$ref": "#/components/schemas/MetricsInput",
"description": "Details on the metrics for this experiment"
},
"hypothesis": {
"type": "string",
"example": "Example hypothesis, the new button placement will increase conversion",
"description": "The expected outcome of this experiment"
},
"treatments": {
"$ref": "#/components/schemas/TreatmentsInput",
"description": "Details on the variations you are testing in the experiment. You establish these variations in feature flags, and then reuse them in experiments."
},
"primaryFunnelKey": {
"type": "string",
"example": "metric-group-key-123abc",
"description": "The key of the primary funnel group for this experiment. Either <code>primarySingleMetricKey</code> or <code>primaryFunnelKey</code> must be present."
},
"randomizationUnit": {
"type": "string",
"example": "user",
"description": "The unit of randomization for this iteration. Defaults to user."
},
"canReshuffleTraffic": {
"type": "boolean",
"example": true,
"description": "Whether to allow the experiment to reassign traffic to different variations when you increase or decrease the traffic in your experiment audience (true) or keep all traffic assigned to its initial variation (false). Defaults to true."
},
"primarySingleMetricKey": {
"type": "string",
"example": "metric-key-123abc",
"description": "The key of the primary metric for this experiment. Either <code>primarySingleMetricKey</code> or <code>primaryFunnelKey</code> must be present."
}
}
}
IterationRep
{
"type": "object",
"required": [
"hypothesis",
"status",
"createdAt"
],
"properties": {
"_id": {
"type": "string",
"example": "12ab3c45de678910fgh12345",
"description": "The iteration ID"
},
"flags": {
"type": "object",
"description": "Details on the flag used in this experiment",
"additionalProperties": {
"$ref": "#/components/schemas/FlagRep"
}
},
"status": {
"type": "string",
"example": "running",
"description": "The status of the iteration: <code>not_started</code>, <code>running</code>, <code>stopped</code>"
},
"endedAt": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1656610200000",
"description": "Timestamp of when the iteration ended"
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DependentMetricOrMetricGroupRep"
},
"description": "Details on the metrics for this experiment"
},
"createdAt": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when the iteration was created"
},
"startedAt": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1655314200000",
"description": "Timestamp of when the iteration started"
},
"hypothesis": {
"type": "string",
"example": "The new button placement will increase conversion",
"description": "The expected outcome of this experiment"
},
"treatments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TreatmentRep"
},
"description": "Details on the variations you are testing in the experiment"
},
"primaryFunnel": {
"$ref": "#/components/schemas/DependentMetricGroupRepWithMetrics",
"description": "Details on the primary funnel group for this experiment"
},
"primaryMetric": {
"$ref": "#/components/schemas/DependentMetricOrMetricGroupRep",
"deprecated": true,
"description": "Deprecated, use <code>primarySingleMetric</code> and <code>primaryFunnel</code> instead. Details on the primary metric for this experiment."
},
"winningReason": {
"type": "string",
"example": "We ran this iteration for two weeks and the winning variation was clear",
"description": "The reason you stopped the experiment"
},
"secondaryMetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricV2Rep"
},
"deprecated": true,
"description": "Deprecated, use <code>metrics</code> instead. Details on the secondary metrics for this experiment."
},
"randomizationUnit": {
"type": "string",
"example": "user",
"description": "The unit of randomization for this iteration"
},
"winningTreatmentId": {
"type": "string",
"example": "122c9f3e-da26-4321-ba68-e0fc02eced58",
"description": "The ID of the treatment chosen when the experiment stopped"
},
"canReshuffleTraffic": {
"type": "boolean",
"example": true,
"description": "Whether the experiment may reassign traffic to different variations when the experiment audience changes (true) or must keep all traffic assigned to its initial variation (false)."
},
"primarySingleMetric": {
"$ref": "#/components/schemas/MetricV2Rep",
"description": "Details on the primary metric for this experiment"
}
}
}
IterationStatus
{
"type": "string"
}
JSONPatch
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PatchOperation"
}
}
LastSeenMetadata
{
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"example": "5b52207f8ca8e631d31fdb2b",
"description": "The ID of the token used in the member's last session"
}
}
}
LeadTimeStagesRep
{
"type": "object",
"required": [
"codingDurationMs"
],
"properties": {
"waitDurationMs": {
"type": "integer",
"format": "int64",
"example": 100000,
"description": "The wait duration between merge time and deploy start time in milliseconds"
},
"totalLeadTimeMs": {
"type": "integer",
"format": "int64",
"example": 1600000,
"description": "The total lead time in milliseconds"
},
"codingDurationMs": {
"type": "integer",
"format": "int64",
"example": 1000000,
"description": "The coding duration in milliseconds"
},
"deployDurationMs": {
"type": "integer",
"format": "int64",
"example": 100000,
"description": "The deploy duration in milliseconds"
},
"reviewDurationMs": {
"type": "integer",
"format": "int64",
"example": 500000,
"description": "The review duration in milliseconds"
}
}
}
LegacyExperimentRep
{
"type": "object",
"properties": {
"_metric": {
"$ref": "#/components/schemas/MetricListingRep"
},
"metricKey": {
"type": "string",
"example": "my-metric"
},
"environments": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"production",
"test",
"my-environment"
]
},
"_environmentSettings": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ExperimentEnvironmentSettingRep"
}
}
}
}
Link
{
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
MaintainerRep
{
"type": "object",
"properties": {
"team": {
"$ref": "#/components/schemas/MemberTeamSummaryRep",
"description": "Details on the team that maintains this resource"
},
"member": {
"$ref": "#/components/schemas/MemberSummary",
"description": "Details on the member who maintains this resource"
}
}
}
MaintainerTeam
{
"type": "object",
"required": [
"key",
"name"
],
"properties": {
"key": {
"type": "string",
"example": "team-key-123abc",
"description": "The key of the maintainer team"
},
"name": {
"type": "string",
"example": "Example team",
"description": "A human-friendly name for the maintainer team"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/teams/example-team",
"type": "application/json"
},
"roles": {
"href": "/api/v2/teams/example-team/roles",
"type": "application/json"
},
"parent": {
"href": "/api/v2/teams",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
Member
{
"type": "object",
"required": [
"_links",
"_id",
"role",
"email",
"_pendingInvite",
"_verified",
"customRoles",
"mfa",
"_lastSeen",
"creationDate"
],
"properties": {
"_id": {
"type": "string",
"example": "507f1f77bcf86cd799439011",
"description": "The member's ID"
},
"mfa": {
"type": "string",
"description": "Whether multi-factor authentication is enabled for this member"
},
"role": {
"type": "string",
"example": "reader",
"description": "The member's built-in role. If the member has no custom roles, this role will be in effect."
},
"email": {
"type": "string",
"example": "ariel@acme.com",
"description": "The member's email address"
},
"teams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberTeamSummaryRep"
},
"description": "Details on the teams this member is assigned to"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"lastName": {
"type": "string",
"example": "Flores",
"description": "The member's last name"
},
"_lastSeen": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1608260796147",
"description": "The member's last session date (as Unix milliseconds since epoch)"
},
"_verified": {
"type": "boolean",
"example": true,
"description": "Whether the member's email address has been verified"
},
"firstName": {
"type": "string",
"example": "Ariel",
"description": "The member's first name"
},
"customRoles": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"devOps",
"backend-devs"
],
"description": "The set of custom roles (as keys) assigned to the member"
},
"creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1628001602644",
"description": "Timestamp of when the member was created"
},
"_pendingEmail": {
"type": "string",
"description": "The member's email address before it has been verified, for accounts where email verification is required"
},
"_pendingInvite": {
"type": "boolean",
"example": false,
"description": "Whether the member has a pending invitation"
},
"oauthProviders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuthProviderKind"
},
"description": "A list of OAuth providers"
},
"permissionGrants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberPermissionGrantSummaryRep"
},
"description": "A list of permission grants. Permission grants allow a member to have access to a specific action, without having to create or update a custom role."
},
"_lastSeenMetadata": {
"$ref": "#/components/schemas/LastSeenMetadata",
"description": "Additional metadata associated with the member's last session, for example, whether a token was used"
},
"excludedDashboards": {
"type": "array",
"items": {
"type": "string"
},
"description": "Default dashboards that the member has chosen to ignore"
},
"_integrationMetadata": {
"$ref": "#/components/schemas/IntegrationMetadata",
"description": "Details on the member account in an external source, if this member is provisioned externally"
}
}
}
MemberDataRep
{
"type": "object",
"properties": {
"_id": {
"type": "string",
"example": "507f1f77bcf86cd799439011",
"description": "The member ID"
},
"email": {
"type": "string",
"example": "ariel@acme.com",
"description": "The member email"
},
"_links": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"lastName": {
"type": "string",
"example": "Flores",
"description": "The member last name"
},
"firstName": {
"type": "string",
"example": "Ariel",
"description": "The member first name"
}
}
}
MemberImportItem
{
"type": "object",
"required": [
"status",
"value"
],
"properties": {
"value": {
"type": "string",
"example": "new-team-member@acme.com",
"description": "The email address for the member requested to be added to this team. May be blank or an error, such as 'invalid email format', if the email address cannot be found or parsed."
},
"status": {
"type": "string",
"example": "error",
"description": "Whether this member can be successfully imported (<code>success</code>) or not (<code>error</code>). Even if the status is <code>success</code>, members are only added to a team on a <code>201</code> response."
},
"message": {
"type": "string",
"description": "An error message, including CSV line number, if the <code>status</code> is <code>error</code>"
}
}
}
MemberPermissionGrantSummaryRep
{
"type": "object",
"required": [
"resource"
],
"properties": {
"actions": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"maintainTeam"
],
"description": "A list of actions to allow. A permission grant may have either an <code>actionSet</code> or a list of <code>actions</code> but not both at the same time."
},
"resource": {
"type": "string",
"example": "team/qa-team",
"description": "The resource for which the actions are allowed"
},
"actionSet": {
"type": "string",
"description": "The name of the group of related actions to allow. A permission grant may have either an <code>actionSet</code> or a list of <code>actions</code> but not both at the same time."
}
}
}
MemberSummary
{
"type": "object",
"required": [
"_links",
"_id",
"role",
"email"
],
"properties": {
"_id": {
"type": "string",
"example": "569f183514f4432160000007",
"description": "The member's ID"
},
"role": {
"type": "string",
"example": "admin",
"description": "The member's built-in role. If the member has no custom roles, this role will be in effect."
},
"email": {
"type": "string",
"example": "ariel@acme.com",
"description": "The member's email address"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/members/569f183514f4432160000007",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"lastName": {
"type": "string",
"example": "Flores",
"description": "The member's last name"
},
"firstName": {
"type": "string",
"example": "Ariel",
"description": "The member's first name"
}
}
}
MemberTeamSummaryRep
{
"type": "object",
"required": [
"customRoleKeys",
"key",
"name"
],
"properties": {
"key": {
"type": "string",
"example": "team-key-123abc",
"description": "The team key"
},
"name": {
"type": "string",
"example": "QA Team",
"description": "The team name"
},
"_links": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"customRoleKeys": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"access-to-test-projects"
],
"description": "A list of keys of the custom roles this team has access to"
}
}
}
MemberTeamsPostInput
{
"type": "object",
"required": [
"teamKeys"
],
"properties": {
"teamKeys": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"team1",
"team2"
],
"description": "List of team keys"
}
}
}
Members
{
"type": "object",
"required": [
"items",
"_links"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
},
"description": "An array of members"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"description": "The number of members returned"
}
}
}
MethodNotAllowedErrorRep
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"example": "method_not_allowed",
"description": "Specific error code encountered"
},
"message": {
"type": "string",
"example": "Method not allowed",
"description": "Description of the error"
}
}
}
MetricCollectionRep
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricListingRep"
},
"description": "An array of metrics"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/metrics/my-project?limit=20",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
MetricEventDefaultRep
{
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "The default value applied to missing unit events. Only available when <code>disabled</code> is false. Defaults to 0"
},
"disabled": {
"type": "boolean",
"description": "Whether to disable defaulting missing unit events when calculating results. Defaults to false"
}
}
}
MetricGroupCollectionRep
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricGroupRep"
},
"description": "An array of metric groups"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/projects/my-project/metric-groups",
"type": "application/json"
},
"parent": {
"href": "/api/v2/projects/my-project",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
MetricGroupPost
{
"type": "object",
"required": [
"key",
"name",
"kind",
"maintainerId",
"tags",
"metrics"
],
"properties": {
"key": {
"type": "string",
"example": "metric-group-key-123abc",
"description": "A unique key to reference the metric group"
},
"kind": {
"enum": [
"funnel"
],
"type": "string",
"example": "funnel",
"description": "The type of the metric group"
},
"name": {
"type": "string",
"example": "My metric group",
"description": "A human-friendly name for the metric group"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"ops"
],
"description": "Tags for the metric group"
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricInMetricGroupInput"
},
"description": "An ordered list of the metrics in this metric group"
},
"description": {
"type": "string",
"example": "Description of the metric group",
"description": "Description of the metric group"
},
"maintainerId": {
"type": "string",
"example": "569fdeadbeef1644facecafe",
"description": "The ID of the member who maintains this metric group"
}
}
}
MetricGroupRep
{
"type": "object",
"required": [
"_id",
"key",
"name",
"kind",
"_links",
"tags",
"_creationDate",
"_lastModified",
"maintainer",
"metrics",
"_version"
],
"properties": {
"_id": {
"type": "string",
"example": "bc3e5be1-02d2-40c7-9926-26d0aacd7aab",
"description": "The ID of this metric group"
},
"key": {
"type": "string",
"example": "metric-group-key-123abc",
"description": "A unique key to reference the metric group"
},
"kind": {
"enum": [
"funnel",
"standard"
],
"type": "string",
"example": "funnel",
"description": "The type of the metric group"
},
"name": {
"type": "string",
"example": "My metric group",
"description": "A human-friendly name for the metric group"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"ops"
],
"description": "Tags for the metric group"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
"type": "application/json"
},
"parent": {
"href": "/api/v2/projects/my-project",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"_access": {
"$ref": "#/components/schemas/Access",
"description": "Details on the allowed and denied actions for this metric group"
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricInGroupRep"
},
"description": "An ordered list of the metrics in this metric group"
},
"_version": {
"type": "integer",
"example": 1,
"description": "The version of this metric group"
},
"maintainer": {
"$ref": "#/components/schemas/MaintainerRep",
"description": "The maintainer of this metric"
},
"description": {
"type": "string",
"example": "Description of the metric group",
"description": "Description of the metric group"
},
"experiments": {
"$ref": "#/components/schemas/DependentExperimentListRep",
"description": "Experiments that use this metric group. Only included if specified in the <code>expand</code> query parameter in a <code>getMetricGroup</code> request."
},
"_creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1628192791148",
"description": "Timestamp of when the metric group was created"
},
"_lastModified": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1628192791148",
"description": "Timestamp of when the metric group was last modified"
},
"experimentCount": {
"type": "integer",
"example": 0,
"description": "The number of experiments using this metric group"
}
}
}
MetricGroupResultsRep
{
"type": "object",
"required": [
"_links",
"metrics"
],
"properties": {
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricInGroupResultsRep"
},
"description": "An ordered list of the metrics in this metric group, and each of their results"
}
}
}
MetricInGroupRep
{
"type": "object",
"required": [
"key",
"name",
"kind",
"_links"
],
"properties": {
"key": {
"type": "string",
"example": "metric-key-123abc",
"description": "The metric key"
},
"kind": {
"enum": [
"pageview",
"click",
"custom"
],
"type": "string",
"example": "custom",
"description": "The kind of event the metric tracks"
},
"name": {
"type": "string",
"example": "Example metric",
"description": "The metric name"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/metrics/my-project/my-metric",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"isNumeric": {
"type": "boolean",
"example": true,
"description": "For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>)."
},
"_versionId": {
"type": "string",
"example": "version-id-123abc",
"description": "The version ID of the metric"
},
"nameInGroup": {
"type": "string",
"example": "Step 1",
"description": "Name of the metric when used within the associated metric group. Can be different from the original name of the metric. Required if and only if the metric group is a <code>funnel</code>."
},
"randomizationUnits": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"user"
],
"description": "The randomization units for the metric"
}
}
}
MetricInGroupResultsRep
{
"type": "object",
"required": [
"metric",
"results"
],
"properties": {
"metric": {
"$ref": "#/components/schemas/MetricInGroupRep",
"description": "Metric metadata"
},
"results": {
"$ref": "#/components/schemas/ExperimentBayesianResultsRep",
"description": "The results of this metric"
}
}
}
MetricInMetricGroupInput
{
"type": "object",
"required": [
"key",
"nameInGroup"
],
"properties": {
"key": {
"type": "string",
"example": "metric-key-123abc",
"description": "The metric key"
},
"nameInGroup": {
"type": "string",
"example": "Step 1",
"description": "Name of the metric when used within the associated metric group. Can be different from the original name of the metric"
}
}
}
MetricInput
{
"type": "object",
"required": [
"key"
],
"properties": {
"key": {
"type": "string",
"example": "metric-key-123abc",
"description": "The metric key"
},
"isGroup": {
"type": "boolean",
"example": true,
"description": "Whether this is a metric group (true) or a metric (false). Defaults to false"
},
"primary": {
"type": "boolean",
"example": true,
"deprecated": true,
"description": "Deprecated, use <code>primarySingleMetricKey</code> and <code>primaryFunnelKey</code>. Whether this is a primary metric (true) or a secondary metric (false)"
}
}
}
MetricListingRep
{
"type": "object",
"required": [
"_id",
"_versionId",
"key",
"name",
"kind",
"_links",
"tags",
"_creationDate"
],
"properties": {
"_id": {
"type": "string",
"example": "5902deadbeef667524a01290",
"description": "The ID of this metric"
},
"key": {
"type": "string",
"example": "metric-key-123abc",
"description": "A unique key to reference the metric"
},
"kind": {
"enum": [
"pageview",
"click",
"custom"
],
"type": "string",
"example": "custom",
"description": "The kind of event the metric tracks"
},
"name": {
"type": "string",
"example": "My metric",
"description": "A human-friendly name for the metric"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [],
"description": "Tags for the metric"
},
"unit": {
"type": "string",
"description": "For numeric custom metrics, the unit of measure"
},
"_site": {
"$ref": "#/components/schemas/Link",
"example": "{\"href\":\"/experiments/metrics/my-metric/edit\",\"type\":\"text/html\"}",
"description": "Details on how to access the metric in the LaunchDarkly UI"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/metrics/my-project/my-metric",
"type": "application/json"
},
"parent": {
"href": "/api/v2/metrics/my-project",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"_access": {
"$ref": "#/components/schemas/Access",
"description": "Details on the allowed and denied actions for this metric"
},
"eventKey": {
"type": "string",
"description": "For custom metrics, the event key to use in your code"
},
"isNumeric": {
"type": "boolean",
"example": true,
"description": "For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>)."
},
"_versionId": {
"type": "string",
"example": "version-id-123abc",
"description": "The version ID of the metric"
},
"_maintainer": {
"$ref": "#/components/schemas/MemberSummary",
"example": "{\"_links\":{\"self\":{\"href\":\"/api/v2/members/569fdeadbeef1644facecafe\",\"type\":\"application/json\"}},\"_id\":\"569fdeadbeef1644facecafe\",\"firstName\":\"Ariel\",\"lastName\":\"Flores\",\"role\":\"owner\",\"email\":\"ariel@acme.com\"}",
"description": "Details on the member who maintains this metric"
},
"description": {
"type": "string",
"description": "Description of the metric"
},
"analysisType": {
"enum": [
"mean",
"percentile"
],
"type": "string",
"example": "mean",
"description": "The method for analyzing metric events"
},
"eventDefault": {
"$ref": "#/components/schemas/MetricEventDefaultRep"
},
"lastModified": {
"$ref": "#/components/schemas/Modification"
},
"maintainerId": {
"type": "string",
"example": "569fdeadbeef1644facecafe",
"description": "The ID of the member who maintains this metric"
},
"_creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1628192791148",
"description": "Timestamp of when the metric was created"
},
"experimentCount": {
"type": "integer",
"example": 0,
"description": "The number of experiments using this metric"
},
"percentileValue": {
"type": "integer",
"example": 95,
"description": "The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when <code>analysisType</code> is <code>percentile</code>."
},
"successCriteria": {
"enum": [
"HigherThanBaseline",
"LowerThanBaseline"
],
"type": "string",
"description": "For custom metrics, the success criteria"
},
"metricGroupCount": {
"type": "integer",
"example": 0,
"description": "The number of metric groups using this metric"
},
"_attachedFlagCount": {
"type": "integer",
"example": 0,
"description": "The number of feature flags currently attached to this metric"
},
"randomizationUnits": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"user"
],
"description": "An array of randomization units allowed for this metric"
},
"unitAggregationType": {
"enum": [
"average",
"sum"
],
"type": "string",
"example": "average",
"description": "The method by which multiple unit event values are aggregated"
}
}
}
MetricPost
{
"type": "object",
"required": [
"key",
"kind"
],
"properties": {
"key": {
"type": "string",
"example": "metric-key-123abc",
"description": "A unique key to reference the metric"
},
"kind": {
"enum": [
"pageview",
"click",
"custom"
],
"type": "string",
"example": "custom",
"description": "The kind of event your metric will track"
},
"name": {
"type": "string",
"example": "Example metric",
"description": "A human-friendly name for the metric"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"example-tag"
],
"description": "Tags for the metric"
},
"unit": {
"type": "string",
"example": "orders",
"description": "The unit of measure. Applicable for numeric custom metrics only."
},
"urls": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UrlPost"
},
"example": "invalid example",
"description": "One or more target URLs. Required for click and pageview metrics only."
},
"eventKey": {
"type": "string",
"example": "sales generated",
"description": "The event key to use in your code. Required for custom conversion/binary and custom numeric metrics only."
},
"isActive": {
"type": "boolean",
"example": true,
"description": "Whether the metric is active. Set to <code>true</code> to record click or pageview metrics. Not applicable for custom metrics."
},
"selector": {
"type": "string",
"example": ".dropdown-toggle",
"description": "One or more CSS selectors. Required for click metrics only."
},
"isNumeric": {
"type": "boolean",
"example": false,
"description": "Whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>). Required for custom metrics only."
},
"description": {
"type": "string",
"example": "optional description",
"description": "Description of the metric"
},
"analysisType": {
"type": "string",
"example": "mean",
"description": "The method for analyzing metric events"
},
"eventDefault": {
"$ref": "#/components/schemas/MetricEventDefaultRep"
},
"percentileValue": {
"type": "integer",
"example": 95,
"description": "The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when <code>analysisType</code> is <code>percentile</code>."
},
"successCriteria": {
"enum": [
"HigherThanBaseline",
"LowerThanBaseline"
],
"type": "string",
"example": "HigherThanBaseline",
"description": "Success criteria. Required for custom numeric metrics, optional for custom conversion metrics."
},
"randomizationUnits": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"user"
],
"description": "An array of randomization units allowed for this metric"
},
"unitAggregationType": {
"enum": [
"average",
"sum"
],
"type": "string",
"example": "average",
"description": "The method by which multiple unit event values are aggregated"
}
}
}
MetricRep
{
"type": "object",
"required": [
"_id",
"_versionId",
"key",
"name",
"kind",
"_links",
"tags",
"_creationDate"
],
"properties": {
"_id": {
"type": "string",
"example": "5902deadbeef667524a01290",
"description": "The ID of this metric"
},
"key": {
"type": "string",
"example": "metric-key-123abc",
"description": "A unique key to reference the metric"
},
"kind": {
"enum": [
"pageview",
"click",
"custom"
],
"type": "string",
"example": "custom",
"description": "The kind of event the metric tracks"
},
"name": {
"type": "string",
"example": "My metric",
"description": "A human-friendly name for the metric"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [],
"description": "Tags for the metric"
},
"unit": {
"type": "string",
"description": "For numeric custom metrics, the unit of measure"
},
"urls": {
"$ref": "#/components/schemas/UrlMatchers",
"description": "For click and pageview metrics, the target URLs"
},
"_site": {
"$ref": "#/components/schemas/Link",
"example": "{\"href\":\"/experiments/metrics/my-metric/edit\",\"type\":\"text/html\"}",
"description": "Details on how to access the metric in the LaunchDarkly UI"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/metrics/my-project/my-metric",
"type": "application/json"
},
"parent": {
"href": "/api/v2/metrics/my-project",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"_access": {
"$ref": "#/components/schemas/Access",
"description": "Details on the allowed and denied actions for this metric"
},
"_version": {
"type": "integer",
"example": 1,
"description": "Version of the metric"
},
"eventKey": {
"type": "string",
"description": "For custom metrics, the event key to use in your code"
},
"isActive": {
"type": "boolean",
"example": true,
"description": "Whether the metric is active"
},
"selector": {
"type": "string",
"description": "For click metrics, the CSS selectors"
},
"isNumeric": {
"type": "boolean",
"example": true,
"description": "For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>)."
},
"_versionId": {
"type": "string",
"example": "version-id-123abc",
"description": "The version ID of the metric"
},
"_maintainer": {
"$ref": "#/components/schemas/MemberSummary",
"example": "{\"_links\":{\"self\":{\"href\":\"/api/v2/members/569fdeadbeef1644facecafe\",\"type\":\"application/json\"}},\"_id\":\"569fdeadbeef1644facecafe\",\"firstName\":\"Ariel\",\"lastName\":\"Flores\",\"role\":\"owner\",\"email\":\"ariel@acme.com\"}",
"description": "Details on the member who maintains this metric"
},
"description": {
"type": "string",
"description": "Description of the metric"
},
"experiments": {
"$ref": "#/components/schemas/DependentExperimentListRep",
"description": "Experiments that use this metric, including those using a metric group that contains this metric"
},
"analysisType": {
"enum": [
"mean",
"percentile"
],
"type": "string",
"example": "mean",
"description": "The method for analyzing metric events"
},
"eventDefault": {
"$ref": "#/components/schemas/MetricEventDefaultRep"
},
"lastModified": {
"$ref": "#/components/schemas/Modification"
},
"maintainerId": {
"type": "string",
"example": "569fdeadbeef1644facecafe",
"description": "The ID of the member who maintains this metric"
},
"metricGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DependentMetricGroupRep"
},
"description": "Metric groups that use this metric"
},
"_creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1628192791148",
"description": "Timestamp of when the metric was created"
},
"experimentCount": {
"type": "integer",
"example": 0,
"description": "The number of experiments using this metric"
},
"percentileValue": {
"type": "integer",
"example": 95,
"description": "The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when <code>analysisType</code> is <code>percentile</code>."
},
"successCriteria": {
"enum": [
"HigherThanBaseline",
"LowerThanBaseline"
],
"type": "string",
"description": "For custom metrics, the success criteria"
},
"metricGroupCount": {
"type": "integer",
"example": 0,
"description": "The number of metric groups using this metric"
},
"_attachedFeatures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagListingRep"
},
"description": "Details on the flags attached to this metric"
},
"_attachedFlagCount": {
"type": "integer",
"example": 0,
"description": "The number of feature flags currently attached to this metric"
},
"randomizationUnits": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"user"
],
"description": "An array of randomization units allowed for this metric"
},
"unitAggregationType": {
"enum": [
"average",
"sum"
],
"type": "string",
"example": "average",
"description": "The method by which multiple unit event values are aggregated"
}
}
}
MetricSeen
{
"type": "object",
"properties": {
"ever": {
"type": "boolean",
"example": true,
"description": "Whether the metric has received an event for this iteration"
},
"timestamp": {
"type": "integer",
"format": "int64",
"example": 1657129307,
"description": "Timestamp of when the metric most recently received an event for this iteration"
}
}
}
MetricV2Rep
{
"type": "object",
"required": [
"key",
"name",
"kind",
"_links"
],
"properties": {
"key": {
"type": "string",
"example": "metric-key-123abc",
"description": "The metric key"
},
"kind": {
"enum": [
"pageview",
"click",
"custom"
],
"type": "string",
"example": "custom",
"description": "The kind of event the metric tracks"
},
"name": {
"type": "string",
"example": "Example metric",
"description": "The metric name"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/metrics/my-project/my-metric",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"isNumeric": {
"type": "boolean",
"example": true,
"description": "For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>)."
},
"_versionId": {
"type": "string",
"example": "version-id-123abc",
"description": "The version ID of the metric"
}
}
}
MetricsInput
{
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricInput"
}
}
MigrationFlagStageCount
{
"type": "integer"
}
MigrationSafetyIssueRep
{
"type": "object",
"properties": {
"issue": {
"type": "string",
"description": "A description of the issue that <code>causingRuleId</code> has caused for <code>affectedRuleIds</code>."
},
"causingRuleId": {
"type": "string",
"description": "The ID of the rule which caused this issue"
},
"affectedRuleIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of the IDs of the rules which are affected by this issue. <code>fallthrough</code> is a sentinel value for the default rule."
},
"oldSystemAffected": {
"type": "boolean",
"description": "Whether the changes caused by <code>causingRuleId</code> bring inconsistency to the old system"
}
}
}
MigrationSettingsPost
{
"type": "object",
"required": [
"stageCount"
],
"properties": {
"stageCount": {
"$ref": "#/components/schemas/MigrationFlagStageCount",
"enum": [
"2",
"4",
"6"
]
},
"contextKind": {
"type": "string",
"description": "Context kind for a migration with 6 stages, where data is being moved"
}
}
}
Modification
{
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time",
"example": "2021-08-05T19:46:31.148082Z"
}
}
}
MultiEnvironmentDependentFlag
{
"type": "object",
"required": [
"key",
"environments"
],
"properties": {
"key": {
"type": "string",
"example": "dependent-flag-key-123abc",
"description": "The flag key"
},
"name": {
"type": "string",
"example": "Example dependent flag",
"description": "The flag name"
},
"environments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DependentFlagEnvironment"
},
"description": "A list of environments in which the dependent flag appears"
}
}
}
MultiEnvironmentDependentFlags
{
"type": "object",
"required": [
"items",
"_links",
"_site"
],
"properties": {
"_site": {
"$ref": "#/components/schemas/Link",
"example": "{ \"href\": \"/example-project/~/features/example-prereq-flag\", \"type\": \"text/html\" }",
"description": "Details on how to access the prerequisite flag in the LaunchDarkly UI"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MultiEnvironmentDependentFlag"
},
"description": "An array of dependent flags with their environment information"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
NewMemberForm
{
"type": "object",
"required": [
"email"
],
"properties": {
"role": {
"enum": [
"reader",
"writer",
"admin",
"no_access"
],
"type": "string",
"example": "reader",
"description": "The member's built-in role"
},
"email": {
"type": "string",
"example": "sandy@acme.com",
"description": "The member's email"
},
"lastName": {
"type": "string",
"example": "Flores",
"description": "The member's last name"
},
"password": {
"type": "string",
"example": "***",
"description": "The member's password"
},
"teamKeys": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"team-1",
"team-2"
],
"description": "An array of the member's teams"
},
"firstName": {
"type": "string",
"example": "Ariel",
"description": "The member's first name"
},
"customRoles": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"customRole1",
"customRole2"
],
"description": "An array of the member's custom roles"
}
}
}
NewMemberFormListPost
{
"type": "array",
"items": {
"$ref": "#/components/schemas/NewMemberForm"
}
}
NotFoundErrorRep
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"example": "not_found",
"description": "Specific error code encountered"
},
"message": {
"type": "string",
"example": "Invalid resource identifier",
"description": "Description of the error"
}
}
}
OAuthProviderKind
{
"type": "string"
}
ObjectId
{
"type": "string"
}
Operator
{
"type": "string"
}
ParameterDefault
{
"type": "object",
"properties": {
"value": {
"description": "The default value for the given parameter"
},
"ruleClause": {
"$ref": "#/components/schemas/RuleClause",
"description": "Metadata related to add rule instructions"
},
"booleanVariationValue": {
"type": "boolean",
"description": "Variation value for boolean flags. Not applicable for non-boolean flags."
}
}
}
ParameterRep
{
"type": "object",
"properties": {
"flagKey": {
"type": "string"
},
"variationId": {
"type": "string"
}
}
}
ParentResourceRep
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the parent resource"
},
"_links": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"resource": {
"type": "string",
"description": "The parent's resource specifier"
}
}
}
PatchFailedErrorRep
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"example": "patch_failed",
"description": "Specific error code encountered"
},
"message": {
"type": "string",
"example": "Unprocessable entity. Could not apply patch.",
"description": "Description of the error"
}
}
}
PatchOperation
{
"type": "object",
"required": [
"op",
"path",
"value"
],
"properties": {
"op": {
"type": "string",
"example": "replace",
"description": "The type of operation to perform"
},
"path": {
"type": "string",
"example": "/exampleField",
"description": "A JSON Pointer string specifying the part of the document to operate on"
},
"value": {
"example": "new example value",
"description": "A JSON value used in \"add\", \"replace\", and \"test\" operations"
}
}
}
PatchWithComment
{
"type": "object",
"required": [
"patch"
],
"properties": {
"patch": {
"$ref": "#/components/schemas/JSONPatch",
"description": "A JSON patch representation of the change to make"
},
"comment": {
"type": "string",
"description": "Optional comment"
}
}
}
Phase
{
"type": "object",
"required": [
"id",
"audiences",
"name"
],
"properties": {
"id": {
"type": "string",
"example": "1234a56b7c89d012345e678f",
"description": "The phase ID"
},
"name": {
"type": "string",
"example": "Phase 1 - Testing",
"description": "The release phase name"
},
"audiences": {
"$ref": "#/components/schemas/Audiences",
"description": "An ordered list of the audiences for this release phase. Each audience corresponds to a LaunchDarkly environment."
}
}
}
PostDeploymentEventInput
{
"type": "object",
"required": [
"projectKey",
"environmentKey",
"applicationKey",
"version",
"eventType"
],
"properties": {
"version": {
"type": "string",
"example": "a90a8a2",
"description": "The application version. You can set the application version to any string that includes only letters, numbers, periods (<code>.</code>), hyphens (<code>-</code>), or underscores (<code>_</code>).<br/><br/>We recommend setting the application version to at least the first seven characters of the SHA or to the tag of the GitHub commit for this deployment."
},
"eventTime": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1706701522000",
"description": "The time, in Unix milliseconds, when the event occurred. If not included, the time will default to when the event is processed and stored in LaunchDarkly."
},
"eventType": {
"enum": [
"started",
"failed",
"finished",
"custom"
],
"type": "string",
"example": "started",
"description": "The event type"
},
"projectKey": {
"type": "string",
"example": "default",
"description": "The project key"
},
"versionName": {
"type": "string",
"example": "v1.0.0",
"description": "The version name. This defines how the version is displayed"
},
"eventMetadata": {
"type": "object",
"example": {
"buildSystemVersion": "v1.2.3"
},
"description": "A JSON object containing metadata about the event",
"additionalProperties": {}
},
"applicationKey": {
"type": "string",
"example": "billing-service",
"description": "The application key. This defines the granularity at which you want to view your insights metrics. Typically it is the name of one of the GitHub repositories that you use in this project.<br/><br/>LaunchDarkly automatically creates a new application each time you send a unique application key."
},
"environmentKey": {
"type": "string",
"example": "production",
"description": "The environment key"
},
"applicationKind": {
"enum": [
"server",
"browser",
"mobile"
],
"type": "string",
"example": "server",
"description": "The kind of application. Default: <code>server</code>"
},
"applicationName": {
"type": "string",
"example": "Billing Service",
"description": "The application name. This defines how the application is displayed"
},
"deploymentMetadata": {
"type": "object",
"example": {
"buildNumber": "1234"
},
"description": "A JSON object containing metadata about the deployment",
"additionalProperties": {}
}
}
}
PostFlagScheduledChangesInput
{
"type": "object",
"required": [
"executionDate",
"instructions"
],
"properties": {
"comment": {
"type": "string",
"example": "optional comment",
"description": "Optional comment describing the scheduled changes"
},
"instructions": {
"$ref": "#/components/schemas/Instructions",
"example": "[ { \"kind\": \"turnFlagOn\" }]",
"description": "The actions to perform on the execution date for these scheduled changes. This should be an array with a single object that looks like <code>{\"kind\": \"scheduled_action\"}</code>. Supported scheduled actions are <code>turnFlagOn</code> and <code>turnFlagOff</code>."
},
"executionDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1636558831870",
"description": "When the scheduled changes should be executed"
}
}
}
PostInsightGroupParams
{
"type": "object",
"required": [
"name",
"key",
"projectKey",
"environmentKey"
],
"properties": {
"key": {
"type": "string",
"example": "default-production-all-apps",
"description": "The key of the insight group"
},
"name": {
"type": "string",
"example": "Production - All Apps",
"description": "The name of the insight group"
},
"projectKey": {
"type": "string",
"example": "default",
"description": "The projectKey to be associated with the insight group"
},
"environmentKey": {
"type": "string",
"example": "production",
"description": "The environmentKey to be associated with the insight group"
},
"applicationKeys": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"billing-service",
"inventory-service"
],
"description": "The application keys to associate with the insight group. If not provided, the insight group will include data from all applications."
}
}
}
Prerequisite
{
"type": "object",
"required": [
"key",
"variation"
],
"properties": {
"key": {
"type": "string"
},
"variation": {
"type": "integer"
}
}
}
Project
{
"type": "object",
"required": [
"_links",
"_id",
"key",
"includeInSnippetByDefault",
"name",
"tags"
],
"properties": {
"_id": {
"type": "string",
"example": "57be1db38b75bf0772d11383",
"description": "The ID of this project"
},
"key": {
"type": "string",
"example": "project-key-123abc",
"description": "The key of this project"
},
"name": {
"type": "string",
"example": "My Project",
"description": "A human-friendly name for the project"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"ops"
],
"description": "A list of tags for the project"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/projects/my-project",
"type": "application/json"
},
"environments": {
"href": "/api/v2/projects/my-project/environments",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"_access": {
"$ref": "#/components/schemas/Access",
"description": "Details on the allowed and denied actions for this project"
},
"environments": {
"$ref": "#/components/schemas/Environments",
"description": "A paginated list of environments for the project. By default this field is omitted unless expanded by the client."
},
"defaultReleasePipelineKey": {
"type": "string",
"description": "The key of the default release pipeline for this project"
},
"includeInSnippetByDefault": {
"type": "boolean",
"example": true,
"description": "Whether or not flags created in this project are made available to the client-side JavaScript SDK by default"
},
"defaultClientSideAvailability": {
"$ref": "#/components/schemas/ClientSideAvailability",
"description": "Describes which client-side SDKs can use new flags by default"
}
}
}
ProjectPost
{
"type": "object",
"required": [
"name",
"key"
],
"properties": {
"key": {
"type": "string",
"example": "project-key-123abc",
"description": "A unique key used to reference the project in your code."
},
"name": {
"type": "string",
"example": "My Project",
"description": "A human-friendly name for the project."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"ops"
],
"description": "Tags for the project"
},
"environments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnvironmentPost"
},
"description": "Creates the provided environments for this project. If omitted default environments will be created instead."
},
"includeInSnippetByDefault": {
"type": "boolean",
"example": true,
"description": "Whether or not flags created in this project are made available to the client-side JavaScript SDK by default."
},
"defaultClientSideAvailability": {
"$ref": "#/components/schemas/DefaultClientSideAvailabilityPost",
"description": "Controls which client-side SDKs can use new flags by default."
}
}
}
ProjectRep
{
"type": "object",
"required": [
"_links",
"_id",
"key",
"includeInSnippetByDefault",
"name",
"tags",
"environments"
],
"properties": {
"_id": {
"type": "string",
"example": "57be1db38b75bf0772d11383",
"description": "The ID of this project"
},
"key": {
"type": "string",
"example": "project-key-123abc",
"description": "The key of this project"
},
"name": {
"type": "string",
"example": "My Project",
"description": "A human-friendly name for the project"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"ops"
],
"description": "A list of tags for the project"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/projects/my-project",
"type": "application/json"
},
"environments": {
"href": "/api/v2/projects/my-project/environments",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"_access": {
"$ref": "#/components/schemas/Access",
"description": "Details on the allowed and denied actions for this project"
},
"environments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Environment"
},
"description": "A list of environments for the project"
},
"defaultReleasePipelineKey": {
"type": "string",
"description": "The key of the default release pipeline for this project"
},
"includeInSnippetByDefault": {
"type": "boolean",
"example": true,
"description": "Whether or not flags created in this project are made available to the client-side JavaScript SDK by default"
},
"defaultClientSideAvailability": {
"$ref": "#/components/schemas/ClientSideAvailability",
"description": "Describes which client-side SDKs can use new flags by default"
}
}
}
ProjectSummary
{
"type": "object",
"required": [
"_id",
"_links",
"key",
"name"
],
"properties": {
"_id": {
"type": "string",
"example": "57be1db38b75bf0772d11383",
"description": "The ID of this project"
},
"key": {
"type": "string",
"example": "project-key-123abc",
"description": "The project key"
},
"name": {
"type": "string",
"example": "Example project",
"description": "The project name"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/projects/example-project",
"type": "application/json"
},
"environments": {
"href": "/api/v2/projects/example-project/environments",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
ProjectSummaryCollection
{
"type": "object",
"required": [
"totalCount",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectSummary"
}
},
"_links": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer"
}
}
}
Projects
{
"type": "object",
"required": [
"_links",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Project"
},
"description": "List of projects."
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/projects",
"type": "application/json"
}
},
"description": "A link to this resource.",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer"
}
}
}
PullRequestCollectionRep
{
"type": "object",
"required": [
"totalCount",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PullRequestRep"
},
"description": "A list of pull requests"
},
"_links": {
"type": "object",
"example": {
"next": {
"href": "/api/v2/engineering-insights/pull-requests?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5",
"type": "application/json"
},
"self": {
"href": "/api/v2/engineering-insights/pull-requests",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"example": 25,
"description": "The total number of pull requests"
}
}
}
PullRequestLeadTimeRep
{
"type": "object",
"required": [
"codingDurationMs"
],
"properties": {
"codingDurationMs": {
"type": "integer",
"format": "int64",
"example": 1000000,
"description": "The coding duration in milliseconds"
},
"reviewDurationMs": {
"type": "integer",
"format": "int64",
"example": 500000,
"description": "The review duration in milliseconds"
},
"avgWaitDurationMs": {
"type": "integer",
"format": "int64",
"example": 100000,
"description": "The average wait duration between merge time and deploy start time in milliseconds"
},
"maxWaitDurationMs": {
"type": "integer",
"format": "int64",
"example": 100000,
"description": "The max wait duration between merge time and deploy start time in milliseconds"
},
"avgTotalLeadTimeMs": {
"type": "integer",
"format": "int64",
"example": 1600000,
"description": "The average total lead time in milliseconds"
},
"maxTotalLeadTimeMs": {
"type": "integer",
"format": "int64",
"example": 1600000,
"description": "The max total lead time in milliseconds"
},
"avgDeployDurationMs": {
"type": "integer",
"format": "int64",
"example": 100000,
"description": "The average deploy duration in milliseconds"
},
"maxDeployDurationMs": {
"type": "integer",
"format": "int64",
"example": 100000,
"description": "The max deploy duration in milliseconds"
}
}
}
PullRequestRep
{
"type": "object",
"required": [
"id",
"externalId",
"title",
"status",
"author",
"createTime",
"baseCommitKey",
"headCommitKey",
"filesChanged",
"linesAdded",
"linesDeleted",
"url"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
"description": "The pull request internal ID"
},
"url": {
"type": "string",
"example": "https://github.com/launchdarkly/LaunchDarkly-Docs/pull/406",
"description": "The pull request URL"
},
"title": {
"type": "string",
"example": "Enable new payment structure",
"description": "The pull request title"
},
"author": {
"type": "string",
"example": "jane.doe",
"description": "The pull request author"
},
"status": {
"type": "string",
"example": "merged",
"description": "The pull request status"
},
"leadTime": {
"$ref": "#/components/schemas/PullRequestLeadTimeRep",
"description": "The lead time for the pull request in a given environment"
},
"mergeTime": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1706712518000",
"description": "The pull request merge time"
},
"createTime": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1706701522000",
"description": "The pull request create time"
},
"externalId": {
"type": "string",
"example": "1234",
"description": "The pull request number"
},
"linesAdded": {
"type": "integer",
"example": 100,
"description": "The number of lines added"
},
"deployments": {
"$ref": "#/components/schemas/DeploymentCollectionRep",
"description": "A list of deployments associated with the pull request"
},
"filesChanged": {
"type": "integer",
"example": 2,
"description": "The number of files changed"
},
"linesDeleted": {
"type": "integer",
"example": 50,
"description": "The number of lines deleted"
},
"baseCommitKey": {
"type": "string",
"example": "a90a8a2",
"description": "The pull request base commit key"
},
"headCommitKey": {
"type": "string",
"example": "a90a8a2",
"description": "The pull request head commit key"
},
"flagReferences": {
"$ref": "#/components/schemas/FlagReferenceCollectionRep",
"description": "A list of flag references associated with the pull request"
},
"mergeCommitKey": {
"type": "string",
"example": "a90a8a2",
"description": "The pull request merge commit key"
}
}
}
RandomizationSettingsPut
{
"type": "object",
"required": [
"randomizationUnits"
],
"properties": {
"randomizationUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RandomizationUnitInput"
},
"description": "An array of randomization units allowed for this project."
}
}
}
RandomizationSettingsRep
{
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"_projectId": {
"type": "string",
"example": "12345abcde67890fghij",
"description": "The project ID"
},
"_projectKey": {
"type": "string",
"example": "project-key-123abc",
"description": "The project key"
},
"_creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when the experiment was created"
},
"randomizationUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RandomizationUnitRep"
},
"description": "An array of the randomization units in this project"
}
}
}
RandomizationUnitInput
{
"type": "object",
"required": [
"randomizationUnit",
"default",
"standardRandomizationUnit"
],
"properties": {
"default": {
"type": "boolean",
"example": true,
"description": "If true, any experiment iterations created within this project will default to using this randomization unit. A project can only have one default randomization unit."
},
"randomizationUnit": {
"type": "string",
"example": "user",
"description": "The unit of randomization. Must match the key of an existing context kind in this project."
},
"standardRandomizationUnit": {
"enum": [
"guest",
"guestTime",
"organization",
"request",
"user",
"userTime"
],
"type": "string",
"description": "One of LaunchDarkly's fixed set of standard randomization units."
}
}
}
RandomizationUnitRep
{
"type": "object",
"properties": {
"_hidden": {
"type": "boolean"
},
"default": {
"type": "boolean",
"example": true,
"description": "Whether this randomization unit is the default for experiments"
},
"_displayName": {
"type": "string",
"example": "User",
"description": "The display name for the randomization unit, displayed in the LaunchDarkly user interface."
},
"randomizationUnit": {
"type": "string",
"example": "user",
"description": "The unit of randomization. Defaults to user."
},
"standardRandomizationUnit": {
"type": "string",
"example": "user",
"description": "One of LaunchDarkly's fixed set of standard randomization units."
}
}
}
RateLimitedErrorRep
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"example": "rate_limited",
"description": "Specific error code encountered"
},
"message": {
"type": "string",
"example": "You've exceeded the API rate limit. Try again later.",
"description": "Description of the error"
}
}
}
RecentTriggerBody
{
"type": "object",
"properties": {
"jsonBody": {
"type": "object",
"description": "The marshalled JSON request body for the incoming trigger webhook. If this is empty or contains invalid JSON, the timestamp is recorded but this field will be empty.",
"additionalProperties": {}
},
"timestamp": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of the incoming trigger webhook"
}
}
}
ReferenceRep
{
"type": "object",
"required": [
"path",
"hunks"
],
"properties": {
"hint": {
"type": "string",
"example": "javascript",
"description": "Programming language used in the file"
},
"path": {
"type": "string",
"example": "/main/index.js",
"description": "File path of the reference"
},
"hunks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HunkRep"
}
}
}
}
RelativeDifferenceRep
{
"type": "object",
"properties": {
"lower": {
"type": "number",
"example": -0.13708601934659803,
"description": "A lower bound of the relative difference between the treatment and the <code>fromTreatmentId</code>"
},
"upper": {
"type": "number",
"example": 0.42655970355712425,
"description": "An upper bound of the relative difference between the treatment and the <code>fromTreatmentId</code>"
},
"fromTreatmentId": {
"type": "string",
"example": "92b8354e-360e-4d67-8f13-fa6a46ca8077",
"description": "The treatment ID of the treatment against which the relative difference is calculated"
}
}
}
RelayAutoConfigCollectionRep
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelayAutoConfigRep"
},
"description": "An array of Relay Proxy configurations"
}
}
}
RelayAutoConfigPost
{
"type": "object",
"required": [
"name",
"policy"
],
"properties": {
"name": {
"type": "string",
"description": "A human-friendly name for the Relay Proxy configuration"
},
"policy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Statement"
},
"description": "A description of what environments and projects the Relay Proxy should include or exclude. To learn more, read [Writing an inline policy](https://docs.launchdarkly.com/home/relay-proxy/automatic-configuration#writing-an-inline-policy)."
}
}
}
RelayAutoConfigRep
{
"type": "object",
"required": [
"_id",
"name",
"policy",
"fullKey",
"displayKey",
"creationDate",
"lastModified"
],
"properties": {
"_id": {
"$ref": "#/components/schemas/ObjectId",
"example": "12ab3c45de678910abc12345",
"description": "The ID of the Relay Proxy configuration"
},
"name": {
"type": "string",
"example": "Relay Proxy Demo Config",
"description": "A human-friendly name for the Relay Proxy configuration"
},
"policy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Statement"
},
"description": "A description of what environments and projects the Relay Proxy should include or exclude"
},
"_access": {
"$ref": "#/components/schemas/Access",
"description": "Details on the allowed and denied actions for this Relay Proxy configuration"
},
"fullKey": {
"type": "string",
"description": "The Relay Proxy configuration key"
},
"_creator": {
"$ref": "#/components/schemas/MemberSummary",
"description": "Details on the member who created this Relay Proxy configuration"
},
"displayKey": {
"type": "string",
"example": "7f30",
"description": "The last few characters of the Relay Proxy configuration key, displayed in the LaunchDarkly UI"
},
"creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1628001602644",
"description": "Timestamp of when the Relay Proxy configuration was created"
},
"lastModified": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1628001602644",
"description": "Timestamp of when the Relay Proxy configuration was most recently modified"
}
}
}
Release
{
"type": "object",
"required": [
"name",
"releasePipelineKey",
"releasePipelineDescription",
"phases",
"_version"
],
"properties": {
"name": {
"type": "string",
"example": "Example release pipeline",
"description": "The release pipeline name"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"phases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleasePhase"
},
"description": "An ordered list of the release pipeline phases"
},
"_version": {
"type": "integer",
"example": 1,
"description": "The release version"
},
"releasePipelineKey": {
"type": "string",
"example": "example-release-pipeline",
"description": "The release pipeline key"
},
"releasePipelineDescription": {
"type": "string",
"example": "Our release pipeline for typical testing and deployment",
"description": "The release pipeline description"
}
}
}
ReleaseAudience
{
"type": "object",
"required": [
"environment",
"name"
],
"properties": {
"name": {
"type": "string",
"example": "Phase 1 - Testing",
"description": "The release phase name"
},
"environment": {
"$ref": "#/components/schemas/EnvironmentSummary",
"description": "Details about the environment"
}
}
}
ReleasePhase
{
"type": "object",
"required": [
"_id",
"_name",
"complete",
"_creationDate",
"_audiences"
],
"properties": {
"_id": {
"type": "string",
"example": "1234a56b7c89d012345e678f",
"description": "The phase ID"
},
"_name": {
"type": "string",
"example": "Phase 1 - Testing",
"description": "The release phase name"
},
"complete": {
"type": "boolean",
"example": true,
"description": "Whether this phase is complete"
},
"_audiences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleaseAudience"
},
"description": "A logical grouping of one or more environments that share attributes for rolling out changes"
},
"_completedBy": {
"$ref": "#/components/schemas/CompletedBy",
"description": "Details about how this phase was marked as complete"
},
"_creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1684262711507",
"description": "Timestamp of when the release phase was created"
},
"_completionDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1684262711509",
"description": "Timestamp of when the release phase was completed"
}
}
}
ReleasePipeline
{
"type": "object",
"required": [
"createdAt",
"key",
"name",
"phases"
],
"properties": {
"key": {
"type": "string",
"example": "standard-pipeline",
"description": "The release pipeline key"
},
"name": {
"type": "string",
"example": "Standard Pipeline",
"description": "The release pipeline name"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"example-tag"
],
"description": "A list of the release pipeline's tags"
},
"phases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Phase"
},
"description": "An ordered list of the release pipeline phases. Each phase is a logical grouping of one or more environments that share attributes for rolling out changes."
},
"_access": {
"$ref": "#/components/schemas/Access",
"description": "Details on the allowed and denied actions for this release pipeline"
},
"_version": {
"type": "integer",
"example": 1,
"description": "The release pipeline version"
},
"createdAt": {
"type": "string",
"format": "date-time",
"example": "1684262711507",
"description": "Timestamp of when the release pipeline was created"
},
"description": {
"type": "string",
"example": "Standard pipeline to roll out to production",
"description": "The release pipeline description"
}
}
}
ReleasePipelineCollection
{
"type": "object",
"required": [
"items",
"totalCount"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReleasePipeline"
},
"description": "An array of release pipelines"
},
"totalCount": {
"type": "integer",
"example": 1,
"description": "Total number of release pipelines"
}
}
}
RepositoryCollectionRep
{
"type": "object",
"required": [
"_links",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RepositoryRep"
},
"description": "An array of repositories"
},
"_links": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
RepositoryRep
{
"type": "object",
"required": [
"name",
"type",
"defaultBranch",
"enabled",
"version",
"_links"
],
"properties": {
"name": {
"type": "string",
"example": "LaunchDarkly-Docs",
"description": "The repository name"
},
"type": {
"enum": [
"bitbucket",
"custom",
"github",
"gitlab"
],
"type": "string",
"example": "github",
"description": "The type of repository"
},
"_links": {
"type": "object",
"additionalProperties": {}
},
"_access": {
"$ref": "#/components/schemas/Access"
},
"enabled": {
"type": "boolean",
"example": true,
"description": "Whether or not a repository is enabled for code reference scanning"
},
"version": {
"type": "integer",
"example": 3,
"description": "The version of the repository's saved information"
},
"branches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BranchRep"
},
"description": "An array of the repository's branches that have been scanned for code references"
},
"sourceLink": {
"type": "string",
"example": "https://github.com/launchdarkly/LaunchDarkly-Docs",
"description": "A URL to access the repository"
},
"defaultBranch": {
"type": "string",
"example": "main",
"description": "The repository's default branch"
},
"hunkUrlTemplate": {
"type": "string",
"example": "https://github.com/launchdarkly/LaunchDarkly-Docs/blob/${sha}/${filePath}#L${lineNumber}",
"description": "A template for constructing a valid URL to view the hunk"
},
"commitUrlTemplate": {
"type": "string",
"example": "https://github.com/launchdarkly/LaunchDarkly-Docs/commit/${sha}",
"description": "A template for constructing a valid URL to view the commit"
}
}
}
ResourceAccess
{
"type": "object",
"properties": {
"action": {
"$ref": "#/components/schemas/ActionIdentifier"
},
"resource": {
"type": "string"
}
}
}
ResourceIDResponse
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"kind": {
"type": "string"
},
"flagKey": {
"type": "string"
},
"projectKey": {
"type": "string"
},
"environmentKey": {
"type": "string"
}
}
}
ResourceId
{
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "segment-key-123abc",
"description": "The key of the flag or segment"
},
"kind": {
"$ref": "#/components/schemas/ResourceKind",
"example": "segment",
"description": "The type of resource, <code>flag</code> or <code>segment</code>"
},
"flagKey": {
"type": "string",
"deprecated": true,
"description": "Deprecated, use <code>key</code> instead"
},
"projectKey": {
"type": "string",
"example": "project-key-123abc",
"description": "The project key"
},
"environmentKey": {
"type": "string",
"example": "environment-key-123abc",
"description": "The environment key"
}
}
}
ResourceKind
{
"type": "string"
}
ReviewOutput
{
"type": "object",
"required": [
"_id",
"kind"
],
"properties": {
"_id": {
"type": "string"
},
"kind": {
"type": "string"
},
"comment": {
"type": "string"
},
"memberId": {
"type": "string"
},
"creationDate": {
"$ref": "#/components/schemas/UnixMillis"
},
"serviceTokenId": {
"type": "string"
}
}
}
ReviewResponse
{
"type": "object",
"required": [
"_id",
"kind"
],
"properties": {
"_id": {
"type": "string",
"example": "12ab3c45de678910abc12345",
"description": "The approval request ID"
},
"kind": {
"enum": [
"approve",
"decline",
"comment"
],
"type": "string",
"example": "approve",
"description": "The type of review action to take"
},
"comment": {
"type": "string",
"example": "Approved!",
"description": "A comment describing the approval response"
},
"memberId": {
"type": "string",
"example": "12ab3c45de678910abc12345",
"description": "ID of account member that reviewed request"
},
"creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1653606981113",
"description": "Timestamp of when the request was created"
},
"serviceTokenId": {
"type": "string",
"example": "12ab3c45de678910abc12345",
"description": "ID of account service token that reviewed request"
}
}
}
RoleType
{
"type": "string"
}
Rollout
{
"type": "object",
"required": [
"variations"
],
"properties": {
"seed": {
"type": "integer"
},
"bucketBy": {
"type": "string"
},
"variations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WeightedVariation"
}
},
"contextKind": {
"type": "string"
},
"experimentAllocation": {
"$ref": "#/components/schemas/ExperimentAllocationRep"
}
}
}
RootResponse
{
"type": "object",
"required": [
"links"
],
"properties": {
"links": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
Rule
{
"type": "object",
"required": [
"clauses",
"trackEvents"
],
"properties": {
"_id": {
"type": "string",
"description": "The flag rule ID"
},
"ref": {
"type": "string"
},
"clauses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Clause"
},
"description": "An array of clauses used for individual targeting based on attributes"
},
"rollout": {
"$ref": "#/components/schemas/Rollout",
"description": "Details on the percentage rollout, if it exists"
},
"variation": {
"type": "integer",
"description": "The index of the variation, from the array of variations for this flag"
},
"description": {
"type": "string",
"description": "The rule description"
},
"trackEvents": {
"type": "boolean",
"description": "Whether LaunchDarkly tracks events for this rule"
}
}
}
RuleClause
{
"type": "object",
"properties": {
"op": {
"enum": [
"in",
"endsWith",
"startsWith",
"matches",
"contains",
"lessThan",
"lessThanOrEqual",
"greaterThan",
"greaterThanOrEqual",
"before",
"after",
"segmentMatch",
"semVerEqual",
"semVerLessThan",
"semVerGreaterThan"
],
"type": "string",
"description": "The operator to apply to the given attribute"
},
"negate": {
"type": "boolean",
"description": "Whether the operator should be negated"
},
"attribute": {
"type": "string",
"description": "The attribute the rule applies to, for example, last name or email address"
}
}
}
ScheduleKind
{
"type": "string"
}
SdkListRep
{
"type": "object",
"required": [
"_links",
"sdks"
],
"properties": {
"sdks": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"Android",
"Java",
"Node.js"
],
"description": "The list of SDK names"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {}
}
}
}
SdkVersionListRep
{
"type": "object",
"required": [
"_links",
"sdkVersions"
],
"properties": {
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {}
},
"sdkVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkVersionRep"
},
"example": [
{
"sdk": "Android",
"version": "3.1.2"
},
{
"sdk": "Android",
"version": "3.1.5"
},
{
"sdk": "C",
"version": "2.4.6"
}
],
"description": "The list of SDK names and versions"
}
}
}
SdkVersionRep
{
"type": "object",
"required": [
"sdk",
"version"
],
"properties": {
"sdk": {
"type": "string",
"description": "The SDK name, or \"Unknown\""
},
"version": {
"type": "string",
"description": "The version number, or \"Unknown\""
}
}
}
SegmentBody
{
"type": "object",
"required": [
"name",
"key"
],
"properties": {
"key": {
"type": "string",
"example": "segment-key-123abc",
"description": "A unique key used to reference the segment"
},
"name": {
"type": "string",
"example": "Example segment",
"description": "A human-friendly name for the segment"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"testing"
],
"description": "Tags for the segment"
},
"unbounded": {
"type": "boolean",
"example": false,
"description": "Whether to create a standard segment (<code>false</code>) or a big segment (<code>true</code>). Standard segments include rule-based and smaller list-based segments. Big segments include larger list-based segments and synced segments. Only use a big segment if you need to add more than 15,000 individual targets."
},
"description": {
"type": "string",
"example": "Bundle our sample customers together",
"description": "A description of the segment's purpose"
},
"unboundedContextKind": {
"type": "string",
"example": "device",
"description": "For big segments, the targeted context kind."
}
}
}
SegmentId
{
"type": "string"
}
SegmentMetadata
{
"type": "object",
"properties": {
"envId": {
"type": "string"
},
"deleted": {
"type": "boolean"
},
"version": {
"type": "integer"
},
"segmentId": {
"$ref": "#/components/schemas/SegmentId"
},
"lastModified": {
"$ref": "#/components/schemas/UnixMillis"
},
"excludedCount": {
"type": "integer"
},
"includedCount": {
"type": "integer"
}
}
}
SegmentTarget
{
"type": "object",
"properties": {
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"contextKind": {
"type": "string"
}
}
}
SegmentUserList
{
"type": "object",
"properties": {
"add": {
"type": "array",
"items": {
"type": "string"
}
},
"remove": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
SegmentUserState
{
"type": "object",
"properties": {
"excluded": {
"$ref": "#/components/schemas/SegmentUserList"
},
"included": {
"$ref": "#/components/schemas/SegmentUserList"
}
}
}
SegmentsBetaStartBigSegmentImportRequest
{
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "CSV file containing keys"
},
"mode": {
"type": "string",
"format": "string",
"description": "Import mode. Use either `merge` or `replace`"
}
}
}
Series
{
"type": "object",
"required": [
"time",
"value"
],
"properties": {
"time": {
"type": "integer",
"format": "int64",
"example": 1676332800000,
"description": "The timestamp"
},
"value": {
"type": "number",
"example": 92,
"description": "The value for the given timestamp"
}
}
}
SeriesIntervalsRep
{
"type": "object",
"required": [
"series",
"_links"
],
"properties": {
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {}
},
"series": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Series"
},
"description": "An array of timestamps and values for a given meter"
}
}
}
SeriesListRep
{
"type": "object",
"required": [
"_links",
"metadata",
"series"
],
"properties": {
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {}
},
"series": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeriesTimeSliceRep"
},
"example": [
{
"0": 11,
"1": 15,
"time": 1677888000000
}
],
"description": "An array of data points with timestamps. Each element of the array is an object with a 'time' field, whose value is the timestamp, and one or more key fields. If there are multiple key fields, they are labeled '0', '1', and so on, and are explained in the <code>metadata</code>."
},
"metadata": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeriesMetadataRep"
},
"description": "Metadata about each series"
}
}
}
SeriesMetadataRep
{
"type": "object",
"additionalProperties": {}
}
SeriesTimeSliceRep
{
"type": "object",
"additionalProperties": {
"type": "integer"
}
}
SlicedResultsRep
{
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "country",
"description": "An attribute that results are sliced by"
},
"attributeValue": {
"type": "string",
"example": "Canada",
"description": "Attribute Value for 'attribute'"
},
"treatmentResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TreatmentResultRep"
},
"description": "A list of the results for each treatment"
}
}
}
SourceEnv
{
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The key of the source environment to clone from"
},
"version": {
"type": "integer",
"description": "(Optional) The version number of the source environment to clone from. Used for optimistic locking"
}
}
}
StageInput
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "10% rollout on day 1",
"description": "The stage name"
},
"action": {
"$ref": "#/components/schemas/ActionInput",
"example": "{\"instructions\": [{ \"kind\": \"turnFlagOn\"}]}",
"description": "An <code>instructions</code> field containing an array of instructions for the stage. Each object in the array uses the semantic patch format for updating a feature flag."
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionInput"
},
"example": [
{
"kind": "schedule",
"scheduleKind": "relative",
"waitDuration": 2,
"waitDurationUnit": "calendarDay"
}
],
"description": "An array of conditions for the stage"
},
"executeConditionsInSequence": {
"type": "boolean",
"example": true,
"description": "Whether to execute the conditions in sequence for the given stage"
}
}
}
StageOutput
{
"type": "object",
"required": [
"_id",
"conditions",
"action",
"_execution"
],
"properties": {
"_id": {
"type": "string",
"example": "12ab3c45de678910abc12345",
"description": "The ID of this stage"
},
"name": {
"type": "string",
"example": "10% rollout on day 1",
"description": "The stage name"
},
"action": {
"$ref": "#/components/schemas/ActionOutput",
"example": "{ \"kind\": \"patch\", \"instructions\": [{ \"kind\": \"turnFlagOn\"}] }",
"description": "The type of instruction, and an array of instructions for the stage. Each object in the array uses the semantic patch format for updating a feature flag."
},
"_execution": {
"$ref": "#/components/schemas/ExecutionOutput",
"example": "{ \"status\": \"completed\" }",
"description": "Details on the execution of this stage"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionOutput"
},
"example": [
{
"id": "12ab3c45de678910abc12345",
"kind": "schedule",
"_execution": {
"status": "completed"
},
"scheduleKind": "relative",
"waitDuration": 2,
"waitDurationUnit": "calendarDay"
}
],
"description": "An array of conditions for the stage"
}
}
}
Statement
{
"type": "object",
"required": [
"effect"
],
"properties": {
"effect": {
"enum": [
"allow",
"deny"
],
"type": "string",
"example": "allow",
"description": "Whether this statement should allow or deny actions on the resources."
},
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActionSpecifier"
},
"example": [
"*"
],
"description": "Actions to perform on a resource"
},
"resources": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"proj/*:env/*;qa_*:/flag/*"
],
"description": "Resource specifier strings"
},
"notActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActionSpecifier"
},
"description": "Targeted actions are the actions NOT in this list. The <code>actions</code> and <code>notResources</code> fields must be empty to use this field."
},
"notResources": {
"type": "array",
"items": {
"type": "string"
},
"description": "Targeted resources are the resources NOT in this list. The <code>resources</code> and <code>notActions</code> fields must be empty to use this field."
}
}
}
StatementPost
{
"type": "object",
"required": [
"effect"
],
"properties": {
"effect": {
"enum": [
"allow",
"deny"
],
"type": "string",
"example": "allow",
"description": "Whether this statement should allow or deny actions on the resources."
},
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActionSpecifier"
},
"example": [
"*"
],
"description": "Actions to perform on a resource"
},
"resources": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"proj/*:env/*:flag/*;testing-tag"
],
"description": "Resource specifier strings"
},
"notActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActionSpecifier"
},
"description": "Targeted actions are the actions NOT in this list. The <code>actions</code> field must be empty to use this field."
},
"notResources": {
"type": "array",
"items": {
"type": "string"
},
"description": "Targeted resources are the resources NOT in this list. The <code>resources</code> field must be empty to use this field."
}
}
}
StatementPostList
{
"type": "array",
"items": {
"$ref": "#/components/schemas/StatementPost"
}
}
StatisticCollectionRep
{
"type": "object",
"required": [
"flags",
"_links"
],
"properties": {
"flags": {
"type": "object",
"description": "A map of flag keys to a list of code reference statistics for each code repository in which the flag key appears",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatisticRep"
}
}
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
StatisticRep
{
"type": "object",
"required": [
"name",
"type",
"sourceLink",
"defaultBranch",
"enabled",
"version",
"hunkCount",
"fileCount",
"_links"
],
"properties": {
"name": {
"type": "string",
"example": "LaunchDarkly-Docs",
"description": "The repository name"
},
"type": {
"enum": [
"bitbucket",
"custom",
"github",
"gitlab"
],
"type": "string",
"example": "github",
"description": "The type of repository"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"enabled": {
"type": "boolean",
"example": true,
"description": "Whether or not a repository is enabled for code reference scanning"
},
"version": {
"type": "integer",
"example": 3,
"description": "The version of the repository's saved information"
},
"fileCount": {
"type": "integer",
"description": "The number of files in which the flag appears in this repository"
},
"hunkCount": {
"type": "integer",
"description": "The number of code reference hunks in which the flag appears in this repository"
},
"sourceLink": {
"type": "string",
"example": "https://github.com/launchdarkly/LaunchDarkly-Docs",
"description": "A URL to access the repository"
},
"defaultBranch": {
"type": "string",
"example": "main",
"description": "The repository's default branch"
}
}
}
StatisticsRoot
{
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/Link",
"example": "{\"href\": \"/api/v2/code-refs/statistics\", \"type\": \"application/json\"}",
"description": "The location and content type for accessing this resource"
},
"projects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Link"
},
"example": [
{
"href": "/api/v2/code-refs/statistics/example-project-with-code-refs",
"type": "application/json"
}
],
"description": "The location and content type of all projects that have code references"
}
}
}
StatusConflictErrorRep
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"example": "optimistic_locking_error",
"description": "Specific error code encountered"
},
"message": {
"type": "string",
"example": "Conflict. Optimistic lock error. Try again later.",
"description": "Description of the error"
}
}
}
StatusServiceUnavailable
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"example": "service_unavailable",
"description": "Specific error code encountered"
},
"message": {
"type": "string",
"example": "Requested service unavailable",
"description": "Description of the error"
}
}
}
StoreIntegrationError
{
"type": "object",
"properties": {
"message": {
"type": "string"
},
"timestamp": {
"$ref": "#/components/schemas/UnixMillis"
},
"statusCode": {
"type": "integer"
}
}
}
SubjectDataRep
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The subject's name"
},
"_links": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"avatarUrl": {
"type": "string",
"description": "The subject's avatar"
}
}
}
TagCollection
{
"type": "object",
"required": [
"items",
"_links"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"ops",
"pro"
],
"description": "List of tags"
},
"_links": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"example": 103,
"description": "The total number of tags"
}
}
}
Target
{
"type": "object",
"required": [
"values",
"variation"
],
"properties": {
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of the keys for targets that will receive this variation because of individual targeting"
},
"variation": {
"type": "integer",
"description": "The index, from the array of variations for this flag, of the variation to serve this list of targets"
},
"contextKind": {
"type": "string",
"description": "The context kind of the individual target"
}
}
}
TargetResourceRep
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Example flag name",
"description": "The name of the resource"
},
"_links": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"resources": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"proj/example-project:env/production:flag/example-flag"
],
"description": "The resource specifier"
}
}
}
Team
{
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "team-key-123abc",
"description": "The team key"
},
"name": {
"type": "string",
"example": "Example team",
"description": "A human-friendly name for the team"
},
"roles": {
"$ref": "#/components/schemas/TeamCustomRoles",
"description": "Paginated list of the custom roles assigned to this team. Only included if specified in the <code>expand</code> query parameter."
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/teams/example-team",
"type": "application/json"
},
"roles": {
"href": "/api/v2/teams/example-team/roles",
"type": "application/json"
},
"parent": {
"href": "/api/v2/teams",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"_access": {
"$ref": "#/components/schemas/Access",
"description": "Details on the allowed and denied actions for this team"
},
"members": {
"$ref": "#/components/schemas/TeamMembers",
"description": "Details on the total count of members that belong to the team. Only included if specified in the <code>expand</code> query parameter."
},
"_version": {
"type": "integer",
"example": 3,
"description": "The team version"
},
"projects": {
"$ref": "#/components/schemas/TeamProjects",
"description": "Paginated list of the projects that the team has any write access to. Only included if specified in the <code>expand</code> query parameter."
},
"_idpSynced": {
"type": "boolean",
"example": true,
"description": "Whether the team has been synced with an external identity provider (IdP). Team sync is available to customers on an Enterprise plan."
},
"description": {
"type": "string",
"example": "Description for this team.",
"description": "A description of the team"
},
"maintainers": {
"$ref": "#/components/schemas/TeamMaintainers",
"description": "Paginated list of the maintainers assigned to this team. Only included if specified in the <code>expand</code> query parameter."
},
"_creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1648671956143",
"description": "Timestamp of when the team was created"
},
"_lastModified": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1648672446072",
"description": "Timestamp of when the team was most recently updated"
}
}
}
TeamCustomRole
{
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "role-key-123abc",
"description": "The key of the custom role"
},
"name": {
"type": "string",
"example": "Example role",
"description": "The name of the custom role"
},
"projects": {
"$ref": "#/components/schemas/TeamProjects",
"description": "Details on the projects where team members have write privileges on at least one resource type (e.g. flags)"
},
"appliedOn": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1648672018410",
"description": "Timestamp of when the custom role was assigned to this team"
}
}
}
TeamCustomRoles
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamCustomRole"
},
"description": "An array of the custom roles that have been assigned to this team"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/teams/example-team/roles?limit=25",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"example": 1,
"description": "The number of custom roles assigned to this team"
}
}
}
TeamImportsRep
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberImportItem"
},
"description": "An array of details about the members requested to be added to this team"
}
}
}
TeamMaintainers
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberSummary"
},
"example": [
{
"_id": "569f183514f4432160000007",
"role": "reader",
"email": "ariel@acme.com",
"_links": {
"self": {
"href": "/api/v2/members/569f183514f4432160000007",
"type": "application/json"
}
},
"lastName": "Flores",
"firstName": "Ariel"
}
],
"description": "Details on the members that have been assigned as maintainers of the team"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/teams/example-team/maintainers?limit=5",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"example": 1,
"description": "The number of maintainers of the team"
}
}
}
TeamMembers
{
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 15,
"description": "The total count of members that belong to the team"
}
}
}
TeamProjects
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectSummary"
},
"example": [
{
"key": "project-key-123abc",
"name": "Example project",
"_links": {
"self": {
"href": "/api/v2/projects/example-project",
"type": "application/json"
},
"environments": {
"href": "/api/v2/projects/example-project/environments",
"type": "application/json"
}
}
}
],
"description": "Details on each project where team members have write privileges on at least one resource type (e.g. flags)"
},
"totalCount": {
"type": "integer",
"example": 1
}
}
}
Teams
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Team"
},
"description": "An array of teams"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/teams?expand=maintainers%2Cmembers%2Croles%2Cprojects&limit=20",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"example": 1,
"description": "The number of teams"
}
}
}
TeamsAddMultipleMembersToTeamRequest
{
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "CSV file containing email addresses"
}
}
}
TimestampRep
{
"type": "object",
"properties": {
"simple": {
"type": "string"
},
"rfc3339": {
"type": "string"
},
"seconds": {
"type": "integer",
"format": "int64"
},
"milliseconds": {
"$ref": "#/components/schemas/UnixMillis"
}
}
}
Token
{
"type": "object",
"required": [
"_id",
"ownerId",
"memberId",
"creationDate",
"lastModified",
"_links"
],
"properties": {
"_id": {
"$ref": "#/components/schemas/ObjectId",
"example": "61095542756dba551110ae21",
"description": "The ID of the access token"
},
"name": {
"type": "string",
"example": "Example reader token",
"description": "A human-friendly name for the access token"
},
"role": {
"type": "string",
"example": "reader",
"description": "Built-in role for the token"
},
"token": {
"type": "string",
"example": "1234",
"description": "The token value. When creating or resetting, contains the entire token value. Otherwise, contains the last four characters."
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/tokens/61095542756dba551110ae21",
"type": "application/json"
},
"parent": {
"href": "/api/v2/tokens",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"_member": {
"$ref": "#/components/schemas/MemberSummary",
"description": "Details on the member who created the access token"
},
"ownerId": {
"$ref": "#/components/schemas/ObjectId",
"example": "569f514156e003339cfd3917",
"description": "The ID of the owner of the account for the access token"
},
"lastUsed": {
"$ref": "#/components/schemas/UnixMillis",
"example": "0",
"description": "Timestamp of when the access token was last used"
},
"memberId": {
"$ref": "#/components/schemas/ObjectId",
"example": "569f514183f2164430000002",
"description": "The ID of the member who created the access token"
},
"inlineRole": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Statement"
},
"example": [],
"description": "An array of policy statements, with three attributes: effect, resources, actions. May be used in place of a built-in or custom role."
},
"description": {
"type": "string",
"example": "A reader token used in testing and examples",
"description": "A description for the access token"
},
"creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1628001602644",
"description": "Timestamp of when the access token was created"
},
"lastModified": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1628001602644",
"description": "Timestamp of the last modification of the access token"
},
"serviceToken": {
"type": "boolean",
"example": false,
"description": "Whether this is a service token or a personal token"
},
"customRoleIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectId"
},
"example": [],
"description": "A list of custom role IDs to use as access limits for the access token"
},
"defaultApiVersion": {
"type": "integer",
"example": 20220603,
"description": "The default API version for this token"
}
}
}
TokenSummary
{
"type": "object",
"properties": {
"_id": {
"type": "string"
},
"name": {
"type": "string",
"example": "DevOps token",
"description": "The name of the token"
},
"_links": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"ending": {
"type": "string",
"example": "2345",
"description": "The last few characters of the token"
},
"serviceToken": {
"type": "boolean",
"example": false,
"description": "Whether this is a service token"
}
}
}
Tokens
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Token"
},
"description": "An array of access tokens"
},
"_links": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"description": "The number of access tokens returned"
}
}
}
TreatmentInput
{
"type": "object",
"required": [
"name",
"baseline",
"allocationPercent",
"parameters"
],
"properties": {
"name": {
"type": "string",
"example": "Treatment 1",
"description": "The treatment name"
},
"baseline": {
"type": "boolean",
"example": true,
"description": "Whether this treatment is the baseline to compare other treatments against"
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TreatmentParameterInput"
},
"description": "Details on the flag and variation to use for this treatment"
},
"allocationPercent": {
"type": "string",
"example": "10",
"description": "The percentage of traffic allocated to this treatment during the iteration"
}
}
}
TreatmentParameterInput
{
"type": "object",
"required": [
"flagKey",
"variationId"
],
"properties": {
"flagKey": {
"type": "string",
"example": "example-flag-for-experiment",
"description": "The flag key"
},
"variationId": {
"type": "string",
"example": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
"description": "The ID of the flag variation"
}
}
}
TreatmentRep
{
"type": "object",
"required": [
"name",
"allocationPercent"
],
"properties": {
"_id": {
"type": "string",
"example": "122c9f3e-da26-4321-ba68-e0fc02eced58",
"description": "The treatment ID. This is the variation ID from the flag."
},
"name": {
"type": "string",
"example": "Treatment 1",
"description": "The treatment name. This is the variation name from the flag."
},
"baseline": {
"type": "boolean",
"example": true,
"description": "Whether this treatment is the baseline to compare other treatments against"
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ParameterRep"
},
"description": "Details on the flag and variation used for this treatment"
},
"allocationPercent": {
"type": "string",
"example": "10",
"description": "The percentage of traffic allocated to this treatment during the iteration"
}
}
}
TreatmentResultRep
{
"type": "object",
"properties": {
"mean": {
"type": "number",
"example": 0.5432525951557093,
"description": "The average value of the variation in this sample. It doesn’t capture the uncertainty in the measurement, so it should not be the only measurement you use to make decisions."
},
"pBest": {
"type": "number",
"example": 0.6083,
"description": "The likelihood that this variation has the biggest effect on the primary metric. The variation with the highest probability is likely the best of the variations you're testing"
},
"units": {
"type": "integer",
"format": "int64",
"example": 76,
"description": "The number of units exposed to this treatment that have event values, including those that are configured to default to 0"
},
"traffic": {
"type": "integer",
"format": "int64",
"example": 332,
"description": "The number of units exposed to this treatment."
},
"treatmentId": {
"type": "string",
"example": "92b8354e-360e-4d67-8f13-fa6a46ca8077",
"description": "The ID of the treatment"
},
"distribution": {
"$ref": "#/components/schemas/Distribution",
"description": "The posterior distribution of the mean of the metric in this variation."
},
"treatmentName": {
"type": "string",
"example": "variation 25% off",
"description": "The name of the treatment"
},
"credibleInterval": {
"$ref": "#/components/schemas/CredibleIntervalRep",
"example": "{\"lower\": 0.4060771673663068, \"upper\": 0.6713222134386467}",
"description": "The range of the metric's values that you should have 90% confidence in."
},
"relativeDifferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelativeDifferenceRep"
},
"example": [
{
"lower": -0.13708601934659803,
"upper": 0.42655970355712425,
"fromTreatmentId": "92b8354e-360e-4d67-8f13-fa6a46ca8077"
}
],
"description": "Estimates of the relative difference between this treatment's mean and the mean of each other treatment"
}
}
}
TreatmentsInput
{
"type": "array",
"items": {
"$ref": "#/components/schemas/TreatmentInput"
}
}
TriggerWorkflowCollectionRep
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerWorkflowRep"
},
"description": "An array of flag triggers"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
TriggerWorkflowRep
{
"type": "object",
"properties": {
"_id": {
"$ref": "#/components/schemas/FeatureWorkflowId",
"example": "12ab3c45de678910abc12345",
"description": "The ID of this flag trigger"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"enabled": {
"type": "boolean",
"example": true,
"description": "Whether the flag trigger is currently enabled"
},
"_version": {
"type": "integer",
"example": 1,
"description": "The flag trigger version"
},
"triggerURL": {
"type": "string",
"description": "The unguessable URL for this flag trigger"
},
"_maintainer": {
"$ref": "#/components/schemas/MemberSummary",
"description": "Details on the member who maintains this flag trigger"
},
"instructions": {
"$ref": "#/components/schemas/Instructions",
"example": "[ { \"kind\": \"turnFlagOn\" }]",
"description": "Details on the action to perform when triggering"
},
"_creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when the flag trigger was created"
},
"_maintainerId": {
"type": "string",
"example": "12ab3c45de678910abc12345",
"description": "The ID of the flag trigger maintainer"
},
"_triggerCount": {
"type": "integer",
"example": 3,
"description": "Number of times the trigger has been executed"
},
"_integrationKey": {
"type": "string",
"example": "generic-trigger",
"description": "The unique identifier of the integration for your trigger"
},
"_lastTriggeredAt": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654114600000",
"description": "Timestamp of when the trigger was most recently executed"
},
"_recentTriggerBodies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecentTriggerBody"
},
"description": "Details on recent flag trigger requests."
}
}
}
UnauthorizedErrorRep
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"example": "unauthorized",
"description": "Specific error code encountered"
},
"message": {
"type": "string",
"example": "Invalid access token",
"description": "Description of the error"
}
}
}
UnixMillis
{
"type": "integer",
"format": "int64"
}
UpsertContextKindPayload
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "organization",
"description": "The context kind name"
},
"version": {
"type": "integer",
"example": 1,
"description": "The context kind version. If not specified when the context kind is created, defaults to 1."
},
"archived": {
"type": "boolean",
"example": false,
"description": "Whether the context kind is archived. Archived context kinds are unavailable for targeting."
},
"description": {
"type": "string",
"example": "An example context kind for organizations",
"description": "The context kind description"
},
"hideInTargeting": {
"type": "boolean",
"example": false,
"description": "Alias for archived."
}
}
}
UpsertFlagDefaultsPayload
{
"type": "object",
"required": [
"tags",
"temporary",
"booleanDefaults",
"defaultClientSideAvailability"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"tag-1",
"tag-2"
],
"description": "A list of default tags for each flag"
},
"temporary": {
"type": "boolean",
"example": true,
"description": "Whether the flag should be temporary by default"
},
"booleanDefaults": {
"$ref": "#/components/schemas/BooleanFlagDefaults"
},
"defaultClientSideAvailability": {
"$ref": "#/components/schemas/DefaultClientSideAvailability",
"description": "Which client-side SDK types can use this flag by default."
}
}
}
UpsertResponseRep
{
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"status": {
"type": "string",
"example": "success",
"description": "The status of the create or update operation"
}
}
}
UrlMatcher
{
"type": "object",
"additionalProperties": {}
}
UrlMatchers
{
"type": "array",
"items": {
"$ref": "#/components/schemas/UrlMatcher"
}
}
UrlPost
{
"type": "object",
"properties": {
"url": {
"type": "string"
},
"kind": {
"enum": [
"exact",
"canonical",
"substring",
"regex"
],
"type": "string"
},
"pattern": {
"type": "string"
},
"substring": {
"type": "string"
}
}
}
User
{
"type": "object",
"properties": {
"ip": {
"type": "string",
"example": "10.10.10.10",
"description": "The user's IP address"
},
"key": {
"type": "string",
"example": "user-key-123abc",
"description": "The user key. This is the only mandatory user attribute."
},
"name": {
"type": "string",
"example": "Sandy Smith",
"description": "The user's full name"
},
"email": {
"type": "string",
"example": "sandy@example.com",
"description": "The user's email"
},
"avatar": {
"type": "string",
"example": "http://example.com/avatar.png",
"description": "An absolute URL to an avatar image."
},
"custom": {
"type": "object",
"description": "Any other custom attributes for this user. Custom attributes contain any other user data that you would like to use to conditionally target your users.",
"additionalProperties": {}
},
"country": {
"type": "string",
"example": "United States",
"description": "The user's country"
},
"lastName": {
"type": "string",
"example": "Smith",
"description": "The user's last name"
},
"anonymous": {
"type": "boolean",
"example": false,
"description": "Whether the user is anonymous. If true, this user does not appear on the Contexts list in the LaunchDarkly user interface."
},
"firstName": {
"type": "string",
"example": "Sandy",
"description": "The user's first name"
},
"secondary": {
"type": "string",
"example": "2398127",
"description": "If provided, used with the user key to generate a variation in percentage rollouts"
},
"privateAttrs": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of attribute names that are marked as private. You can use these attributes in targeting rules and segments. If you are using a server-side SDK, the SDK will not send the private attribute back to LaunchDarkly. If you are using a client-side SDK, the SDK will send the private attribute back to LaunchDarkly for evaluation. However, the SDK won't send the attribute to LaunchDarkly in events data, LaunchDarkly won't store the private attribute, and the private attribute will not appear on the Contexts list."
}
}
}
UserAttributeNamesRep
{
"type": "object",
"properties": {
"custom": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"Age",
"FavoriteFood",
"FavoriteColor"
],
"description": "custom attributes"
},
"private": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"SSN",
"credit_card_number"
],
"description": "private attributes"
},
"standard": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"key",
"ip",
"firstName",
"lastName",
"country",
"anonymous"
],
"description": "standard attributes"
}
}
}
UserFlagSetting
{
"type": "object",
"required": [
"_links",
"_value",
"setting"
],
"properties": {
"_links": {
"type": "object",
"example": {
"sort.order": {
"href": "/api/v2/users/lacuna/production/Abbie_Braun/flags/sort.order",
"type": "application/json"
}
},
"description": "The location and content type of related resources.",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"_value": {
"example": "true",
"description": "The value of the flag variation that the user receives. If there is no defined default rule, this is null."
},
"reason": {
"$ref": "#/components/schemas/EvaluationReason",
"example": "{\"kind\": \"RULE_MATCH\"}",
"description": "Contains information about why that variation was selected."
},
"setting": {
"example": "null",
"description": "Whether the user is explicitly targeted to receive a particular variation. The setting is false if you have turned off a feature flag for a user. It is null if you haven't assigned that user to a specific variation."
}
}
}
UserFlagSettings
{
"type": "object",
"required": [
"items",
"_links"
],
"properties": {
"items": {
"type": "object",
"example": {
"sort.order": {
"_links": {
"self": {
"href": "/api/v2/users/lacuna/production/Abbie_Braun/flags/sort.order",
"type": "application/json"
}
},
"_value": true,
"setting": null
},
"alternate.page": {
"_links": {
"self": {
"href": "/api/v2/users/lacuna/production/Abbie_Braun/flags/alternate.page",
"type": "application/json"
}
},
"_value": false,
"setting": null
}
},
"description": "An array of flag settings for the user",
"additionalProperties": {
"$ref": "#/components/schemas/UserFlagSetting"
}
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/users/lacuna/production/Abbie_Braun/flags",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
UserRecord
{
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/User",
"description": "Details on the user"
},
"_links": {
"type": "object",
"example": {
"self": {
"href": "/api/v2/users/my-project/my-environment/my-user",
"type": "application/json"
},
"site": {
"href": "/my-project/my-environment/users/my-user",
"type": "text/html"
},
"parent": {
"href": "/api/v2/users/my-project/my-environment",
"type": "application/json"
},
"settings": {
"href": "/api/v2/users/my-project/my-environment/my-user/flags",
"type": "text/html"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"_access": {
"$ref": "#/components/schemas/Access",
"description": "Details on the allowed and denied actions for this user"
},
"ownerId": {
"$ref": "#/components/schemas/ObjectId",
"example": "12ab3c45de678910abc12345",
"description": "The ID of the member who is the owner for this account"
},
"lastPing": {
"type": "string",
"format": "date-time",
"example": "2022-06-28T23:21:29.176609596Z",
"description": "Timestamp of the last time this user was seen"
},
"sortValue": {
"example": "user-key-123abc",
"description": "If this record is returned as part of a list, the value used to sort the list. This is only included when the <code>sort</code> query parameter is specified. It is a time, in Unix milliseconds, if the sort is by <code>lastSeen</code>. It is a user key if the sort is by <code>userKey</code>."
},
"environmentId": {
"$ref": "#/components/schemas/ObjectId",
"example": "1234a56b7c89d012345e678f",
"description": "The environment ID"
}
}
}
UserSegment
{
"type": "object",
"required": [
"name",
"tags",
"creationDate",
"lastModifiedDate",
"key",
"_links",
"rules",
"version",
"deleted",
"generation"
],
"properties": {
"key": {
"type": "string",
"example": "segment-key-123abc",
"description": "A unique key used to reference the segment"
},
"name": {
"type": "string",
"example": "Example segment",
"description": "A human-friendly name for the segment."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"testing"
],
"description": "Tags for the segment. Defaults to an empty array."
},
"rules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSegmentRule"
},
"example": [
{
"_id": "1234a56b7c89d012345e678f",
"clauses": [
{
"op": "endsWith",
"_id": "12ab3c45de678910fab12345",
"negate": false,
"values": [
".edu"
],
"attribute": "email"
}
]
}
],
"description": "An array of the targeting rules for this segment."
},
"_flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagListingRep"
},
"description": "A list of flags targeting this segment. Only included when getting a single segment, using the <code>getSegment</code> endpoint."
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"_access": {
"$ref": "#/components/schemas/Access"
},
"deleted": {
"type": "boolean",
"example": false,
"description": "Whether the segment has been deleted"
},
"version": {
"type": "integer",
"example": 1,
"description": "Version of the segment"
},
"excluded": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"user-key-123abc"
],
"description": "An array of keys for excluded targets. Segment rules bypass individual excluded targets, so they will never be included based on rules. Excluded targets may still be included explicitly. This value is omitted for list-based segments over 15,000 entries, also called big segments."
},
"included": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"user-key-123abc"
],
"description": "An array of keys for included targets. Included individual targets are always segment members, regardless of segment rules. For list-based segments over 15,000 entries, also called big segments, this array is either empty or omitted."
},
"_external": {
"type": "string",
"example": "amplitude",
"description": "The external data store backing this segment. Only applies to synced segments."
},
"unbounded": {
"type": "boolean",
"example": false,
"description": "Whether this is a standard segment (<code>false</code>) or a big segment (<code>true</code>). Standard segments include rule-based segments and smaller list-based segments. Big segments include larger list-based segments and synced segments. If omitted, the segment is a standard segment."
},
"generation": {
"type": "integer",
"description": "For big segments, how many times this segment has been created."
},
"description": {
"type": "string",
"example": "Bundle our sample customers together",
"description": "A description of the segment's purpose. Defaults to <code>null</code> and is omitted in the response if not provided."
},
"creationDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when the segment was created"
},
"_externalLink": {
"type": "string",
"example": "https://analytics.amplitude.com/org/1234/cohort/123abc",
"description": "The URL for the external data store backing this segment. Only applies to synced segments."
},
"excludedContexts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SegmentTarget"
}
},
"includedContexts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SegmentTarget"
}
},
"lastModifiedDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1654104600000",
"description": "Timestamp of when the segment was last modified"
},
"_importInProgress": {
"type": "boolean",
"example": false,
"description": "Whether an import is currently in progress for the specified segment. Only applies to big segments."
},
"_unboundedMetadata": {
"$ref": "#/components/schemas/SegmentMetadata",
"description": "Details on the external data store backing this segment. Only applies to big segments."
},
"unboundedContextKind": {
"type": "string",
"description": "For big segments, the targeted context kind."
}
}
}
UserSegmentRule
{
"type": "object",
"required": [
"clauses"
],
"properties": {
"_id": {
"type": "string"
},
"weight": {
"type": "integer"
},
"clauses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Clause"
}
},
"bucketBy": {
"type": "string"
},
"description": {
"type": "string"
},
"rolloutContextKind": {
"type": "string"
}
}
}
UserSegments
{
"type": "object",
"required": [
"items",
"_links",
"totalCount"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSegment"
},
"description": "An array of segments"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"description": "The total number of segments"
}
}
}
Users
{
"type": "object",
"required": [
"totalCount",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserRecord"
},
"description": "Details on the users"
},
"_links": {
"type": "object",
"example": {
"next": {
"href": "/api/v2/user-search/my-project/my-environment?after=1647993600000&limit=20&searchAfter=my-user&sort=userKey",
"type": "application/json"
},
"self": {
"href": "/api/v2/user-search/my-project/my-environment?after=1647993600000&limit=20&sort=userKey",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"example": 245,
"description": "The total number of users in the environment"
}
}
}
UsersRep
{
"type": "object",
"required": [
"totalCount",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserRecord"
},
"description": "Details on the users"
},
"_links": {
"type": "object",
"example": {
"next": {
"href": "/api/v2/users/my-project/my-environment?after=1647993600000&limit=20&searchAfter=my-user",
"type": "application/json"
},
"self": {
"href": "/api/v2/users/my-project/my-environment?after=1647993600000&limit=20",
"type": "application/json"
}
},
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"totalCount": {
"type": "integer",
"example": 245,
"description": "The total number of users in the environment"
}
}
}
ValidationFailedErrorRep
{
"type": "object",
"required": [
"code",
"message",
"errors"
],
"properties": {
"code": {
"type": "string",
"example": "invalid_request",
"description": "Specific error code encountered"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FailureReasonRep"
},
"description": "List of validation errors"
},
"message": {
"type": "string",
"example": "validation failed",
"description": "Description of the error"
}
}
}
ValuePut
{
"type": "object",
"properties": {
"comment": {
"type": "string",
"example": "make sure this context experiences a specific variation",
"description": "Optional comment describing the change"
},
"setting": {
"example": "existing_variation_value_to_use",
"description": "The variation value to set for the context. Must match the flag's variation type."
}
}
}
Variation
{
"type": "object",
"required": [
"value"
],
"properties": {
"_id": {
"type": "string",
"description": "The ID of the variation. Leave empty when you are creating a flag."
},
"name": {
"type": "string",
"description": "A human-friendly name for the variation. Defaults to an empty string, but is omitted from the response if not set."
},
"value": {
"description": "The value of the variation. For boolean flags, this must be <code>true</code> or <code>false</code>. For multivariate flags, this may be a string, number, or JSON object."
},
"description": {
"type": "string",
"description": "Description of the variation. Defaults to an empty string, but is omitted from the response if not set."
}
}
}
VariationEvalSummary
{
"type": "object",
"properties": {
"after": {
"type": "integer",
"format": "int64",
"example": 500,
"description": "The number of evaluations in the ten minutes after the flag event"
},
"value": {
"example": "true",
"description": "The variation value"
},
"before": {
"type": "integer",
"format": "int64",
"example": 1000,
"description": "The number of evaluations in the ten minutes before the flag event"
}
}
}
VariationOrRolloutRep
{
"type": "object",
"properties": {
"rollout": {
"$ref": "#/components/schemas/Rollout",
"description": "Details on the percentage rollout, if it exists"
},
"variation": {
"type": "integer",
"description": "The index of the variation, from the array of variations for this flag"
}
}
}
VariationSummary
{
"type": "object",
"required": [
"rules",
"nullRules",
"targets",
"contextTargets"
],
"properties": {
"isOff": {
"type": "boolean"
},
"rules": {
"type": "integer"
},
"rollout": {
"type": "integer"
},
"targets": {
"type": "integer"
},
"bucketBy": {
"type": "string"
},
"nullRules": {
"type": "integer"
},
"isFallthrough": {
"type": "boolean"
},
"contextTargets": {
"type": "integer"
}
}
}
VersionsRep
{
"type": "object",
"required": [
"validVersions",
"latestVersion",
"currentVersion"
],
"properties": {
"beta": {
"type": "boolean",
"example": false,
"description": "Whether the version of the API currently is use is a beta version. This is always <code>true</code> if you add the <code>LD-API-Version: beta</code> header to your request."
},
"latestVersion": {
"$ref": "#/components/schemas/DateVersion",
"example": "20220603",
"description": "The most recently released version of the API"
},
"validVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DateVersion"
},
"description": "A list of all valid API versions. To learn more about our versioning, read [Versioning](https://apidocs.launchdarkly.com/#section/Overview/Versioning)."
},
"currentVersion": {
"$ref": "#/components/schemas/DateVersion",
"example": "20220603",
"description": "The version of the API currently in use. Typically this is the API version specified for your access token. If you add the <code>LD-API-Version: beta</code> header to your request, this will be equal to the <code>latestVersion</code>."
}
}
}
Webhook
{
"type": "object",
"required": [
"_links",
"_id",
"url",
"on",
"tags"
],
"properties": {
"on": {
"type": "boolean",
"example": true,
"description": "Whether or not this webhook is enabled"
},
"_id": {
"type": "string",
"example": "57be1db38b75bf0772d11384",
"description": "The ID of this webhook"
},
"url": {
"type": "string",
"example": "http://www.example.com",
"description": "The URL to which LaunchDarkly sends an HTTP POST payload for this webhook"
},
"name": {
"type": "string",
"example": "Example hook",
"description": "A human-readable name for this webhook"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"examples"
],
"description": "List of tags for this webhook"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"secret": {
"type": "string",
"example": "frobozz",
"description": "The secret for this webhook"
},
"_access": {
"$ref": "#/components/schemas/Access",
"description": "Details on the allowed and denied actions for this webhook"
},
"statements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Statement"
},
"description": "Represents a Custom role policy, defining a resource kinds filter the webhook responds to."
}
}
}
Webhooks
{
"type": "object",
"required": [
"_links",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Webhook"
},
"description": "An array of webhooks"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
}
}
}
WeightedVariation
{
"type": "object",
"required": [
"variation",
"weight"
],
"properties": {
"weight": {
"type": "integer"
},
"variation": {
"type": "integer"
},
"_untracked": {
"type": "boolean"
}
}
}
WorkflowTemplateMetadata
{
"type": "object",
"properties": {
"parameters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowTemplateParameter"
}
}
}
}
WorkflowTemplateOutput
{
"type": "object",
"required": [
"_id",
"_key",
"_creationDate",
"_ownerId",
"_maintainerId",
"_links"
],
"properties": {
"_id": {
"type": "string"
},
"_key": {
"type": "string"
},
"name": {
"type": "string"
},
"_links": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"stages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StageOutput"
}
},
"_ownerId": {
"type": "string"
},
"description": {
"type": "string"
},
"_creationDate": {
"$ref": "#/components/schemas/UnixMillis"
},
"_maintainerId": {
"type": "string"
}
}
}
WorkflowTemplateParameter
{
"type": "object",
"properties": {
"_id": {
"$ref": "#/components/schemas/ObjectId",
"description": "The ID of the condition or instruction referenced by this parameter"
},
"path": {
"type": "string",
"description": "The path of the property to parameterize, relative to its parent condition or instruction"
},
"valid": {
"type": "boolean",
"description": "Whether the default value is valid for the target flag and environment"
},
"default": {
"$ref": "#/components/schemas/ParameterDefault",
"description": "The default value of the parameter and other relevant metadata"
}
}
}
WorkflowTemplatesListingOutputRep
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowTemplateOutput"
}
}
}
}
createApprovalRequestRequest
{
"type": "object",
"required": [
"resourceId",
"description",
"instructions"
],
"properties": {
"comment": {
"type": "string",
"example": "optional comment",
"description": "Optional comment describing the approval request"
},
"resourceId": {
"type": "string",
"description": "String representation of a resource"
},
"description": {
"type": "string",
"example": "Requesting to update targeting",
"description": "A brief description of the changes you're requesting"
},
"instructions": {
"$ref": "#/components/schemas/Instructions",
"example": "[{\"kind\": \"addUserTargets\", \"values\": [ \"user-key-123abc\"], \"variationId\": \"ce67d625-a8b9-4fb5-a344-ab909d9d4f4d\" }]",
"description": "List of instructions in semantic patch format to be applied to the feature flag. Review the [Update feature flag](https://apidocs.launchdarkly.com) documentation for details on available instructions."
},
"notifyTeamKeys": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"example-reviewer-team"
],
"description": "An array of team keys. The members of these teams are notified to review the approval request."
},
"notifyMemberIds": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"1234a56b7c89d012345e678f"
],
"description": "An array of member IDs. These members are notified to review the approval request."
},
"integrationConfig": {
"$ref": "#/components/schemas/FormVariableConfig",
"description": "Additional approval request fields for third-party integration approval systems. If you are using a third-party integration to manage approval requests, these additional fields will be described in the <code>manifest.json</code> for that integration, at https://github.com/launchdarkly/integration-framework."
}
}
}
createCopyFlagConfigApprovalRequestRequest
{
"type": "object",
"required": [
"description",
"source"
],
"properties": {
"source": {
"$ref": "#/components/schemas/sourceFlag",
"description": "The flag to copy"
},
"comment": {
"type": "string",
"example": "optional comment",
"description": "Optional comment describing the approval request"
},
"description": {
"type": "string",
"example": "copy flag settings to another environment",
"description": "A brief description of your changes"
},
"notifyTeamKeys": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"example-reviewer-team"
],
"description": "An array of team keys. The members of these teams are notified to review the approval request."
},
"excludedActions": {
"type": "array",
"items": {
"enum": [
"updateOn",
"updateFallthrough",
"updateOffVariation",
"updateRules",
"updateTargets",
"updatePrerequisites"
],
"type": "string"
},
"example": [
"updateOn"
],
"description": "Optional list of the flag changes NOT to copy from the source environment to the target environment. You may include either <code>includedActions</code> or <code>excludedActions</code>, but not both. If neither are included, then all flag changes will be copied."
},
"includedActions": {
"type": "array",
"items": {
"enum": [
"updateOn",
"updateFallthrough",
"updateOffVariation",
"updateRules",
"updateTargets",
"updatePrerequisites"
],
"type": "string"
},
"example": [
"updateOn"
],
"description": "Optional list of the flag changes to copy from the source environment to the target environment. You may include either <code>includedActions</code> or <code>excludedActions</code>, but not both. If neither are included, then all flag changes will be copied."
},
"notifyMemberIds": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"1234a56b7c89d012345e678f"
],
"description": "An array of member IDs. These members are notified to review the approval request."
}
}
}
createFlagConfigApprovalRequestRequest
{
"type": "object",
"required": [
"description",
"instructions"
],
"properties": {
"comment": {
"type": "string",
"example": "optional comment",
"description": "Optional comment describing the approval request"
},
"description": {
"type": "string",
"example": "Requesting to update targeting",
"description": "A brief description of the changes you're requesting"
},
"instructions": {
"$ref": "#/components/schemas/Instructions",
"example": "[{\"kind\": \"addTargets\", \"values\": [ \"context-key-123abc\"], \"variationId\": \"ce67d625-a8b9-4fb5-a344-ab909d9d4f4d\" }]",
"description": "List of instructions in semantic patch format to be applied to the feature flag. Review the [Update feature flag](https://apidocs.launchdarkly.com) documentation for details on available instructions."
},
"executionDate": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1653926400000",
"description": "Timestamp for when instructions will be executed"
},
"operatingOnId": {
"type": "string",
"example": "6297ed79dee7dc14e1f9a80c",
"description": "The ID of a scheduled change. Include this if your <code>instructions</code> include editing or deleting a scheduled change."
},
"notifyTeamKeys": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"example-reviewer-team"
],
"description": "An array of team keys. The members of these teams are notified to review the approval request."
},
"notifyMemberIds": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"1234a56b7c89d012345e678f"
],
"description": "An array of member IDs. These members are notified to review the approval request."
},
"integrationConfig": {
"$ref": "#/components/schemas/FormVariableConfig",
"description": "Additional approval request fields for third-party integration approval systems. If you are using a third-party integration to manage approval requests, these additional fields will be described in the <code>manifest.json</code> for that integration, at https://github.com/launchdarkly/integration-framework."
}
}
}
customProperty
{
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"example": "Jira issues",
"description": "The name of the custom property of this type."
},
"value": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"is-123",
"is-456"
],
"description": "An array of values for the custom property data to associate with this flag."
}
}
}
flagDefaultsRep
{
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "A unique key for the flag default"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"tag-1",
"tag-2"
],
"description": "A list of default tags for each flag"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"temporary": {
"type": "boolean",
"example": true,
"description": "Whether the flag should be temporary by default"
},
"booleanDefaults": {
"$ref": "#/components/schemas/BooleanDefaults",
"description": "Defaults for boolean flags within this project"
},
"defaultClientSideAvailability": {
"$ref": "#/components/schemas/ClientSideAvailability",
"example": "{\"usingMobileKey\": true, \"usingEnvironmentId\": false}",
"description": "Which client-side SDK types can use this flag by default. Set <code>usingMobileKey</code> to make the flag available for mobile SDKs. Set <code>usingEnvironmentId</code> to make the flag available for client-side SDKs."
}
}
}
flagLinkPost
{
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "flag-link-key-123abc",
"description": "The flag link key"
},
"title": {
"type": "string",
"example": "Example link title",
"description": "The title of the flag link"
},
"deepLink": {
"type": "string",
"example": "https://example.com/archives/123123123",
"description": "The URL for the external resource you are linking the flag to"
},
"metadata": {
"type": "object",
"description": "The metadata required by this integration in order to create a flag link, if this is a flag link for an existing integration. Defined in the integration's <code>manifest.json</code> file under <code>flagLink</code>.",
"additionalProperties": {
"type": "string"
}
},
"timestamp": {
"$ref": "#/components/schemas/UnixMillis",
"description": "The time, in Unix milliseconds, to mark this flag link as associated with the external URL. If omitted, defaults to the creation time of this flag link."
},
"description": {
"type": "string",
"example": "Example link description",
"description": "The description of the flag link"
},
"integrationKey": {
"type": "string",
"description": "The integration key for an integration whose <code>manifest.json</code> includes the <code>flagLink</code> capability, if this is a flag link for an existing integration. Do not include for URL flag links."
}
}
}
flagSempatch
{
"type": "object",
"required": [
"instructions"
],
"properties": {
"comment": {
"type": "string"
},
"instructions": {
"$ref": "#/components/schemas/Instructions",
"description": "Semantic patch instructions. The same ones that are valid for flags are valid here."
}
}
}
followersPerFlag
{
"type": "object",
"properties": {
"flagKey": {
"type": "string",
"example": "example-flag-key",
"description": "The flag key"
},
"followers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FollowFlagMember"
},
"description": "A list of members who are following this flag"
}
}
}
instructionUserRequest
{
"type": "object",
"required": [
"kind",
"flagKey",
"variationId"
],
"properties": {
"kind": {
"enum": [
"addExpireUserTargetDate",
"updateExpireUserTargetDate",
"removeExpireUserTargetDate"
],
"type": "string",
"example": "addExpireUserTargetDate",
"description": "The type of change to make to the removal date for this user from individual targeting for this flag."
},
"value": {
"type": "integer",
"example": 1653469200000,
"description": "The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag. Required if <code>kind</code> is <code>addExpireUserTargetDate</code> or <code>updateExpireUserTargetDate</code>."
},
"flagKey": {
"type": "string",
"example": "sample-flag-key",
"description": "The flag key"
},
"version": {
"type": "integer",
"example": 1,
"description": "The version of the expiring user target to update. Optional and only used if <code>kind</code> is <code>updateExpireUserTargetDate</code>. If included, update will fail if version doesn't match current version of the expiring user target."
},
"variationId": {
"type": "string",
"example": "ce12d345-a1b2-4fb5-a123-ab123d4d5f5d",
"description": "ID of a variation on the flag"
}
}
}
ipList
{
"type": "object",
"required": [
"addresses",
"outboundAddresses"
],
"properties": {
"addresses": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"104.156.80.0/20",
"151.101.0.0/16"
],
"description": "A list of the IP addresses LaunchDarkly's service uses"
},
"outboundAddresses": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"52.21.152.96/32"
],
"description": "A list of the IP addresses outgoing webhook notifications use"
}
}
}
membersPatchInput
{
"type": "object",
"required": [
"instructions"
],
"properties": {
"comment": {
"type": "string",
"example": "Optional comment about the update",
"description": "Optional comment describing the update"
},
"instructions": {
"$ref": "#/components/schemas/Instructions",
"example": "[ { \"kind\": \"replaceMemberRoles\", \"value\": \"reader\" } ]",
"description": "The instructions to perform when updating. This should be an array with objects that look like <code>{\"kind\": \"update_action\"}</code>. Some instructions also require additional parameters as part of this object."
}
}
}
oauthClientPost
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of your new LaunchDarkly OAuth 2.0 client."
},
"description": {
"type": "string",
"description": "Description of your OAuth 2.0 client."
},
"redirectUri": {
"type": "string",
"description": "The redirect URI for your new OAuth 2.0 application. This should be an absolute URL conforming with the standard HTTPS protocol."
}
}
}
patchFlagsRequest
{
"type": "object",
"required": [
"instructions"
],
"properties": {
"comment": {
"type": "string",
"example": "optional comment",
"description": "Optional comment describing the change"
},
"instructions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Instruction"
},
"example": [
{
"kind": "addExpireUserTargetDate",
"value": 1686412800000,
"userKey": "sandy",
"variationId": "ce12d345-a1b2-4fb5-a123-ab123d4d5f5d"
}
],
"description": "The instructions to perform when updating"
}
}
}
patchSegmentExpiringTargetInputRep
{
"type": "object",
"required": [
"instructions"
],
"properties": {
"comment": {
"type": "string",
"example": "optional comment",
"description": "Optional description of changes"
},
"instructions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/patchSegmentExpiringTargetInstruction"
},
"example": [
{
"kind": "updateExpiringTarget",
"value": 1587582000000,
"version": 0,
"contextKey": "user@email.com",
"targetType": "included",
"contextKind": "user"
}
],
"description": "Semantic patch instructions for the desired changes to the resource"
}
}
}
patchSegmentExpiringTargetInstruction
{
"type": "object",
"required": [
"kind",
"contextKey",
"contextKind",
"targetType"
],
"properties": {
"kind": {
"enum": [
"addExpiringTarget",
"updateExpiringTarget",
"removeExpiringTarget"
],
"type": "string",
"example": "addExpiringTarget",
"description": "The type of change to make to the context's removal date from this segment"
},
"value": {
"type": "integer",
"example": 1653469200000,
"description": "The time, in Unix milliseconds, when the context should be removed from this segment. Required if <code>kind</code> is <code>addExpiringTarget</code> or <code>updateExpiringTarget</code>."
},
"version": {
"type": "integer",
"example": 1,
"description": "The version of the expiring target to update. Optional and only used if <code>kind</code> is <code>updateExpiringTarget</code>. If included, update will fail if version doesn't match current version of the expiring target."
},
"contextKey": {
"type": "string",
"description": "A unique key used to represent the context"
},
"targetType": {
"enum": [
"included",
"excluded"
],
"type": "string",
"description": "The segment's target type"
},
"contextKind": {
"type": "string",
"example": "user",
"description": "The kind of context"
}
}
}
patchSegmentInstruction
{
"type": "object",
"required": [
"kind",
"userKey",
"targetType"
],
"properties": {
"kind": {
"enum": [
"addExpireUserTargetDate",
"updateExpireUserTargetDate",
"removeExpireUserTargetDate"
],
"type": "string",
"example": "addExpireUserTargetDate",
"description": "The type of change to make to the user's removal date from this segment"
},
"value": {
"type": "integer",
"example": 1653469200000,
"description": "The time, in Unix milliseconds, when the user should be removed from this segment. Required if <code>kind</code> is <code>addExpireUserTargetDate</code> or <code>updateExpireUserTargetDate</code>."
},
"userKey": {
"type": "string",
"description": "A unique key used to represent the user"
},
"version": {
"type": "integer",
"example": 1,
"description": "The version of the segment to update. Required if <code>kind</code> is <code>updateExpireUserTargetDate</code>."
},
"targetType": {
"enum": [
"included",
"excluded"
],
"type": "string",
"description": "The segment's target type"
}
}
}
patchSegmentRequest
{
"type": "object",
"required": [
"instructions"
],
"properties": {
"comment": {
"type": "string",
"example": "optional comment",
"description": "Optional description of changes"
},
"instructions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/patchSegmentInstruction"
},
"example": [
{
"kind": "updateExpiringTarget",
"value": 1587582000000,
"version": 0,
"contextKey": "contextKey",
"targetType": "included",
"contextKind": "user"
}
],
"description": "Semantic patch instructions for the desired changes to the resource"
}
}
}
patchUsersRequest
{
"type": "object",
"required": [
"instructions"
],
"properties": {
"comment": {
"type": "string",
"example": "optional comment",
"description": "Optional comment describing the change"
},
"instructions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/instructionUserRequest"
},
"description": "The instructions to perform when updating"
}
}
}
permissionGrantInput
{
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"updateTeamMembers"
],
"description": "A list of actions to allow. Specify either <code>actionSet</code> or <code>actions</code>. To learn more, read [Role actions](https://docs.launchdarkly.com/home/members/role-actions)."
},
"actionSet": {
"enum": [
"maintainTeam"
],
"type": "string",
"example": "maintainTeam",
"description": "A group of related actions to allow. Specify either <code>actionSet</code> or <code>actions</code>. Use <code>maintainTeam</code> to add team maintainers."
},
"memberIDs": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"12ab3c45de678910fgh12345"
],
"description": "A list of member IDs who receive the permission grant."
}
}
}
postApprovalRequestApplyRequest
{
"type": "object",
"properties": {
"comment": {
"type": "string",
"example": "Looks good, thanks for updating",
"description": "Optional comment about the approval request"
}
}
}
postApprovalRequestReviewRequest
{
"type": "object",
"properties": {
"kind": {
"enum": [
"approve",
"comment",
"decline"
],
"type": "string",
"example": "approve",
"description": "The type of review for this approval request"
},
"comment": {
"type": "string",
"example": "Looks good, thanks for updating",
"description": "Optional comment about the approval request"
}
}
}
putBranch
{
"type": "object",
"required": [
"name",
"head",
"syncTime"
],
"properties": {
"head": {
"type": "string",
"example": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3",
"description": "An ID representing the branch HEAD. For example, a commit SHA."
},
"name": {
"type": "string",
"example": "main",
"description": "The branch name"
},
"syncTime": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1636558831870",
"description": "A timestamp indicating when the branch was last synced"
},
"commitTime": {
"$ref": "#/components/schemas/UnixMillis",
"example": "1636558831870",
"description": "A timestamp of the current commit"
},
"references": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceRep"
},
"description": "An array of flag references found on the branch"
},
"updateSequenceId": {
"type": "integer",
"format": "int64",
"example": 25,
"description": "An optional ID used to prevent older data from overwriting newer data. If no sequence ID is included, the newly submitted data will always be saved."
}
}
}
repositoryPost
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "LaunchDarkly-Docs",
"description": "The repository name"
},
"type": {
"enum": [
"bitbucket",
"custom",
"github",
"gitlab"
],
"type": "string",
"example": "github",
"description": "The type of repository. If not specified, the default value is <code>custom</code>."
},
"sourceLink": {
"type": "string",
"example": "https://github.com/launchdarkly/LaunchDarkly-Docs",
"description": "A URL to access the repository"
},
"defaultBranch": {
"type": "string",
"example": "main",
"description": "The repository's default branch. If not specified, the default value is <code>main</code>."
},
"hunkUrlTemplate": {
"type": "string",
"example": "https://github.com/launchdarkly/LaunchDarkly-Docs/blob/${sha}/${filePath}#L${lineNumber}",
"description": "A template for constructing a valid URL to view the hunk"
},
"commitUrlTemplate": {
"type": "string",
"example": "https://github.com/launchdarkly/LaunchDarkly-Docs/commit/${sha}",
"description": "A template for constructing a valid URL to view the commit"
}
}
}
sourceFlag
{
"type": "object",
"required": [
"key"
],
"properties": {
"key": {
"type": "string",
"example": "environment-key-123abc",
"description": "The environment key for the source environment"
},
"version": {
"type": "integer",
"example": 1,
"description": "The version of the source flag from which to copy"
}
}
}
subscriptionPost
{
"type": "object",
"required": [
"name",
"config"
],
"properties": {
"on": {
"type": "boolean",
"example": false,
"description": "Whether or not you want your subscription to actively send events."
},
"url": {
"type": "string",
"description": "Slack webhook receiver URL. Only necessary for legacy Slack webhook integrations."
},
"name": {
"type": "string",
"example": "Example audit log subscription.",
"description": "A human-friendly name for your audit log subscription."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"testing-tag"
],
"description": "An array of tags for this subscription."
},
"apiKey": {
"type": "string",
"description": "Datadog API key. Only necessary for legacy Datadog webhook integrations."
},
"config": {
"type": "object",
"example": {
"url": "https://example.com",
"optional": "an optional property",
"required": "the required property"
},
"description": "The unique set of fields required to configure an audit log subscription integration of this type. Refer to the <code>formVariables</code> field in the corresponding <code>manifest.json</code> at https://github.com/launchdarkly/integration-framework/tree/main/integrations for a full list of fields for the integration you wish to configure.",
"additionalProperties": {}
},
"statements": {
"$ref": "#/components/schemas/StatementPostList",
"description": "The set of resources you wish to subscribe to audit log notifications for."
}
}
}
teamPatchInput
{
"type": "object",
"required": [
"instructions"
],
"properties": {
"comment": {
"type": "string",
"example": "Optional comment about the update",
"description": "Optional comment describing the update"
},
"instructions": {
"$ref": "#/components/schemas/Instructions",
"example": "[ { \"kind\": \"updateDescription\", \"value\": \"New description for the team\" } ]",
"description": "The instructions to perform when updating. This should be an array with objects that look like <code>{\"kind\": \"update_action\"}</code>. Some instructions also require additional parameters as part of this object."
}
}
}
teamPostInput
{
"type": "object",
"required": [
"key",
"name"
],
"properties": {
"key": {
"type": "string",
"example": "team-key-123abc",
"description": "The team key"
},
"name": {
"type": "string",
"example": "Example team",
"description": "A human-friendly name for the team"
},
"memberIDs": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"12ab3c45de678910fgh12345"
],
"description": "A list of member IDs who belong to the team"
},
"description": {
"type": "string",
"example": "An example team",
"description": "A description of the team"
},
"customRoleKeys": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"example-role1",
"example-role2"
],
"description": "List of custom role keys the team will access"
},
"permissionGrants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/permissionGrantInput"
},
"description": "A list of permission grants. Permission grants allow access to a specific action, without having to create or update a custom role."
}
}
}
teamsPatchInput
{
"type": "object",
"required": [
"instructions"
],
"properties": {
"comment": {
"type": "string",
"example": "Optional comment about the update",
"description": "Optional comment describing the update"
},
"instructions": {
"$ref": "#/components/schemas/Instructions",
"example": "[ { \"kind\": \"updateDescription\", \"value\": \"New description for the team\" } ]",
"description": "The instructions to perform when updating. This should be an array with objects that look like <code>{\"kind\": \"update_action\"}</code>. Some instructions also require additional parameters as part of this object."
}
}
}
triggerPost
{
"type": "object",
"required": [
"integrationKey"
],
"properties": {
"comment": {
"type": "string",
"example": "example comment",
"description": "Optional comment describing the trigger"
},
"instructions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Instruction"
},
"example": [
{
"kind": "turnFlagOn"
}
],
"description": "The action to perform when triggering. This should be an array with a single object that looks like <code>{\"kind\": \"flag_action\"}</code>. Supported flag actions are <code>turnFlagOn</code> and <code>turnFlagOff</code>."
},
"integrationKey": {
"type": "string",
"example": "generic-trigger",
"description": "The unique identifier of the integration for your trigger. Use <code>generic-trigger</code> for integrations not explicitly supported."
}
}
}
upsertPayloadRep
{
"type": "object",
"required": [
"tags",
"temporary",
"booleanDefaults",
"defaultClientSideAvailability"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"tag-1",
"tag-2"
],
"description": "A list of default tags for each flag"
},
"_links": {
"type": "object",
"description": "The location and content type of related resources",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"temporary": {
"type": "boolean",
"example": true,
"description": "Whether the flag should be temporary by default"
},
"booleanDefaults": {
"$ref": "#/components/schemas/BooleanFlagDefaults"
},
"defaultClientSideAvailability": {
"$ref": "#/components/schemas/DefaultClientSideAvailability",
"description": "Which client-side SDK types can use this flag by default."
}
}
}
webhookPost
{
"type": "object",
"required": [
"url",
"sign",
"on"
],
"properties": {
"on": {
"type": "boolean",
"example": true,
"description": "Whether or not this webhook is enabled."
},
"url": {
"type": "string",
"example": "http://www.example.com",
"description": "The URL of the remote webhook"
},
"name": {
"type": "string",
"example": "Example hook",
"description": "A human-readable name for your webhook"
},
"sign": {
"type": "boolean",
"example": true,
"description": "If sign is false, the webhook does not include a signature header, and the secret can be omitted."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [],
"description": "List of tags for this webhook"
},
"secret": {
"type": "string",
"example": "frobozz",
"description": "If sign is true, and the secret attribute is omitted, LaunchDarkly automatically generates a secret for you."
},
"statements": {
"$ref": "#/components/schemas/StatementPostList",
"description": "Represents a Custom role policy, defining a resource kinds filter the webhook should respond to."
}
}
}