Environments Management API reference
Complete reference documentation for the Environments resource.
Environments
#Knock uses the concept of environments to ensure logical separation of your data. Dashboard resources are created in your development environment and promoted to higher environments.
List environments
#Returns a paginated list of environments. The environments will be returned in order of their index, with the development environment first.
Endpoint
Query parameters
The cursor to fetch entries after.
The cursor to fetch entries before.
The number of entries to fetch per-page.
Returns
A paginated list of Environment. Contains a list of entries and page information.
A list of entries.
The timestamp of when the environment was created.
The timestamp of when the environment was deleted.
Whether PII data is hidden from the environment. Read more in the data obfuscation docs.
The color of the environment label to display in the dashboard.
The timestamp of the most-recent commit in the environment.
A human-readable name for the environment. Cannot exceed 255 characters.
The order of the environment. The lowest number is the first environment, the highest number is the last environment. The order will not always be sequential.
The owner of the environment.
A unique slug for the environment. Cannot exceed 255 characters.
The timestamp of when the environment was last updated.
The information about a paginated result.
The cursor to fetch entries after. Will only be present if there are more entries to fetch.
The cursor to fetch entries before. Will only be present if there are more entries to fetch before the current page.
The number of entries to fetch per-page.
Get an environment
#Returns a single environment by the environment_slug.
Endpoint
Path parameters
The slug of the environment to retrieve.
Returns
An environment object.
The timestamp of when the environment was created.
The timestamp of when the environment was deleted.
Whether PII data is hidden from the environment. Read more in the data obfuscation docs.
The color of the environment label to display in the dashboard.
The timestamp of the most-recent commit in the environment.
A human-readable name for the environment. Cannot exceed 255 characters.
The order of the environment. The lowest number is the first environment, the highest number is the last environment. The order will not always be sequential.
The owner of the environment.
A unique slug for the environment. Cannot exceed 255 characters.
The timestamp of when the environment was last updated.
Environment
#An environment object.
Attributes
The timestamp of when the environment was created.
The timestamp of when the environment was deleted.
Whether PII data is hidden from the environment. Read more in the data obfuscation docs.
The color of the environment label to display in the dashboard.
The timestamp of the most-recent commit in the environment.
A human-readable name for the environment. Cannot exceed 255 characters.
The order of the environment. The lowest number is the first environment, the highest number is the last environment. The order will not always be sequential.
The owner of the environment.
A unique slug for the environment. Cannot exceed 255 characters.
The timestamp of when the environment was last updated.