Otoroshi Admin API

Otoroshi Admin API

API version: 1.5.0-dev

Auth

Bearer basic

Base URL

http://otoroshi-api.oto.tools/

Setup

1. Set Authorization header with your Bearer token
2. GET /new/apikey -- verify access
3. POST /api/services/{serviceId}/apikeys -- create first apikeys

Endpoints

102 endpoints across 4 groups. See references/api-spec.lap for full details.

new

lines

api

health

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all apikey?" -> GET /new/apikey
• "List all service?" -> GET /new/service
• "List all group?" -> GET /new/group
• "List all lines?" -> GET /lines
• "List all services?" -> GET /lines/{line}/services
• "List all quotas?" -> GET /api/services/{serviceId}/apikeys/{clientId}/quotas
• "List all group?" -> GET /api/services/{serviceId}/apikeys/{clientId}/group
• "Get apikey details?" -> GET /api/services/{serviceId}/apikeys/{clientId}
• "Update a apikey?" -> PUT /api/services/{serviceId}/apikeys/{clientId}
• "Partially update a apikey?" -> PATCH /api/services/{serviceId}/apikeys/{clientId}
• "Delete a apikey?" -> DELETE /api/services/{serviceId}/apikeys/{clientId}
• "List all apikeys?" -> GET /api/services/{serviceId}/apikeys
• "Create a apikey?" -> POST /api/services/{serviceId}/apikeys
• "List all quotas?" -> GET /api/groups/{groupId}/apikeys/{clientId}/quotas
• "Get apikey details?" -> GET /api/groups/{groupId}/apikeys/{clientId}
• "Update a apikey?" -> PUT /api/groups/{groupId}/apikeys/{clientId}
• "Partially update a apikey?" -> PATCH /api/groups/{groupId}/apikeys/{clientId}
• "Delete a apikey?" -> DELETE /api/groups/{groupId}/apikeys/{clientId}
• "List all apikeys?" -> GET /api/groups/{groupId}/apikeys
• "Create a apikey?" -> POST /api/groups/{groupId}/apikeys
• "List all apikeys?" -> GET /api/apikeys
• "List all template?" -> GET /api/services/{serviceId}/template
• "Create a template?" -> POST /api/services/{serviceId}/template
• "List all targets?" -> GET /api/services/{serviceId}/targets
• "Create a target?" -> POST /api/services/{serviceId}/targets
• "Get service details?" -> GET /api/services/{serviceId}
• "Update a service?" -> PUT /api/services/{serviceId}
• "Partially update a service?" -> PATCH /api/services/{serviceId}
• "Delete a service?" -> DELETE /api/services/{serviceId}
• "List all services?" -> GET /api/services
• "Create a service?" -> POST /api/services
• "List all services?" -> GET /api/groups/{serviceGroupId}/services
• "Get group details?" -> GET /api/groups/{serviceGroupId}
• "Update a group?" -> PUT /api/groups/{serviceGroupId}
• "Partially update a group?" -> PATCH /api/groups/{serviceGroupId}
• "Delete a group?" -> DELETE /api/groups/{serviceGroupId}
• "List all groups?" -> GET /api/groups
• "Create a group?" -> POST /api/groups
• "List all verifiers?" -> GET /api/verifiers
• "Create a verifier?" -> POST /api/verifiers
• "Get verifier details?" -> GET /api/verifiers/{verifierId}
• "Delete a verifier?" -> DELETE /api/verifiers/{verifierId}
• "Update a verifier?" -> PUT /api/verifiers/{verifierId}
• "Partially update a verifier?" -> PATCH /api/verifiers/{verifierId}
• "List all auths?" -> GET /api/auths
• "Create a auth?" -> POST /api/auths
• "Get auth details?" -> GET /api/auths/{id}
• "Delete a auth?" -> DELETE /api/auths/{id}
• "Update a auth?" -> PUT /api/auths/{id}
• "Partially update a auth?" -> PATCH /api/auths/{id}
• "Create a _compile?" -> POST /api/scripts/_compile
• "Get script details?" -> GET /api/scripts/{scriptId}
• "Update a script?" -> PUT /api/scripts/{scriptId}
• "Partially update a script?" -> PATCH /api/scripts/{scriptId}
• "Delete a script?" -> DELETE /api/scripts/{scriptId}
• "List all scripts?" -> GET /api/scripts
• "Create a script?" -> POST /api/scripts
• "List all _template?" -> GET /api/data-exporter-configs/_template
• "Create a _bulk?" -> POST /api/data-exporter-configs/_bulk
• "Get data-exporter-config details?" -> GET /api/data-exporter-configs/{dataExporterConfigId}
• "Update a data-exporter-config?" -> PUT /api/data-exporter-configs/{dataExporterConfigId}
• "Partially update a data-exporter-config?" -> PATCH /api/data-exporter-configs/{dataExporterConfigId}
• "Delete a data-exporter-config?" -> DELETE /api/data-exporter-configs/{dataExporterConfigId}
• "List all data-exporter-configs?" -> GET /api/data-exporter-configs
• "Create a data-exporter-config?" -> POST /api/data-exporter-configs
• "List all certificates?" -> GET /api/certificates
• "Create a certificate?" -> POST /api/certificates
• "Get certificate details?" -> GET /api/certificates/{id}
• "Delete a certificate?" -> DELETE /api/certificates/{id}
• "Update a certificate?" -> PUT /api/certificates/{id}
• "Partially update a certificate?" -> PATCH /api/certificates/{id}
• "List all client-validators?" -> GET /api/client-validators
• "Create a client-validator?" -> POST /api/client-validators
• "Get client-validator details?" -> GET /api/client-validators/{id}
• "Delete a client-validator?" -> DELETE /api/client-validators/{id}
• "Update a client-validator?" -> PUT /api/client-validators/{id}
• "Partially update a client-validator?" -> PATCH /api/client-validators/{id}
• "List all config?" -> GET /api/snowmonkey/config
• "List all outages?" -> GET /api/snowmonkey/outages
• "Create a _start?" -> POST /api/snowmonkey/_start
• "Create a _stop?" -> POST /api/snowmonkey/_stop
• "Get live details?" -> GET /api/live/{id}
• "List all live?" -> GET /api/live
• "List all globalconfig?" -> GET /api/globalconfig
• "List all otoroshi.json?" -> GET /api/otoroshi.json
• "Create a otoroshi.json?" -> POST /api/otoroshi.json
• "Create a import?" -> POST /api/import
• "List all health?" -> GET /health
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP