LaunchDarkly REST API
LaunchDarkly DocsSign in
HomeAPI ReferenceSDKsContext Plugin
Projects

Get project

GET
/api/v2/projects/{projectKey}

Get a single project by key.

Expanding the project response

LaunchDarkly supports one field for expanding the "Get project" response. By default, these fields are not included in the response.

To expand the response, append the expand query parameter and add a comma-separated list with any of the following fields:

  • environments includes a paginated list of the project environments.

For example, expand=environments includes the environments field for the project in the response.

Authorization

ApiKey read, write
Authorization<token>

In: header

Scope: read, write

Path Parameters

projectKey*string

The project key.

Formatstring

Query Parameters

expand?string

A comma-separated list of properties that can reveal additional information in the response.

Formatstring

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/projects/string"
{  "_links": {    "environments": {      "href": "/api/v2/projects/my-project/environments",      "type": "application/json"    },    "self": {      "href": "/api/v2/projects/my-project",      "type": "application/json"    }  },  "_id": "57be1db38b75bf0772d11383",  "key": "project-key-123abc",  "includeInSnippetByDefault": true,  "defaultClientSideAvailability": {    "usingMobileKey": true,    "usingEnvironmentId": true  },  "name": "My Project",  "_access": {    "denied": [      {        "action": "string",        "reason": {          "resources": [            "proj/*:env/*;qa_*:/flag/*"          ],          "notResources": [            "string"          ],          "actions": [            "*"          ],          "notActions": [            "string"          ],          "effect": "allow",          "role_name": "string"        }      }    ],    "allowed": [      {        "action": "string",        "reason": {          "resources": [            "proj/*:env/*;qa_*:/flag/*"          ],          "notResources": [            "string"          ],          "actions": [            "*"          ],          "notActions": [            "string"          ],          "effect": "allow",          "role_name": "string"        }      }    ]  },  "tags": [    "ops"  ],  "defaultReleasePipelineKey": "string",  "environments": {    "_links": {      "property1": {        "href": "string",        "type": "string"      },      "property2": {        "href": "string",        "type": "string"      }    },    "totalCount": 2,    "items": [      {        "_links": {          "self": {            "href": "/api/v2/projects/my-project/environments/my-environment",            "type": "application/json"          }        },        "_id": "57be1db38b75bf0772d11384",        "key": "environment-key-123abc",        "name": "My Environment",        "apiKey": "sdk-xxx",        "mobileKey": "mob-xxx",        "color": "F5A623",        "defaultTtl": 5,        "secureMode": true,        "_access": {          "denied": [            {              "action": "string",              "reason": {                "resources": [                  "proj/*:env/*;qa_*:/flag/*"                ],                "notResources": [                  "string"                ],                "actions": [                  "*"                ],                "notActions": [                  "string"                ],                "effect": "allow",                "role_name": "string"              }            }          ],          "allowed": [            {              "action": "string",              "reason": {                "resources": [                  "proj/*:env/*;qa_*:/flag/*"                ],                "notResources": [                  "string"                ],                "actions": [                  "*"                ],                "notActions": [                  "string"                ],                "effect": "allow",                "role_name": "string"              }            }          ]        },        "defaultTrackEvents": false,        "requireComments": true,        "confirmChanges": true,        "tags": [          "ops"        ],        "approvalSettings": {          "required": true,          "bypassApprovalsForPendingChanges": false,          "minNumApprovals": 1,          "canReviewOwnRequest": false,          "canApplyDeclinedChanges": true,          "autoApplyApprovedChanges": true,          "serviceKind": "launchdarkly",          "serviceConfig": {},          "requiredApprovalTags": [            "require-approval"          ],          "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"        },        "resourceApprovalSettings": {          "property1": {            "required": true,            "bypassApprovalsForPendingChanges": false,            "minNumApprovals": 1,            "canReviewOwnRequest": false,            "canApplyDeclinedChanges": true,            "autoApplyApprovedChanges": true,            "serviceKind": "launchdarkly",            "serviceConfig": {},            "requiredApprovalTags": [              "require-approval"            ],            "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"          },          "property2": {            "required": true,            "bypassApprovalsForPendingChanges": false,            "minNumApprovals": 1,            "canReviewOwnRequest": false,            "canApplyDeclinedChanges": true,            "autoApplyApprovedChanges": true,            "serviceKind": "launchdarkly",            "serviceConfig": {},            "requiredApprovalTags": [              "require-approval"            ],            "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"          }        },        "critical": true      }    ]  }}

Create project POST

Create a new project with the given key and name. Project keys must be unique within an account.

Update project PATCH

Update a project. Updating a project uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).<br/><br/>To add an element to the project fields that are arrays, set the `path` to the name of the field and then append `/<array index>`. Use `/0` to add to the beginning of the array. Use `/-` to add to the end of the array. For example, `"path": "/tags/0"` adds a tag.<br/><br/>Note that `tags` are always deduplicated and returned in alphabetical order, regardless of the array index used in the patch path.