Create project — LaunchDarkly

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

Request

This endpoint expects an object.

namestringRequired

A human-friendly name for the project.

keystringRequired

A unique key used to reference the project in your code.

includeInSnippetByDefaultbooleanOptional

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

defaultClientSideAvailabilityobjectOptional

Controls which client-side SDKs can use new flags by default.

tagslist of stringsOptional

Tags for the project

environmentslist of objectsOptional

Creates the provided environments for this project. If omitted default environments will be created instead.

namingConventionobjectOptional

The flag key convention for this project

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

environmentslist of objects

A list of environments 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

Errors

1 curl -X POST https://app.launchdarkly.com/api/v2/projects \ 2 -H "Authorization: <apiKey>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "name": "My Project", 6 "key": "project-key-123abc" 7 }'

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

1	curl -X POST https://app.launchdarkly.com/api/v2/projects \
2	-H "Authorization: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "My Project",
6	"key": "project-key-123abc"
7	}'

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