ScalixScalix Docs

Environment API

Project-level environment variables

REST API endpoints for Environment. 4 operations.

List environment variables

plaintext
GET /v1/env

Returns all project-level environment variables (secret values masked).

Auth: Bearer API key

Responses

StatusDescription
200All project environment variables
401Missing or invalid credentials
500Internal error

operationId: listEnvVars

Set an environment variable

plaintext
POST /v1/env

Creates or updates a single project-level environment variable.

Auth: Bearer API key

Request body

application/json (required) — schema SetEnvBody.

Responses

StatusDescription
200Variable created or updated
401Missing or invalid credentials
500Internal error

operationId: setEnvVar

Delete an environment variable

plaintext
DELETE /v1/env/{id}

Removes a project-level environment variable by id.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
idpathstringYesEnvironment variable id

Responses

StatusDescription
200Variable deleted
401Missing or invalid credentials
404Variable not found
500Internal error

operationId: deleteEnvVar

Bulk-import environment variables

plaintext
POST /v1/env/bulk

Imports many project-level environment variables in one request.

Auth: Bearer API key

Request body

application/json (required) — schema BulkImportBody.

Responses

StatusDescription
200Variables imported
401Missing or invalid credentials
500Internal error

operationId: bulkImportEnvVars