Otoroshi Admin API
Admin API of the Otoroshi reverse proxy
Developer tools#openapi#developer-tools
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Admin API of the Otoroshi reverse proxy
Endpoints 102
configuration
- GETGet the full configuration of Otoroshi
/api/globalconfigGet the full configuration of Otoroshi - PUTUpdate the global configuration
/api/globalconfigUpdate the global configuration - PATCHUpdate the global configuration with a diff
/api/globalconfigUpdate the global configuration with a diff
import
- POSTImport the full state of Otoroshi as a file
/api/importImport the full state of Otoroshi as a file - GETExport the full state of Otoroshi
/api/otoroshi.jsonExport the full state of Otoroshi - POSTImport the full state of Otoroshi
/api/otoroshi.jsonImport the full state of Otoroshi
templates
- GETGet a template of an Otoroshi Api Key
/new/apikeyGet a template of an Otoroshi Api Key. The generated entity is not persisted - GETGet a template of an Otoroshi service group
/new/groupGet a template of an Otoroshi service group. The generated entity is not persisted - GETGet a template of an Otoroshi service descriptor
/new/serviceGet a template of an Otoroshi service descriptor. The generated entity is not persisted
environments
- GETGet all environments
/linesGet all environments provided by the current Otoroshi instance - GETGet all services for an environment
/lines/:line/servicesGet all services for an environment provided by the current Otoroshi instance
groups
- GETGet all service groups
/api/groupsGet all service groups - POSTCreate a new service group
/api/groupsCreate a new service group - GETGet a service group
/api/groups/:serviceGroupIdGet a service group - PUTUpdate a service group
/api/groups/:serviceGroupIdUpdate a service group - DELETEDelete a service group
/api/groups/:serviceGroupIdDelete a service group - PATCHUpdate a service group with a diff
/api/groups/:serviceGroupIdUpdate a service group with a diff
apikeys
- GETGet all api keys
/api/apikeysGet all api keys - GETGet all api keys for the group of a service
/api/groups/:groupId/apikeysGet all api keys for the group of a service - POSTCreate a new api key for a group
/api/groups/:groupId/apikeysCreate a new api key for a group - GETGet an api key
/api/groups/:groupId/apikeys/:clientIdGet an api key for a specified service group - PUTUpdate an api key
/api/groups/:groupId/apikeys/:clientIdUpdate an api key for a specified service group - DELETEDelete an api key
/api/groups/:groupId/apikeys/:clientIdDelete an api key for a specified service group - PATCHUpdate an api key with a diff
/api/groups/:groupId/apikeys/:clientIdUpdate an api key for a specified service descriptor with a diff - GETGet the quota state of an api key
/api/groups/:groupId/apikeys/:clientId/quotasGet the quota state of an api key - DELETEReset the quota state of an api key
/api/groups/:groupId/apikeys/:clientId/quotasReset the quota state of an api key - GETGet all api keys for the group of a service
/api/services/:serviceId/apikeysGet all api keys for the group of a service - POSTCreate a new api key for a service
/api/services/:serviceId/apikeys - GETGet an api key
/api/services/:serviceId/apikeys/:clientIdGet an api key for a specified service descriptor - PUTUpdate an api key
/api/services/:serviceId/apikeys/:clientIdUpdate an api key for a specified service descriptor - DELETEDelete an api key
/api/services/:serviceId/apikeys/:clientIdDelete an api key for a specified service descriptor - PATCHUpdate an api key with a diff
/api/services/:serviceId/apikeys/:clientIdUpdate an api key for a specified service descriptor with a diff - GETGet the group of an api key
/api/services/:serviceId/apikeys/:clientId/groupGet the group of an api key - GETGet the quota state of an api key
/api/services/:serviceId/apikeys/:clientId/quotasGet the quota state of an api key - DELETEReset the quota state of an api key
/api/services/:serviceId/apikeys/:clientId/quotasReset the quota state of an api key
services
- GETGet all services descriptor for a group
/api/groups/:serviceGroupId/servicesGet all services descriptor for a group - GETGet all services
/api/servicesGet all services - POSTCreate a new service descriptor
/api/servicesCreate a new service descriptor - GETGet a service descriptor
/api/services/:serviceIdGet a service descriptor - PUTUpdate a service descriptor
/api/services/:serviceIdUpdate a service descriptor - DELETEDelete a service descriptor
/api/services/:serviceIdDelete a service descriptor - PATCHUpdate a service descriptor with a diff
/api/services/:serviceIdUpdate a service descriptor with a diff - GETGet a service descriptor targets
/api/services/:serviceId/targetsGet a service descriptor targets - POSTAdd a target to a service descriptor
/api/services/:serviceId/targetsAdd a target to a service descriptor - DELETEDelete a service descriptor target
/api/services/:serviceId/targetsDelete a service descriptor target - PATCHUpdate a service descriptor targets
/api/services/:serviceId/targetsUpdate a service descriptor targets - GETGet a service descriptor error template
/api/services/:serviceId/templateGet a service descriptor error template - PUTUpdate an error template to a service descriptor
/api/services/:serviceId/templateUpdate an error template to a service descriptor - POSTCreate a service descriptor error template
/api/services/:serviceId/templateUpdate a service descriptor targets - DELETEDelete a service descriptor error template
/api/services/:serviceId/templateDelete a service descriptor error template
stats
- GETGet global otoroshi stats
/api/liveGet global otoroshi stats - GETGet live feed of otoroshi stats
/api/live/:idGet live feed of global otoroshi stats (global) or for a service {id}
snowmonkey
- POSTStart the Snow Monkey
/api/snowmonkey/_startStart the Snow Monkey - POSTStop the Snow Monkey
/api/snowmonkey/_stopStop the Snow Monkey - GETGet current Snow Monkey config
/api/snowmonkey/configGet current Snow Monkey config - PUTUpdate current Snow Monkey config
/api/snowmonkey/configUpdate current Snow Monkey config - PATCHUpdate current Snow Monkey config
/api/snowmonkey/configUpdate current Snow Monkey config - GETGet all current Snow Monkey ourages
/api/snowmonkey/outagesGet all current Snow Monkey ourages - DELETEReset Snow Monkey Outages for the day
/api/snowmonkey/outagesReset Snow Monkey Outages for the day
health
- GETReturn current Otoroshi health
/healthImport the full state of Otoroshi as a file
jwt-verifiers
- GETGet all global JWT verifiers
/api/verifiersGet all global JWT verifiers - POSTCreate one global JWT verifiers
/api/verifiersCreate one global JWT verifiers - GETGet one global JWT verifiers
/api/verifiers/:verifierIdGet one global JWT verifiers - PUTUpdate one global JWT verifiers
/api/verifiers/:verifierIdUpdate one global JWT verifiers - DELETEDelete one global JWT verifiers
/api/verifiers/:verifierIdDelete one global JWT verifiers - PATCHUpdate one global JWT verifiers
/api/verifiers/:verifierIdUpdate one global JWT verifiers
auth-config
- GETGet all global auth. module configs
/api/authsGet all global auth. module configs - POSTCreate one global auth. module config
/api/authsCreate one global auth. module config - GETGet one global auth. module configs
/api/auths/:idGet one global auth. module configs - PUTUpdate one global auth. module config
/api/auths/:idUpdate one global auth. module config - DELETEDelete one global auth. module config
/api/auths/:idDelete one global auth. module config - PATCHUpdate one global auth. module config
/api/auths/:idUpdate one global auth. module config
scripts
- GETGet all scripts
/api/scriptsGet all scripts - POSTCreate a new script
/api/scriptsCreate a new script - POSTCompile a script
/api/scripts/_compileCompile a script - GETGet a script
/api/scripts/:scriptIdGet a script - PUTUpdate a script
/api/scripts/:scriptIdUpdate a script - DELETEDelete a script
/api/scripts/:scriptIdDelete a script - PATCHUpdate a script with a diff
/api/scripts/:scriptIdUpdate a script with a diff
certificates
- GETGet all certificates
/api/certificatesGet all certificates - POSTCreate one certificate
/api/certificatesCreate one certificate - GETGet one certificate by id
/api/certificates/:idGet one certificate by id - PUTUpdate one certificate by id
/api/certificates/:idUpdate one certificate by id - DELETEDelete one certificate by id
/api/certificates/:idDelete one certificate by id - PATCHUpdate one certificate by id
/api/certificates/:idUpdate one certificate by id
validation-authorities
- GETGet all validation authoritiess
/api/client-validatorsGet all validation authoritiess - POSTCreate one validation authorities
/api/client-validatorsCreate one validation authorities - GETGet one validation authorities by id
/api/client-validators/:idGet one validation authorities by id - PUTUpdate one validation authorities by id
/api/client-validators/:idUpdate one validation authorities by id - DELETEDelete one validation authorities by id
/api/client-validators/:idDelete one validation authorities by id - PATCHUpdate one validation authorities by id
/api/client-validators/:idUpdate one validation authorities by id
data-exporter-configs
- GETGet all data exporter configs
/api/data-exporter-configsGet all data exporter configs - POSTCreate a new data exporter config
/api/data-exporter-configsCreate a new data exporter config - PUTUpdate a data exporter configs
/api/data-exporter-configs/_bulkUpdate a data exporter configs - POSTCreate a new data exporter configs
/api/data-exporter-configs/_bulkCreate a new data exporter configs - DELETEDelete a data exporter config
/api/data-exporter-configs/_bulkDelete a data exporter config - PATCHUpdate a data exporter configs with a diff
/api/data-exporter-configs/_bulkUpdate a data exporter configs with a diff - GETGet all data exporter configs
/api/data-exporter-configs/_template?type=stringGet all data exporter configs - GETGet a data exporter config
/api/data-exporter-configs/:dataExporterConfigIdGet a data exporter config - PUTUpdate a data exporter config
/api/data-exporter-configs/:dataExporterConfigIdUpdate a data exporter config - DELETEDelete a data exporter config
/api/data-exporter-configs/:dataExporterConfigIdDelete a data exporter config - PATCHUpdate a data exporter config with a diff
/api/data-exporter-configs/:dataExporterConfigIdUpdate a data exporter config with a diff
API details
- Base URL
http://otoroshi-api.oto.toolshttp://maif.local- Authentication
- HTTP Basic authentication (username and password)
- Operations
- 102 operations on 45 pathsGET 40POST 18DELETE 16PUT 14PATCH 14
- Main resources
- apikeys 18services 15data-exporter-configs 11scripts 7snowmonkey 7auth-config 6certificates 6groups 6jwt-verifiers 6validation-authorities 6
- Response formats
application/jsontext/event-stream- Description format
- OpenAPI 3.0.0, API version
1.5.0-dev - Links
- Documentation · OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Otoroshi Admin API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Otoroshi Admin API collection, without the publisher's secrets.
- Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get the full configuration of Otoroshi” (GET /api/globalconfig), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Otoroshi Admin API?
Admin API of the Otoroshi reverse proxy It is listed under Developer tools and has 102 endpoints.
Who publishes the Otoroshi Admin API?
It is listed from Maif's public API description (an OpenAPI document), not published by Maif on Swastik Codes. Anyone who controls its domain can claim the profile by adding a DNS TXT record.
What is the base URL of the Otoroshi Admin API?
Its description lists 2 base URLs: http://otoroshi-api.oto.tools, http://maif.local. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Otoroshi Admin API?
With HTTP Basic authentication (username and password).
How many endpoints does the Otoroshi Admin API have?
102 operations on 45 paths (40 GET, 18 POST, 16 DELETE, 14 PUT, 14 PATCH). The largest groups are apikeys, services, data-exporter-configs, scripts.
Is forking the Otoroshi Admin API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.