Environments
A set of operations for creating and managing environment resources.
| Endpoint Name | URL | Description |
|---|---|---|
| List environments | GET /core/environments | Returns a list of your existing environments. |
| Create environment | POST /core/environments | Creates an environment. |
| Update environment | PUT /core/environments/{id} | Modifies the name of an existing environment. |
| Retrieve environment details | GET /core/environments/{id} | Retrieves the details of a specified environment. |
| Delete environment | DELETE /core/environments/{id} | Deletes an environment. |
The environments object
Environment endpoints return the environments object, offering comprehensive details about your environments. This includes the environment's name, creation timestamp, region, and ID.
Attributes of the Environment object
status boolean
Indicates the success or failure of the operation. In this case, it is set to true, indicating that the operation has been successful.
message string
A message confirming the status of the operation.
environment object
An object containing details about the environment.
Response
{
"status": true,
"message": "Environment is created successfully",
"environment": {
"id": 2,
"name": "development",
"region": "NORWAY-1",
"created_at": "2023-04-19T05:09:16"
}
}