Get project

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

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.

GET /api/v2/projects/{projectKey}

Get project

cURL

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/projects/{projectKey} \
  --header 'Authorization: <api-key>'

200

{
  "_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,
  "name": "My Project",
  "tags": [
    "ops"
  ],
  "defaultClientSideAvailability": {
    "usingMobileKey": true,
    "usingEnvironmentId": true
  },
  "_access": {
    "denied": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ],
    "allowed": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ]
  },
  "defaultReleasePipelineKey": "<string>",
  "environments": {
    "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,
        "defaultTrackEvents": false,
        "requireComments": true,
        "confirmChanges": true,
        "tags": [
          "ops"
        ],
        "critical": true,
        "_access": {
          "denied": [
            {
              "action": "<string>",
              "reason": {
                "effect": "allow",
                "resources": [
                  "proj/*:env/*;qa_*:/flag/*"
                ],
                "notResources": [
                  "<string>"
                ],
                "actions": [
                  "*"
                ],
                "notActions": [
                  "<string>"
                ],
                "role_name": "<string>"
              }
            }
          ],
          "allowed": [
            {
              "action": "<string>",
              "reason": {
                "effect": "allow",
                "resources": [
                  "proj/*:env/*;qa_*:/flag/*"
                ],
                "notResources": [
                  "<string>"
                ],
                "actions": [
                  "*"
                ],
                "notActions": [
                  "<string>"
                ],
                "role_name": "<string>"
              }
            }
          ]
        },
        "approvalSettings": {
          "required": true,
          "bypassApprovalsForPendingChanges": false,
          "minNumApprovals": 1,
          "canReviewOwnRequest": false,
          "canApplyDeclinedChanges": true,
          "serviceKind": "launchdarkly",
          "serviceConfig": {},
          "requiredApprovalTags": [
            "require-approval"
          ],
          "autoApplyApprovedChanges": true,
          "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"
        },
        "resourceApprovalSettings": {}
      }
    ],
    "_links": {},
    "totalCount": 2
  }
}

Authorizations

Authorization · string · header · required

Path Parameters

projectKey · string<string> · required

The project key.

Query Parameters

expand · string<string>

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

Response

200

application/json

Project response

_links · object · required

The location and content type of related resources

Show child attributes

Example:

{
  "environments": {
    "href": "/api/v2/projects/my-project/environments",
    "type": "application/json"
  },
  "self": {
    "href": "/api/v2/projects/my-project",
    "type": "application/json"
  }
}

_id · string · required

The ID of this project

Example:

"57be1db38b75bf0772d11383"

key · string · required

The key of this project

Example:

"project-key-123abc"

includeInSnippetByDefault · boolean · required

Whether or not flags created in this project are made available to the client-side JavaScript SDK by default

Example:

true

name · string · required

A human-friendly name for the project

Example:

"My Project"

tags · string[] · required

A list of tags for the project

Example:

["ops"]

defaultClientSideAvailability · object

Describes which client-side SDKs can use new flags by default

Show child attributes

_access · object

Details on the allowed and denied actions for this project

Show child attributes

defaultReleasePipelineKey · string

The key of the default release pipeline for this project

environments · object

A paginated list of environments for the project. By default this field is omitted unless expanded by the client.

Show child attributes