Create an environment (the controller provisions its namespace).

POST

/api/v1/projects/{project}/environments

curl --request POST \
  --url https://example.com/api/v1/projects/example/environments \
  --header 'Content-Type: application/json' \
  --data '{ "name": "prod", "env_type": "standard", "quota": { "cpu": "4", "memory": "8Gi", "pods": 50 } }'

Parameters

Path Parameters

project

required

string

Project name

Request Body^required

Media typeapplication/json

object

name

required

Short name, e.g. prod (the object is named <project>-<name>).

string

Example

prod

env_type

string

Allowed values: standard production preview

quota

One of:

null

null

object

object

cpu

string | null

Example

4

memory

string | null

Example

8Gi

pods

integer | null format: int32

Example

50

Responses

201

Media typeapplication/json

object

name

required

Short name used in URLs, e.g. prod.

string

resource_name

required

Kubernetes object name, e.g. shop-prod.

string

project

required

string

env_type

required

standard, production or preview.

string

namespace

required

string

phase

Pending, Ready, Terminating or Degraded.

string | null

ready

required

boolean

message

string | null

deleting

required

boolean

deletion_scheduled_at

When a soft-deleted environment will be purged.

string | null

created_at

string | null

Example^generated

{
  "name": "example",
  "resource_name": "example",
  "project": "example",
  "env_type": "example",
  "namespace": "example",
  "phase": "example",
  "ready": true,
  "message": "example",
  "deleting": true,
  "deletion_scheduled_at": "example",
  "created_at": "example"
}

403

Media typeapplication/json

Problem Details body.

object

code

required

Stable machine-readable code, e.g. forbidden.

string

title

required

Short human readable title.

string

status

required

HTTP status.

integer format: int32

detail

Details, if safe to expose.

string | null

Example

{
  "code": "forbidden"
}

409

Media typeapplication/json

Problem Details body.

object

code

required

Stable machine-readable code, e.g. forbidden.

string

title

required

Short human readable title.

string

status

required

HTTP status.

integer format: int32

detail

Details, if safe to expose.

string | null

Example

{
  "code": "forbidden"
}

422

Media typeapplication/json

Problem Details body.

object

code

required

Stable machine-readable code, e.g. forbidden.

string

title

required

Short human readable title.

string

status

required

HTTP status.

integer format: int32

detail

Details, if safe to expose.

string | null

Example

{
  "code": "forbidden"
}

503

No cluster configured

Media typeapplication/json

Problem Details body.

object

code

required

Stable machine-readable code, e.g. forbidden.

string

title

required

Short human readable title.

string

status

required

HTTP status.

integer format: int32

detail

Details, if safe to expose.

string | null

Example

{
  "code": "forbidden"
}