curl --request DELETE \
--url https://api.usenexio.com/api/v1/environments/{slug} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.usenexio.com/api/v1/environments/{slug}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.usenexio.com/api/v1/environments/{slug}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"code": "environment_live_immutable",
"message": "The live environment is managed by the platform and cannot be created or deleted via the API"
}{
"code": "unauthorized",
"message": "Missing or invalid API key"
}{
"code": "insufficient_capability",
"message": "API key does not have permission for this action"
}{
"code": "environment_not_found",
"message": "Environment not found"
}{
"code": "environment_in_use",
"message": "Environment still has bound API keys, webhook endpoints, or runs. Revoke / delete those first.",
"blockers": {
"api_keys": 1,
"webhook_endpoints": 0,
"runs": 37
}
}{
"code": "rate_limited",
"message": "Rate limit exceeded"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "auth_unavailable",
"message": "API key authentication is temporarily unavailable"
}{
"code": "request_timeout",
"message": "Request timed out"
}Delete environment
Delete a sandbox environment that no key, webhook endpoint or run still uses.
curl --request DELETE \
--url https://api.usenexio.com/api/v1/environments/{slug} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.usenexio.com/api/v1/environments/{slug}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.usenexio.com/api/v1/environments/{slug}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"code": "environment_live_immutable",
"message": "The live environment is managed by the platform and cannot be created or deleted via the API"
}{
"code": "unauthorized",
"message": "Missing or invalid API key"
}{
"code": "insufficient_capability",
"message": "API key does not have permission for this action"
}{
"code": "environment_not_found",
"message": "Environment not found"
}{
"code": "environment_in_use",
"message": "Environment still has bound API keys, webhook endpoints, or runs. Revoke / delete those first.",
"blockers": {
"api_keys": 1,
"webhook_endpoints": 0,
"runs": 37
}
}{
"code": "rate_limited",
"message": "Rate limit exceeded"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "auth_unavailable",
"message": "API key authentication is temporarily unavailable"
}{
"code": "request_timeout",
"message": "Request timed out"
}Behavior
- Accepts organization keys only. A scoped key gets
403 insufficient_capability. - The
liveenvironment cannot be deleted:400 environment_live_immutable. - While any API key, webhook endpoint or run references the sandbox, the answer is
409 environment_in_usewith a top-levelblockersobject counting each:
{
"code": "environment_in_use",
"message": "Environment still has bound API keys, webhook endpoints, or runs. Revoke / delete those first.",
"blockers": {
"api_keys": 1,
"webhook_endpoints": 0,
"runs": 37
}
}
- Success is
204with no body.
Authorizations
Send the key as Authorization: Bearer <key>. Two kinds of key exist.
Organization keys are issued in the portal (Settings, then API keys),
each bound to one environment, shaped nx_<environment slug>_<64 hex>. They carry
no capabilities and pass every capability check, with one exception:
routes under /records, /actions, /operations,
/api/v1/engines/{id}/opportunities, /api/v1/graph and
/api/v1/catalog/documents accept an
organization key only when its environment is live, and refuse any
other with 403 scoped_key_required. Revocation takes effect within 60
seconds.
Scoped keys are issued by Nexio on request, shaped
nxsk_v1_<24 hex key id>_<43 character secret>. Each is bound to one
org, one environment, a set of engines and a set of capabilities. A
malformed, unknown or revoked nxsk_ key fails with 401 and is never
retried as an organization key. Revocation takes effect on the next
request. A scoped key without a route's capability gets 403
insufficient_capability; a scoped key not bound to the engine gets 403
engine_binding_forbidden.
Key-grantable capabilities: engines:read, runs:write, runs:read,
runs:defensibility:read, runs:test, catalog:read,
catalog:documents:read, webhooks:manage, conversations:use,
conversations:export, records:read, records:opportunities:run,
actions:write, actions:read, graph:read, records:analyze.
Routes that accept organization keys only (every scoped key gets 403
insufficient_capability): environment management, engine create,
update, configuration and publish, and conversation instance
authoring. Each operation description names the capability a scoped
key needs.
Path Parameters
Response
Environment deleted.