Detector Hub
GET
/v1/hub/detectors/{detector_id}Get Catalog Entry
Get detailed info for a catalog detector.
Runtime, CI or Admin tokenscope: readoperation_id: hub.getDetector
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 |
|---|---|---|---|
| detector_id#path | string | required | — |
Responses
| Status | Description |
|---|---|
| 200 | Successful Response |
| 422 | Validation Error |
Response schema
idrequiredstring
namerequiredstring
display_namerequiredstring
descriptionstring | null
versionrequiredstring
authorstring | null
categorystring | null
tagsstring[] | null
trust_levelrequiredstring
detector_typerequiredstring
install_countinteger
is_publishedboolean
config_schemaobject | null
default_configobject | null
example_payloadsobject[] | null
documentationstring | null
created_atstring | null
updated_atstring | null
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/hub/detectors/00000000-0000-0000-0000-000000000000' \ -H 'Authorization: Bearer $ZNYX_TOKEN'
Response
application/json
Successful Response
{
"id": "string",
"name": "string",
"display_name": "string",
"description": null,
"version": "string",
"author": null,
"category": null,
"tags": null,
"trust_level": "string",
"detector_type": "string",
"install_count": 0,
"is_published": false,
"config_schema": null,
"default_config": null,
"example_payloads": null,
"documentation": null,
"created_at": null,
"updated_at": null
}Schema: object