Read environment configuration without secret values
curl --request GET \
--url https://api.coderabbit.ai/v1/code/environments/{environmentId} \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/code/environments/{environmentId}"
headers = {"x-coderabbitai-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '<api-key>'}};
fetch('https://api.coderabbit.ai/v1/code/environments/{environmentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"environment": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "preparing",
"packages": [
{
"id": "python",
"version": "<string>"
}
],
"revision": 123,
"configurationVersion": "<string>",
"preparedRevision": 123,
"activeSnapshotRecordId": "<string>",
"repositoryCount": 123,
"createdAt": "<string>",
"updatedAt": "<string>",
"archivedAt": "<string>"
},
"repositories": [
{
"id": "<string>",
"environmentId": "<string>",
"repositoryProvider": "<string>",
"repositoryId": "<string>",
"repositoryName": "<string>",
"status": "preparing",
"machineSize": "<string>",
"setupMethod": "<string>",
"setupScript": "<string>",
"startupScript": "<string>",
"startupInstructions": "<string>",
"configRevision": 123,
"preparedRevision": 123,
"setupAgentTaskId": "<string>",
"lastPreparedAt": "<string>",
"lastError": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"variables": [
{
"id": "<string>",
"name": "<string>",
"isSecret": true,
"value": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
]
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 1
}
}Read environment configuration without secret values
Returns one environment that is not archived, with its attached repositories and variables. Secret variable values are returned as null; other variable values are decrypted.
GET
/
v1
/
code
/
environments
/
{environmentId}
Read environment configuration without secret values
curl --request GET \
--url https://api.coderabbit.ai/v1/code/environments/{environmentId} \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/code/environments/{environmentId}"
headers = {"x-coderabbitai-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '<api-key>'}};
fetch('https://api.coderabbit.ai/v1/code/environments/{environmentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"environment": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "preparing",
"packages": [
{
"id": "python",
"version": "<string>"
}
],
"revision": 123,
"configurationVersion": "<string>",
"preparedRevision": 123,
"activeSnapshotRecordId": "<string>",
"repositoryCount": 123,
"createdAt": "<string>",
"updatedAt": "<string>",
"archivedAt": "<string>"
},
"repositories": [
{
"id": "<string>",
"environmentId": "<string>",
"repositoryProvider": "<string>",
"repositoryId": "<string>",
"repositoryName": "<string>",
"status": "preparing",
"machineSize": "<string>",
"setupMethod": "<string>",
"setupScript": "<string>",
"startupScript": "<string>",
"startupInstructions": "<string>",
"configRevision": 123,
"preparedRevision": 123,
"setupAgentTaskId": "<string>",
"lastPreparedAt": "<string>",
"lastError": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"variables": [
{
"id": "<string>",
"name": "<string>",
"isSecret": true,
"value": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
]
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 1
}
}- CLI Tool
- MCP Server
coderabbit api request "/code/environments/$ENVIRONMENT_ID"
An agent connected to the CodeRabbit MCP server runs this operation as the
get_code_environment tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "get_code_environment",
"arguments": {
"environmentId": "<environmentId>"
}
}
}
Authorizations
See Authentication for the key types and where to create a key.
Query Parameters
Organization for a workspace key: the Git-provider organization ID (scope.provider_organization_id) or the CodeRabbit organization ID (scope.id, or id from list organizations). Supply either org_id or org_name, never both. Omit for organization keys and MCP connections.
Minimum string length:
1Was this page helpful?