Reference · Environment
Read environment status
Confirm the environment your key opens and its current status.
GET/v1/environment
Authorization: Bearer ak_test_… · Application API key
Send this read against a real sandbox bench leased to you. Nothing is simulated; the response is live.
GET /v1/environment
Key capabilities
- EnvironmentStatusRead
Wire receipt
Captured from the real gateway by the scenario suite; nothing here is composed by hand.
Read the environment status; the response names the organisation, application, and environment your key is scoped to.
Request
GET /v1/environment Authorization: Bearer ak_test_…
Response · 200
{
"status": 200,
"body": {
"value": {
"organisationRef": "00000000-0000-0000-0000-000000000001",
"applicationRef": "00000000-0000-0000-0000-000000000002",
"environmentRef": "00000000-0000-0000-0000-000000000003",
"environmentKind": "DemoSandbox",
"displayName": "Alpine Local Demo",
"appStatus": "Active",
"environmentStatus": "Active",
"allowedActions": [
"ViewEnvironmentShell"
],
"unavailableParts": [
"ApiKeys",
"Readiness",
"Accounts",
"Transactions",
"Events",
"Receipts",
"Transfers"
]
},
"freshness": "Current",
"visibility": "Full",
"evidence": [
{
"receiptRef": "00000000-0000-0000-0000-0000000000cd",
"source": "VaeRuntime"
},
{
"receiptRef": "00000000-0000-0000-0000-0000000000ce",
"source": "VaeRuntime"
}
]
},
"evidence": [
{
"receiptRef": "00000000-0000-0000-0000-0000000000cd"
},
{
"receiptRef": "00000000-0000-0000-0000-0000000000ce"
}
]
}captured 2026-07-13 · gateway 0.1.0 · First credit · Prove the key
Refused requests
Refusals are stated as plainly as capabilities; these were captured live, the same way.
A request without a usable key is refused at the door; nothing downstream ever sees it.
Request
GET /v1/environment Authorization: Bearer ak_test_invalid_0000
Response · 401
{
"status": 401,
"problem": {
"kind": "Unauthorized",
"status": 401,
"code": "unauthorized-PermissionDenied",
"message": "PermissionDenied",
"evidence": []
},
"evidence": []
}captured 2026-07-11 · gateway 0.1.0 · The gate holds · No key, no entry
See also
generated from openapi.json · gateway 0.1.0 · sandbox