Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

environments

Manage the environments on your account — named, isolated spaces (Production plus any non-production environments) that segregate connections, flows, and other resources by lifecycle stage.

REST API: Environments

celigo environments <subcommand> [flags]

Supports all global flags.

Subcommands

Subcommand
Purpose

list

List every environment configured on the account.

get

Fetch a single environment by ID.

create

Create a new environment from a JSON body (--file <path> or stdin).

update

Replace an environment's mutable fields from a JSON body (--file <path> or stdin).

set

Patch one or more fields on an environment without re-sending the full document.

enable

Enable an environment (no-op if already enabled).

disable

Disable an environment (no-op if already disabled).

delete is intentionally absent — see Gotchas.

celigo environments list

List all environments in the account.

Signature

Arguments

None.

Flags

None beyond the global flags (--format, --jq, --profile, --verbose).

Example

Default table columns: _id, name, lastModified.

Corresponds to: GET /v1/environments

celigo environments get

Fetch a single environment by its ID.

Signature

Arguments

Argument
Required
Description

<id>

Yes

Environment _id (24-character hex).

Flags

None beyond the global flags.

Example

Corresponds to: GET /v1/environments/{_id}

celigo environments create

Create a new environment from a JSON document. Read the body from a file with -f, --file or pipe it on stdin. name is required; description and apim metadata are optional.

Signature

Arguments

None. The request body comes from --file or stdin.

Flags

Flag
Type
Default
Description

-f, --file <path>

string

—

Read the JSON body from a file instead of stdin (--file - also means stdin). Added in celigo-cli 2026.6.1.

Plus the global flags. Blocked in read mode.

Example

Corresponds to: POST /v1/environments

celigo environments update

Replace an environment with a JSON document. Read the body from a file with -f, --file or pipe it on stdin. PUT is a full replace — omitted fields are cleared.

⚠️ PUT fully replaces the environment. Any field omitted from the body is cleared. GET the environment first, edit, then send the complete object back — or use set for targeted field edits.

Signature

Arguments

Argument
Required
Description

<id>

Yes

Environment _id to replace.

Flags

Flag
Type
Default
Description

-f, --file <path>

string

—

Read the JSON body from a file instead of stdin (--file - also means stdin). Added in celigo-cli 2026.6.1.

--force

boolean

false

Submit even if the body contains masked credential values (***) copied from a GET.

Plus the global flags. Blocked in read mode.

Example

Corresponds to: PUT /v1/environments/{_id}

celigo environments set

Patch one or more fields on an environment. Whitelisted fields (e.g. name) are applied via an atomic PATCH; other fields go through GET → apply assignments → PUT to avoid clobbering fields you don't intend to change.

Signature

Arguments

Argument
Required
Description

<id>

Yes

Environment _id to modify.

<key=value>

Yes (≥1)

One or more assignments. Values are auto-parsed as JSON — null removes the field. Dot notation (apim.environmentHRID=prod) is supported. Array indexing does not apply here — no Environment field is an array.

Flags

None beyond the global flags. Blocked in read mode.

Examples

Corresponds to: GET /v1/environments/{_id} followed by PUT /v1/environments/{_id}.

celigo environments enable

Enable an environment. No-op if it is already enabled.

Signature

Arguments

Argument
Required
Description

<id>

Yes

Environment _id to enable.

Flags

None beyond the global flags. Blocked in read mode.

Example

Corresponds to: PUT /v1/environments/{_id}/enable (operationId: toggleEnvironment)

celigo environments disable

Disable an environment. No-op if it is already disabled. The Production environment cannot be disabled.

⚠️ Disabling an environment takes it out of service. The environment is unavailable until you re-enable it with enable. The Production environment cannot be disabled.

Signature

Arguments

Argument
Required
Description

<id>

Yes

Environment _id to disable.

Flags

None beyond the global flags. Blocked in read mode.

Example

Corresponds to: PUT /v1/environments/{_id}/enable (operationId: toggleEnvironment)

Gotchas

  • No delete subcommand. There is no public delete endpoint for environments. Delete environments through the UI, which warns about the downstream cascade (connections, flows, integrations) before the operation proceeds.

  • Toggle enabled with enable/disable, not set/update. The enabled flag is managed through the dedicated enable / disable subcommands; including it in a create/update/set body is ignored. _envUserId is likewise system-managed and read-only.

  • APIM metadata is usually provisioned for you. The apim.environmentId, apim.environmentHRID, and apim.groupId fields are normally populated by API-management workflows. Only set them if you are explicitly configuring APIM for this environment.

  • Resources don't cross environments. A flow can reference only the connections, exports, imports, and scripts that live in the same environment — keep every resource aligned with its environment.

Related

  • integrations — integrations live inside a single environment.

  • connections — connections belong to one environment and can only be used by resources in that same environment.

  • stacks — reusable execution environments for NetSuite/custom JavaScript; a separate concept despite the overlapping terminology.

Previousend-users
Nextevent-reports

Last updated

Was this helpful?