Get project | LaunchDarkly

curl https://app.launchdarkly.com/api/v2/projects/projectKey \
     -H "Authorization: <apiKey>"

{
  "_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
  }
}

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.

curl https://app.launchdarkly.com/api/v2/projects/projectKey \
     -H "Authorization: <apiKey>"

{
  "_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
  }
}

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.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key.

Query parameters

expandstringOptionalformat: "string"

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

Response

Project response

_linksmap from strings to objects

The location and content type of related resources

_idstring

The ID of this project

keystring

The key of this project

includeInSnippetByDefaultboolean

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

namestring

A human-friendly name for the project

tagslist of strings

A list of tags for the project

defaultClientSideAvailabilityobject

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

_accessobject

Details on the allowed and denied actions for this project

defaultReleasePipelineKeystring

The key of the default release pipeline for this project

environmentsobject

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

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

$	curl https://app.launchdarkly.com/api/v2/projects/projectKey \
>	-H "Authorization: <apiKey>"

1	{
2	"_links": {
3	"environments": {
4	"href": "/api/v2/projects/my-project/environments",
5	"type": "application/json"
6	},
7	"self": {
8	"href": "/api/v2/projects/my-project",
9	"type": "application/json"
10	}
11	},
12	"_id": "57be1db38b75bf0772d11383",
13	"key": "project-key-123abc",
14	"includeInSnippetByDefault": true,
15	"name": "My Project",
16	"tags": [
17	"ops"
18	],
19	"defaultClientSideAvailability": {
20	"usingMobileKey": true,
21	"usingEnvironmentId": true
22	},
23	"_access": {
24	"denied": [
25	{
26	"action": "string",
27	"reason": {
28	"effect": "allow",
29	"resources": [
30	"proj/:env/;qa_:/flag/"
31	],
32	"notResources": [
33	"string"
34	],
35	"actions": [
36	"*"
37	],
38	"notActions": [
39	"string"
40	],
41	"role_name": "string"
42	}
43	}
44	],
45	"allowed": [
46	{
47	"action": "string",
48	"reason": {
49	"effect": "allow",
50	"resources": [
51	"proj/:env/;qa_:/flag/"
52	],
53	"notResources": [
54	"string"
55	],
56	"actions": [
57	"*"
58	],
59	"notActions": [
60	"string"
61	],
62	"role_name": "string"
63	}
64	}
65	]
66	},
67	"defaultReleasePipelineKey": "string",
68	"environments": {
69	"items": [
70	{
71	"_links": {
72	"self": {
73	"href": "/api/v2/projects/my-project/environments/my-environment",
74	"type": "application/json"
75	}
76	},
77	"_id": "57be1db38b75bf0772d11384",
78	"key": "environment-key-123abc",
79	"name": "My Environment",
80	"apiKey": "sdk-xxx",
81	"mobileKey": "mob-xxx",
82	"color": "F5A623",
83	"defaultTtl": 5,
84	"secureMode": true,
85	"defaultTrackEvents": false,
86	"requireComments": true,
87	"confirmChanges": true,
88	"tags": [
89	"ops"
90	],
91	"critical": true,
92	"_access": {
93	"denied": [
94	{
95	"action": "string",
96	"reason": {
97	"effect": "allow",
98	"resources": [
99	"proj/:env/;qa_:/flag/"
100	],
101	"notResources": [
102	"string"
103	],
104	"actions": [
105	"*"
106	],
107	"notActions": [
108	"string"
109	],
110	"role_name": "string"
111	}
112	}
113	],
114	"allowed": [
115	{
116	"action": "string",
117	"reason": {
118	"effect": "allow",
119	"resources": [
120	"proj/:env/;qa_:/flag/"
121	],
122	"notResources": [
123	"string"
124	],
125	"actions": [
126	"*"
127	],
128	"notActions": [
129	"string"
130	],
131	"role_name": "string"
132	}
133	}
134	]
135	},
136	"approvalSettings": {
137	"required": true,
138	"bypassApprovalsForPendingChanges": false,
139	"minNumApprovals": 1,
140	"canReviewOwnRequest": false,
141	"canApplyDeclinedChanges": true,
142	"serviceKind": "launchdarkly",
143	"serviceConfig": {},
144	"requiredApprovalTags": [
145	"require-approval"
146	],
147	"autoApplyApprovedChanges": true,
148	"serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"
149	},
150	"resourceApprovalSettings": {}
151	}
152	],
153	"_links": {},
154	"totalCount": 2
155	}
156	}