--- title: "Create an environment" description: "The environment gets an off config for every flag. 409 when the project has an environment with this key." --- > Documentation Index > Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt > Use this file to discover all available pages before exploring further. Path: Feature Flags API `POST /v1/organizations/{orgId}/projects/{projectId}/environments` The environment gets an off config for every flag. 409 when the project has an environment with this key. ## Authentication Requires one of the following: - `apiKey`, http, header `Authorization` - `oauth`, http, header `Authorization` - `sessionCookie`, apiKey, in cookie ## Path parameters - `CreateEnvironment.path.orgId` (string, required) - format `uuid` - `CreateEnvironment.path.projectId` (string, required) - format `uuid` ## Header parameters - `CreateEnvironment.header.Idempotency-Key` (string, optional) — Makes a retry safe: the same key and request get the stored response. - pattern `^[\x21-\x7e]{1,200}$` ## Request body _Required._ - `CreateEnvironment.key` (string, required) — Lowercase letters, digits, _ and -, starting with a letter or digit; at most 64 characters. Immutable. - pattern `^[a-z0-9][a-z0-9_-]{0,63}$` - `CreateEnvironment.name` (string, required) - minLength 1; maxLength 100 - `CreateEnvironment.color` (string, optional) - `CreateEnvironment.requireComment` (boolean, optional) ## Example request ```json { "color": "string", "key": "string", "name": "string", "requireComment": true } ``` ## Code samples ### cURL ```curl curl --request POST \ --url https://flags-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/environments \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "color": "string", "key": "string", "name": "string", "requireComment": true } ' ``` ### TypeScript ```typescript const url = 'https://flags-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/environments'; const options = { method: 'POST', headers: {'Content-Type': 'application/json', Authorization: 'Bearer '}, body: JSON.stringify({color: 'string', key: 'string', name: 'string', requireComment: true}) }; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err)); ``` ### Python ```python import requests url = "https://flags-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/environments" payload = { "color": "string", "key": "string", "name": "string", "requireComment": True } headers = { "Content-Type": "application/json", "Authorization": "Bearer " } response = requests.post(url, json=payload, headers=headers) print(response.text) ``` ## Responses ### 201 The environment. #### Example ```json { "color": "string", "createdAt": "2019-08-24T14:15:22Z", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "string", "name": "string", "position": 0, "requireComment": true, "resourceName": "string", "updatedAt": "2019-08-24T14:15:22Z" } ``` - `CreateEnvironment.response.201.color` (string, required) - `CreateEnvironment.response.201.createdAt` (string, required) - format `date-time` - `CreateEnvironment.response.201.id` (string, required) - format `uuid` - `CreateEnvironment.response.201.key` (string, required) — Lowercase letters, digits, _ and -, starting with a letter or digit; at most 64 characters. Immutable. - pattern `^[a-z0-9][a-z0-9_-]{0,63}$` - `CreateEnvironment.response.201.name` (string, required) - maxLength 100 - `CreateEnvironment.response.201.position` (integer, required) — The environment's place in the project's order. - `CreateEnvironment.response.201.requireComment` (boolean, required) — Every config change and restore needs a comment. - `CreateEnvironment.response.201.resourceName` (string, required) - `CreateEnvironment.response.201.updatedAt` (string, required) - format `date-time` ### 400 invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `CreateEnvironment.response.400.error` (object, required) - `CreateEnvironment.response.400.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `CreateEnvironment.response.400.error.message` (string, required) - maxLength 1024 - `CreateEnvironment.response.400.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `CreateEnvironment.response.400.error.issues.message` (string, required) - `CreateEnvironment.response.400.error.issues.path` (string, required) - `CreateEnvironment.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `CreateEnvironment.response.400.error.quota.id` (string, required) - `CreateEnvironment.response.400.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `CreateEnvironment.response.400.error.quota.limit` (integer, required) - min 0 - `CreateEnvironment.response.400.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `CreateEnvironment.response.400.error.quota.inFlight` (integer, optional) - min 0 - `CreateEnvironment.response.400.error.quota.periodStart` (string, optional) - format `date-time` - `CreateEnvironment.response.400.error.quota.region` (string, optional) - `CreateEnvironment.response.400.error.quota.resetsAt` (string, optional) - format `date-time` - `CreateEnvironment.response.400.error.quota.scopeResourceName` (string, optional) - `CreateEnvironment.response.400.error.quota.used` (integer, optional) - min 0 - `CreateEnvironment.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 401 unauthenticated: no credential, or one that doesn't check out. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `CreateEnvironment.response.401.error` (object, required) - `CreateEnvironment.response.401.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `CreateEnvironment.response.401.error.message` (string, required) - maxLength 1024 - `CreateEnvironment.response.401.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `CreateEnvironment.response.401.error.issues.message` (string, required) - `CreateEnvironment.response.401.error.issues.path` (string, required) - `CreateEnvironment.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `CreateEnvironment.response.401.error.quota.id` (string, required) - `CreateEnvironment.response.401.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `CreateEnvironment.response.401.error.quota.limit` (integer, required) - min 0 - `CreateEnvironment.response.401.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `CreateEnvironment.response.401.error.quota.inFlight` (integer, optional) - min 0 - `CreateEnvironment.response.401.error.quota.periodStart` (string, optional) - format `date-time` - `CreateEnvironment.response.401.error.quota.region` (string, optional) - `CreateEnvironment.response.401.error.quota.resetsAt` (string, optional) - format `date-time` - `CreateEnvironment.response.401.error.quota.scopeResourceName` (string, optional) - `CreateEnvironment.response.401.error.quota.used` (integer, optional) - min 0 - `CreateEnvironment.response.401.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 403 access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `CreateEnvironment.response.403.error` (object, required) - `CreateEnvironment.response.403.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `CreateEnvironment.response.403.error.message` (string, required) - maxLength 1024 - `CreateEnvironment.response.403.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `CreateEnvironment.response.403.error.issues.message` (string, required) - `CreateEnvironment.response.403.error.issues.path` (string, required) - `CreateEnvironment.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `CreateEnvironment.response.403.error.quota.id` (string, required) - `CreateEnvironment.response.403.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `CreateEnvironment.response.403.error.quota.limit` (integer, required) - min 0 - `CreateEnvironment.response.403.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `CreateEnvironment.response.403.error.quota.inFlight` (integer, optional) - min 0 - `CreateEnvironment.response.403.error.quota.periodStart` (string, optional) - format `date-time` - `CreateEnvironment.response.403.error.quota.region` (string, optional) - `CreateEnvironment.response.403.error.quota.resetsAt` (string, optional) - format `date-time` - `CreateEnvironment.response.403.error.quota.scopeResourceName` (string, optional) - `CreateEnvironment.response.403.error.quota.used` (integer, optional) - min 0 - `CreateEnvironment.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 404 not_found: unknown, malformed, or in an organization the caller isn't in. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `CreateEnvironment.response.404.error` (object, required) - `CreateEnvironment.response.404.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `CreateEnvironment.response.404.error.message` (string, required) - maxLength 1024 - `CreateEnvironment.response.404.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `CreateEnvironment.response.404.error.issues.message` (string, required) - `CreateEnvironment.response.404.error.issues.path` (string, required) - `CreateEnvironment.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `CreateEnvironment.response.404.error.quota.id` (string, required) - `CreateEnvironment.response.404.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `CreateEnvironment.response.404.error.quota.limit` (integer, required) - min 0 - `CreateEnvironment.response.404.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `CreateEnvironment.response.404.error.quota.inFlight` (integer, optional) - min 0 - `CreateEnvironment.response.404.error.quota.periodStart` (string, optional) - format `date-time` - `CreateEnvironment.response.404.error.quota.region` (string, optional) - `CreateEnvironment.response.404.error.quota.resetsAt` (string, optional) - format `date-time` - `CreateEnvironment.response.404.error.quota.scopeResourceName` (string, optional) - `CreateEnvironment.response.404.error.quota.used` (integer, optional) - min 0 - `CreateEnvironment.response.404.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 409 quota_exceeded (an allocation quota, with quota), idempotency_conflict, idempotency_in_progress (with Retry-After), organization_deletion_pending, operation_in_progress, or the endpoint's own 409 codes. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `CreateEnvironment.response.409.error` (object, required) - `CreateEnvironment.response.409.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `CreateEnvironment.response.409.error.message` (string, required) - maxLength 1024 - `CreateEnvironment.response.409.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `CreateEnvironment.response.409.error.issues.message` (string, required) - `CreateEnvironment.response.409.error.issues.path` (string, required) - `CreateEnvironment.response.409.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `CreateEnvironment.response.409.error.quota.id` (string, required) - `CreateEnvironment.response.409.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `CreateEnvironment.response.409.error.quota.limit` (integer, required) - min 0 - `CreateEnvironment.response.409.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `CreateEnvironment.response.409.error.quota.inFlight` (integer, optional) - min 0 - `CreateEnvironment.response.409.error.quota.periodStart` (string, optional) - format `date-time` - `CreateEnvironment.response.409.error.quota.region` (string, optional) - `CreateEnvironment.response.409.error.quota.resetsAt` (string, optional) - format `date-time` - `CreateEnvironment.response.409.error.quota.scopeResourceName` (string, optional) - `CreateEnvironment.response.409.error.quota.used` (integer, optional) - min 0 - `CreateEnvironment.response.409.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 413 payload_too_large: the body is over the endpoint's limit (1 MiB unless it says otherwise). #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `CreateEnvironment.response.413.error` (object, required) - `CreateEnvironment.response.413.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `CreateEnvironment.response.413.error.message` (string, required) - maxLength 1024 - `CreateEnvironment.response.413.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `CreateEnvironment.response.413.error.issues.message` (string, required) - `CreateEnvironment.response.413.error.issues.path` (string, required) - `CreateEnvironment.response.413.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `CreateEnvironment.response.413.error.quota.id` (string, required) - `CreateEnvironment.response.413.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `CreateEnvironment.response.413.error.quota.limit` (integer, required) - min 0 - `CreateEnvironment.response.413.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `CreateEnvironment.response.413.error.quota.inFlight` (integer, optional) - min 0 - `CreateEnvironment.response.413.error.quota.periodStart` (string, optional) - format `date-time` - `CreateEnvironment.response.413.error.quota.region` (string, optional) - `CreateEnvironment.response.413.error.quota.resetsAt` (string, optional) - format `date-time` - `CreateEnvironment.response.413.error.quota.scopeResourceName` (string, optional) - `CreateEnvironment.response.413.error.quota.used` (integer, optional) - min 0 - `CreateEnvironment.response.413.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 429 too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `CreateEnvironment.response.429.error` (object, required) - `CreateEnvironment.response.429.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `CreateEnvironment.response.429.error.message` (string, required) - maxLength 1024 - `CreateEnvironment.response.429.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `CreateEnvironment.response.429.error.issues.message` (string, required) - `CreateEnvironment.response.429.error.issues.path` (string, required) - `CreateEnvironment.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `CreateEnvironment.response.429.error.quota.id` (string, required) - `CreateEnvironment.response.429.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `CreateEnvironment.response.429.error.quota.limit` (integer, required) - min 0 - `CreateEnvironment.response.429.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `CreateEnvironment.response.429.error.quota.inFlight` (integer, optional) - min 0 - `CreateEnvironment.response.429.error.quota.periodStart` (string, optional) - format `date-time` - `CreateEnvironment.response.429.error.quota.region` (string, optional) - `CreateEnvironment.response.429.error.quota.resetsAt` (string, optional) - format `date-time` - `CreateEnvironment.response.429.error.quota.scopeResourceName` (string, optional) - `CreateEnvironment.response.429.error.quota.used` (integer, optional) - min 0 - `CreateEnvironment.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 500 internal_error: a bug; the details are in the logs, under the request ID. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `CreateEnvironment.response.500.error` (object, required) - `CreateEnvironment.response.500.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `CreateEnvironment.response.500.error.message` (string, required) - maxLength 1024 - `CreateEnvironment.response.500.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `CreateEnvironment.response.500.error.issues.message` (string, required) - `CreateEnvironment.response.500.error.issues.path` (string, required) - `CreateEnvironment.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `CreateEnvironment.response.500.error.quota.id` (string, required) - `CreateEnvironment.response.500.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `CreateEnvironment.response.500.error.quota.limit` (integer, required) - min 0 - `CreateEnvironment.response.500.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `CreateEnvironment.response.500.error.quota.inFlight` (integer, optional) - min 0 - `CreateEnvironment.response.500.error.quota.periodStart` (string, optional) - format `date-time` - `CreateEnvironment.response.500.error.quota.region` (string, optional) - `CreateEnvironment.response.500.error.quota.resetsAt` (string, optional) - format `date-time` - `CreateEnvironment.response.500.error.quota.scopeResourceName` (string, optional) - `CreateEnvironment.response.500.error.quota.used` (integer, optional) - min 0 - `CreateEnvironment.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 503 unavailable: a dependency the request needs is down. Retry after Retry-After. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `CreateEnvironment.response.503.error` (object, required) - `CreateEnvironment.response.503.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `CreateEnvironment.response.503.error.message` (string, required) - maxLength 1024 - `CreateEnvironment.response.503.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `CreateEnvironment.response.503.error.issues.message` (string, required) - `CreateEnvironment.response.503.error.issues.path` (string, required) - `CreateEnvironment.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `CreateEnvironment.response.503.error.quota.id` (string, required) - `CreateEnvironment.response.503.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `CreateEnvironment.response.503.error.quota.limit` (integer, required) - min 0 - `CreateEnvironment.response.503.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `CreateEnvironment.response.503.error.quota.inFlight` (integer, optional) - min 0 - `CreateEnvironment.response.503.error.quota.periodStart` (string, optional) - format `date-time` - `CreateEnvironment.response.503.error.quota.region` (string, optional) - `CreateEnvironment.response.503.error.quota.resetsAt` (string, optional) - format `date-time` - `CreateEnvironment.response.503.error.quota.scopeResourceName` (string, optional) - `CreateEnvironment.response.503.error.quota.used` (integer, optional) - min 0 - `CreateEnvironment.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. Source: https://docs.ezghcloud.com/flags-api/CreateEnvironment/index.md