Success
Unauthorized
Forbidden
Not Found
Validation Failed
RateLimited
InternalError
{- "data": [
- {
- "id": "string",
- "type": "environments",
- "links": {
- "self": "string"
}, - "attributes": {
- "name": "string",
- "description": "string",
- "color": "blue",
- "slug": "string",
- "settings": {
- "delete_protected": true
}
}
}
], - "links": {
- "next": "/2/teams/my-team/api-keys?page[after]=3025fa645ad1100d&page[size]=10"
}
}
Created
The provided request body was invalid. Most APIs will return a DetailedError for this condition, explaining what went wrong, but some older APIs only return a GenericError.
Unauthorized
Forbidden
Not Found
Conflict
The provided request body was over the maximum allowed size.
The provided request body had an invalid Content-Type.
Validation Failed
RateLimited
InternalError
{- "data": {
- "type": "environments",
- "attributes": {
- "name": "string",
- "description": "string",
- "color": "blue"
}
}
}
{- "data": {
- "id": "string",
- "type": "environments",
- "links": {
- "self": "string"
}, - "attributes": {
- "name": "string",
- "description": "string",
- "color": "blue",
- "slug": "string",
- "settings": {
- "delete_protected": true
}
}
}
}
Success
The provided request body was invalid. Most APIs will return a DetailedError for this condition, explaining what went wrong, but some older APIs only return a GenericError.
Unauthorized
Not Found
RateLimited
InternalError
{- "data": {
- "id": "string",
- "type": "environments",
- "links": {
- "self": "string"
}, - "attributes": {
- "name": "string",
- "description": "string",
- "color": "blue",
- "slug": "string",
- "settings": {
- "delete_protected": true
}
}
}
}
Success
The provided request body was invalid. Most APIs will return a DetailedError for this condition, explaining what went wrong, but some older APIs only return a GenericError.
Unauthorized
Forbidden
Not Found
The provided request body was over the maximum allowed size.
The provided request body had an invalid Content-Type.
Validation Failed
RateLimited
InternalError
{- "data": {
- "id": "string",
- "type": "environments",
- "attributes": {
- "description": "string",
- "color": "blue",
- "settings": {
- "delete_protected": true
}
}
}
}
{- "data": {
- "id": "string",
- "type": "environments",
- "links": {
- "self": "string"
}, - "attributes": {
- "name": "string",
- "description": "string",
- "color": "blue",
- "slug": "string",
- "settings": {
- "delete_protected": true
}
}
}
}
This deletes and immediately deactivates the Environment. This is an irreversible operation.
Environments with Deletion Protection enabled cannot be deleted. To delete an Environment with Deletion Protection enabled, first disable Deletion Protection by updating the Environment with settings.delete_protected = false
.
No Content
Unauthorized
Forbidden
Not Found
Conflict
RateLimited
InternalError
{- "error": "unknown API key - check your credentials"
}