def create(
project: str,
body: EnvironmentCreate,
*,
product: str | None = None,
timeout: float | None = None,
) -> EnvironmentResourceasync def create(
project: str,
body: EnvironmentCreate,
*,
product: str | None = None,
timeout: float | None = None,
) -> EnvironmentResourceCreates an environment inside a project. The API requires both name and slug, so always send a slug: it is slugified server-side before validation and has to be free within the project.
The body is parsed and validated before the project is resolved, so a bad name returns 400 even when the project reference is wrong too. The allowance is counted per project, not per workspace the way products and projects are, and it is checked before the slug conflict, so a project that is already at its limit fails with 402 no matter which slug you picked.
Example
from envless import envless
environment = envless.environments.create(
'api', {'name': 'Production', 'slug': 'production'}
)
print(environment['id'], environment['slug'])import asyncio
from envless import AsyncEnvless
async def main() -> None:
async with AsyncEnvless() as envless:
environment = await envless.environments.create(
'api', {'name': 'Production', 'slug': 'production'}
)
print(environment['id'], environment['slug'])
asyncio.run(main())Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
project | str | Yes | Project slug or uniqueId that will own the environment. |
body['name'] | str | Yes | Display name, 2 to 50 characters. |
body['slug'] | str | Yes | Lowercase hyphenated slug, unique inside the project. |
product | str | No | Product slug that disambiguates an ambiguous project slug. |
timeout | float | No | Seconds each attempt of this call may take, the response body included, before it raises EnvlessNetworkError with is_timeout set. Overrides the client's timeout for this call, and 0 turns the limit off. |
Returns
EnvironmentResource, the full shape that carries exposed and updatedAt.
Worth knowing
exposedis alwaysFalsehere; publishing a feed is a separateexposecall.- On a 402 the error
resourcenames the allowance that was hit and itsmessagestates the limit. The response body also carrieslimitandcurrent, whichEnvlessApiErrordoes not expose.
Required scopes
environments:write
Underlying endpoint
POST /projects/{slug}/environments
Request and response schema, every error code, and a live playground.
In TypeScript
envless.environments.create()
The same method in @goenvless/sdk, with the same request, retries and errors.