Envvar

Manage project environment variables.

Get organizations project envvars

get
/organizations/{organizationId}/projects/{projectId}/settings/envvars

Get organizations project envvars by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/projects/{projectId}/settings/envvars

Create a organization project envvar

post
/organizations/{organizationId}/projects/{projectId}/settings/envvars

Create a organization project envvars by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
namestringRequired

Envvar name, formatted as UPPER_SNAKE_CASE

Example: <name>
valuestringRequired

Envvar value

Example: <value>
envstring · enumRequired

Envvar environment

Example: <env>Possible values:
isSecretbooleanOptional

Envvar is secret

Default: falseExample: <isSecret>
Responses
post
/organizations/{organizationId}/projects/{projectId}/settings/envvars

Get organizations a project envvar

get
/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId}

Get a organization project envvar by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
envvarIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId}

Delete a project envvar

delete
/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId}

Delete a project envvar by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
envvarIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
delete
/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId}

No content

Update a project envvar

patch
/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId}

Update a project envvar by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
envvarIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
valuestringOptional

Envvar value

Example: <value>
Responses
chevron-right
200

OK

application/json
patch
/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId}

Last updated

Was this helpful?