Docs

Create Environment

Add an environment, like Staging, to run workflows and map connections against.

POST

Headers

Optional headers
string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Body

Arguments
stringrequired

The environment name, up to 255 characters.

Response fields

idstring

Unique id of the environment. Use it to filter runs.

namestring

The environment's name, like Production or Sandbox.

isDefaultboolean

True for the default environment.

workflowCountnumber

How many scheduled workflows target it.

createdOndate

When the environment was created.