Output Schemas
GET
/v1/orgs/{org_id}/schemas/by-name/{schema_name}/usageSchema Usage Detail
Return every active policy scope whose `structure.schema_name` matches.
Runtime, CI or Admin tokenscope: readoperation_id: schemas.usageByName
Authentication
Any bearer token belonging to the org can read this endpoint.
SDK install
pip install znyx-sdknpm install @znyx/sdkPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
| org_id#path | string | required | — |
| schema_name#path | string | required | — |
Header parameters
| Name | Type | Required | Description |
|---|---|---|---|
| X-API-Key#header | string | null | optional | — |
| authorization#header | string | null | optional | — |
Responses
| Status | Description |
|---|---|
| 200 | Successful Response |
| 422 | Validation Error |
Response schema
schema_namerequiredstring
countrequiredinteger
scopesrequired
Errors & what triggers them
| Code | Trigger | Fix |
|---|---|---|
| 401 | Missing or expired Authorization header. | — |
| 403 | Token does not have org access (wrong org_id, or insufficient role). | — |
| 404 | Resource does not exist in this org. | — |
Request
curl -X GET 'https://api.znyx.ai/v1/orgs/00000000-0000-0000-0000-000000000000/schemas/by-name/<schema_name>/usage' \ -H 'Authorization: Bearer $ZNYX_TOKEN'
Response
application/json
Successful Response
{
"schema_name": "string",
"count": 0,
"scopes": [
{
"tenant_id": "string",
"project_id": null,
"project_slug": null,
"project_name": null,
"agent_id": "string",
"env": "string",
"policy_version": null,
"updated_at": null
}
]
}Schema: object