Get project — LaunchDarkly

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.

Path parameters

projectKeystringRequired

The project key.

Query parameters

expandstringOptional

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

defaultClientSideAvailabilityobjectOptional

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

_accessobjectOptional

Details on the allowed and denied actions for this project

defaultReleasePipelineKeystringOptional

The key of the default release pipeline for this project

environmentsobjectOptional

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

Errors

1 curl https://app.launchdarkly.com/api/v2/projects/projectKey \ 2 -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": "action", 27 "reason": { 28 "effect": "allow" 29 } 30 } 31 ], 32 "allowed": [ 33 { 34 "action": "action", 35 "reason": { 36 "effect": "allow" 37 } 38 } 39 ] 40 }, 41 "defaultReleasePipelineKey": "defaultReleasePipelineKey", 42 "environments": { 43 "items": [ 44 { 45 "_links": { 46 "self": { 47 "href": "/api/v2/projects/my-project/environments/my-environment", 48 "type": "application/json" 49 } 50 }, 51 "_id": "57be1db38b75bf0772d11384", 52 "key": "environment-key-123abc", 53 "name": "My Environment", 54 "apiKey": "sdk-xxx", 55 "mobileKey": "mob-xxx", 56 "color": "F5A623", 57 "defaultTtl": 5, 58 "secureMode": true, 59 "defaultTrackEvents": false, 60 "requireComments": true, 61 "confirmChanges": true, 62 "tags": [ 63 "ops" 64 ], 65 "critical": true, 66 "approvalSettings": { 67 "required": true, 68 "bypassApprovalsForPendingChanges": false, 69 "minNumApprovals": 1, 70 "canReviewOwnRequest": false, 71 "canApplyDeclinedChanges": true, 72 "serviceKind": "launchdarkly", 73 "serviceConfig": { 74 "key": "value" 75 }, 76 "requiredApprovalTags": [ 77 "require-approval" 78 ], 79 "autoApplyApprovedChanges": true, 80 "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258" 81 } 82 } 83 ], 84 "_links": { 85 "key": {} 86 }, 87 "totalCount": 2 88 } 89 }

1	curl https://app.launchdarkly.com/api/v2/projects/projectKey \
2	-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": "action",
27	"reason": {
28	"effect": "allow"
29	}
30	}
31	],
32	"allowed": [
33	{
34	"action": "action",
35	"reason": {
36	"effect": "allow"
37	}
38	}
39	]
40	},
41	"defaultReleasePipelineKey": "defaultReleasePipelineKey",
42	"environments": {
43	"items": [
44	{
45	"_links": {
46	"self": {
47	"href": "/api/v2/projects/my-project/environments/my-environment",
48	"type": "application/json"
49	}
50	},
51	"_id": "57be1db38b75bf0772d11384",
52	"key": "environment-key-123abc",
53	"name": "My Environment",
54	"apiKey": "sdk-xxx",
55	"mobileKey": "mob-xxx",
56	"color": "F5A623",
57	"defaultTtl": 5,
58	"secureMode": true,
59	"defaultTrackEvents": false,
60	"requireComments": true,
61	"confirmChanges": true,
62	"tags": [
63	"ops"
64	],
65	"critical": true,
66	"approvalSettings": {
67	"required": true,
68	"bypassApprovalsForPendingChanges": false,
69	"minNumApprovals": 1,
70	"canReviewOwnRequest": false,
71	"canApplyDeclinedChanges": true,
72	"serviceKind": "launchdarkly",
73	"serviceConfig": {
74	"key": "value"
75	},
76	"requiredApprovalTags": [
77	"require-approval"
78	],
79	"autoApplyApprovedChanges": true,
80	"serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"
81	}
82	}
83	],
84	"_links": {
85	"key": {}
86	},
87	"totalCount": 2
88	}
89	}