API by router
Debug access
GET
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidlimit?LimitDefault
50X-Api-Key?string|nullSuccessful Response
application/json- response
entries*array<>total*Totalcurl -X GET 'https://example.com/v1/debug-access/audit/497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
{ "entries": [ { "action": "string", "actor_email": "string", "actor_id": "04f37679-bfbf-4906-b749-01756515cecf", "created_at": "2019-08-24T14:15:22Z", "details": "string", "grant_id": "a3c1da8e-13c6-4cab-955b-2120b58c2982", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366", "ip_address": "string" } ], "total": 0}POST
HTTPBearerheader
AuthorizationBearer <token>X-Api-Key?string|nullapplication/json- body
duration_hours*Duration HoursRange
1 <= value <= 168instance_id*Instance IdFormat
uuidreason?|nullSuccessful Response
application/json- response
duration_hours*Duration Hoursexpires_at*Expires AtFormat
date-timegranted_at*Granted AtFormat
date-timegranted_by*|nullid*IdFormat
uuidinstance_id*Instance IdFormat
uuidis_active*Is Activereason*string|nullrevoked_at*|nullrevoked_by*|nulltime_remaining_seconds*integer|nullcurl -X POST 'https://example.com/v1/debug-access/grant' \ -H 'Content-Type: application/json' \ -d '{ "duration_hours": 1, "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366"}'Example Response
{ "duration_hours": 0, "expires_at": "2019-08-24T14:15:22Z", "granted_at": "2019-08-24T14:15:22Z", "granted_by": "a8e4a498-f971-4203-a849-4967743579d4", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366", "is_active": true, "reason": "string", "revoked_at": "2019-08-24T14:15:22Z", "revoked_by": "609d09bf-be33-45e0-963a-ff4cf608e85c", "time_remaining_seconds": 0}curl -X GET 'https://example.com/v1/debug-access/presets'Example Response200
[ {}]POST
HTTPBearerheader
AuthorizationBearer <token>grant_id*Grant IdFormat
uuidX-Api-Key?string|nullapplication/json- body
reason?|nullSuccessful Response
application/json- response
duration_hours*Duration Hoursexpires_at*Expires AtFormat
date-timegranted_at*Granted AtFormat
date-timegranted_by*|nullid*IdFormat
uuidinstance_id*Instance IdFormat
uuidis_active*Is Activereason*string|nullrevoked_at*|nullrevoked_by*|nulltime_remaining_seconds*integer|nullcurl -X POST 'https://example.com/v1/debug-access/revoke/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "duration_hours": 0, "expires_at": "2019-08-24T14:15:22Z", "granted_at": "2019-08-24T14:15:22Z", "granted_by": "a8e4a498-f971-4203-a849-4967743579d4", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366", "is_active": true, "reason": "string", "revoked_at": "2019-08-24T14:15:22Z", "revoked_by": "609d09bf-be33-45e0-963a-ff4cf608e85c", "time_remaining_seconds": 0}GET
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullSuccessful Response
application/json- response
Current debug access status for an instance.
active_grant*|nullduration_presets*array<>has_active_grant*Has Active Granthostname*Hostnameinstance_id*Instance IdFormat
uuidrecent_grants*array<>curl -X GET 'https://example.com/v1/debug-access/status/497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
{ "active_grant": { "duration_hours": 0, "expires_at": "2019-08-24T14:15:22Z", "granted_at": "2019-08-24T14:15:22Z", "granted_by": "a8e4a498-f971-4203-a849-4967743579d4", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366", "is_active": true, "reason": "string", "revoked_at": "2019-08-24T14:15:22Z", "revoked_by": "609d09bf-be33-45e0-963a-ff4cf608e85c", "time_remaining_seconds": 0 }, "duration_presets": [ {} ], "has_active_grant": true, "hostname": "string", "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366", "recent_grants": [ { "duration_hours": 0, "expires_at": "2019-08-24T14:15:22Z", "granted_at": "2019-08-24T14:15:22Z", "granted_by": "a8e4a498-f971-4203-a849-4967743579d4", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366", "is_active": true, "reason": "string", "revoked_at": "2019-08-24T14:15:22Z", "revoked_by": "609d09bf-be33-45e0-963a-ff4cf608e85c", "time_remaining_seconds": 0 } ]}