Retrieves a single environment by its ID.
Request headers
|
Header |
Required |
Description |
|
|
Yes |
|
Path parameters
|
Parameter |
Type |
Required |
Description |
|
|
string |
Yes |
The unique identifier for the environment (prefixed with |
Example request
curl -s -X GET "https://api.qoder.com.cn/api/v1/cloud/environments/env_019e3bb39b6774d8878cd0b9d237574b" \
-H "Authorization: Bearer $QODER_PAT"
Example response
HTTP 200 OK
{
"id": "env_019e3bb39b6774d8878cd0b9d237574b",
"type": "environment",
"name": "doc-test-env",
"description": "",
"status": "ready",
"config": {
"type": "cloud",
"networking": {
"type": "limited"
},
"packages": {
"apt": ["curl"]
}
},
"archived": false,
"archived_at": null,
"created_at": "2026-05-18T15:28:07.017808Z",
"updated_at": "2026-05-18T15:28:07.017808Z"
}
Response fields
|
Field |
Type |
Description |
|
|
string |
The unique identifier for the environment. The value is prefixed with |
|
|
string |
The resource type. The value is always |
|
|
string |
The name of the environment. |
|
|
string |
The description of the environment. |
|
|
string |
The status of the environment. Possible values are |
|
|
object |
The environment configuration object. |
|
|
string |
The environment type. The value is always |
|
|
object |
The network access configuration. |
|
|
object |
The pre-installed package configuration. |
|
|
boolean |
Indicates whether the environment is archived. |
|
|
string|null |
The ISO 8601 timestamp when the environment was archived, or |
|
|
string |
The ISO 8601 timestamp when the environment was created. |
|
|
string |
The ISO 8601 timestamp when the environment was last updated. |
Error codes
|
HTTP |
Type |
Description |
|
401 |
|
Authentication failed. The Personal Access Token (PAT) is invalid or has expired. |
|
403 |
|
You do not have permission to access this resource. |
|
404 |
|
The specified environment does not exist. |