Open documentation ↗Overview
Admin API of the Otoroshi reverse proxy
Otoroshi Admin API is a development API from maif.local. Requests are authenticated with HTTP Basic auth. It is served over HTTPS. Its OpenAPI description documents 102 endpoints.
At a glance
- Authentication
- HTTP Basic
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Development
- Base URL
http://otoroshi-api.oto.tools/- Version
- 1.5.0-dev
- Endpoints
- 102
- OpenAPI
- Specification ↗
- Spec updated
- 2021-06-30
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "http://otoroshi-api.oto.tools/api/apikeys" \
-H "Accept: application/json" \
-H "Authorization: Basic BASE64_USER_PASSWORD"const response = await fetch("http://otoroshi-api.oto.tools/api/apikeys", {
method: "GET",
headers: {
"Accept": "application/json",
"Authorization": "Basic BASE64_USER_PASSWORD",
},
});
const data = await response.json();
console.log(data);import requests
response = requests.request(
"GET",
"http://otoroshi-api.oto.tools/api/apikeys",
headers={
"Accept": "application/json",
"Authorization": "Basic BASE64_USER_PASSWORD",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /api/apikeys | Get all api keys |
| GET | /api/auths | Get all global auth. module configs |
| POST | /api/auths | Create one global auth. module config |
| GET | /api/auths/{id} | Get one global auth. module configs |
| PUT | /api/auths/{id} | Update one global auth. module config |
| PATCH | /api/auths/{id} | Update one global auth. module config |
| DELETE | /api/auths/{id} | Delete one global auth. module config |
| GET | /api/certificates | Get all certificates |
| POST | /api/certificates | Create one certificate |
| GET | /api/certificates/{id} | Get one certificate by id |
| PUT | /api/certificates/{id} | Update one certificate by id |
| PATCH | /api/certificates/{id} | Update one certificate by id |
| DELETE | /api/certificates/{id} | Delete one certificate by id |
| GET | /api/client-validators | Get all validation authoritiess |
| POST | /api/client-validators | Create one validation authorities |
| GET | /api/client-validators/{id} | Get one validation authorities by id |
| PUT | /api/client-validators/{id} | Update one validation authorities by id |
| PATCH | /api/client-validators/{id} | Update one validation authorities by id |
| DELETE | /api/client-validators/{id} | Delete one validation authorities by id |
| GET | /api/data-exporter-configs | Get all data exporter configs |
| POST | /api/data-exporter-configs | Create a new data exporter config |
| POST | /api/data-exporter-configs/_bulk | Create a new data exporter configs |
| PUT | /api/data-exporter-configs/_bulk | Update a data exporter configs |
| PATCH | /api/data-exporter-configs/_bulk | Update a data exporter configs with a diff |
| DELETE | /api/data-exporter-configs/_bulk | Delete a data exporter config |
| GET | /api/data-exporter-configs/_template | Get all data exporter configs |
| GET | /api/data-exporter-configs/{dataExporterConfigId} | Get a data exporter config |
| PUT | /api/data-exporter-configs/{dataExporterConfigId} | Update a data exporter config |
| PATCH | /api/data-exporter-configs/{dataExporterConfigId} | Update a data exporter config with a diff |
| DELETE | /api/data-exporter-configs/{dataExporterConfigId} | Delete a data exporter config |
| GET | /api/globalconfig | Get the full configuration of Otoroshi |
| PUT | /api/globalconfig | Update the global configuration |
| PATCH | /api/globalconfig | Update the global configuration with a diff |
| GET | /api/groups | Get all service groups |
| POST | /api/groups | Create a new service group |
| GET | /api/groups/{groupId}/apikeys | Get all api keys for the group of a service |
| POST | /api/groups/{groupId}/apikeys | Create a new api key for a group |
| GET | /api/groups/{groupId}/apikeys/{clientId} | Get an api key |
| PUT | /api/groups/{groupId}/apikeys/{clientId} | Update an api key |
| PATCH | /api/groups/{groupId}/apikeys/{clientId} | Update an api key with a diff |
| DELETE | /api/groups/{groupId}/apikeys/{clientId} | Delete an api key |
| GET | /api/groups/{groupId}/apikeys/{clientId}/quotas | Get the quota state of an api key |
| DELETE | /api/groups/{groupId}/apikeys/{clientId}/quotas | Reset the quota state of an api key |
| GET | /api/groups/{serviceGroupId} | Get a service group |
| PUT | /api/groups/{serviceGroupId} | Update a service group |
| PATCH | /api/groups/{serviceGroupId} | Update a service group with a diff |
| DELETE | /api/groups/{serviceGroupId} | Delete a service group |
| GET | /api/groups/{serviceGroupId}/services | Get all services descriptor for a group |
| POST | /api/import | Import the full state of Otoroshi as a file |
| GET | /api/live | Get global otoroshi stats |
| GET | /api/live/{id} | Get live feed of otoroshi stats |
| GET | /api/otoroshi.json | Export the full state of Otoroshi |
| POST | /api/otoroshi.json | Import the full state of Otoroshi |
| GET | /api/scripts | Get all scripts |
| POST | /api/scripts | Create a new script |
| POST | /api/scripts/_compile | Compile a script |
| GET | /api/scripts/{scriptId} | Get a script |
| PUT | /api/scripts/{scriptId} | Update a script |
| PATCH | /api/scripts/{scriptId} | Update a script with a diff |
| DELETE | /api/scripts/{scriptId} | Delete a script |
| GET | /api/services | Get all services |
| POST | /api/services | Create a new service descriptor |
| GET | /api/services/{serviceId} | Get a service descriptor |
| PUT | /api/services/{serviceId} | Update a service descriptor |
| PATCH | /api/services/{serviceId} | Update a service descriptor with a diff |
| DELETE | /api/services/{serviceId} | Delete a service descriptor |
| GET | /api/services/{serviceId}/apikeys | Get all api keys for the group of a service |
| POST | /api/services/{serviceId}/apikeys | Create a new api key for a service |
| GET | /api/services/{serviceId}/apikeys/{clientId} | Get an api key |
| PUT | /api/services/{serviceId}/apikeys/{clientId} | Update an api key |
| PATCH | /api/services/{serviceId}/apikeys/{clientId} | Update an api key with a diff |
| DELETE | /api/services/{serviceId}/apikeys/{clientId} | Delete an api key |
| GET | /api/services/{serviceId}/apikeys/{clientId}/group | Get the group of an api key |
| GET | /api/services/{serviceId}/apikeys/{clientId}/quotas | Get the quota state of an api key |
| DELETE | /api/services/{serviceId}/apikeys/{clientId}/quotas | Reset the quota state of an api key |
| GET | /api/services/{serviceId}/targets | Get a service descriptor targets |
| POST | /api/services/{serviceId}/targets | Add a target to a service descriptor |
| PATCH | /api/services/{serviceId}/targets | Update a service descriptor targets |
| DELETE | /api/services/{serviceId}/targets | Delete a service descriptor target |
| GET | /api/services/{serviceId}/template | Get a service descriptor error template |
| POST | /api/services/{serviceId}/template | Create a service descriptor error template |
| PUT | /api/services/{serviceId}/template | Update an error template to a service descriptor |
| DELETE | /api/services/{serviceId}/template | Delete a service descriptor error template |
| POST | /api/snowmonkey/_start | Start the Snow Monkey |
| POST | /api/snowmonkey/_stop | Stop the Snow Monkey |
| GET | /api/snowmonkey/config | Get current Snow Monkey config |
| PUT | /api/snowmonkey/config | Update current Snow Monkey config |
| PATCH | /api/snowmonkey/config | Update current Snow Monkey config |
| GET | /api/snowmonkey/outages | Get all current Snow Monkey ourages |
| DELETE | /api/snowmonkey/outages | Reset Snow Monkey Outages for the day |
| GET | /api/verifiers | Get all global JWT verifiers |
| POST | /api/verifiers | Create one global JWT verifiers |
| GET | /api/verifiers/{verifierId} | Get one global JWT verifiers |
| PUT | /api/verifiers/{verifierId} | Update one global JWT verifiers |
| PATCH | /api/verifiers/{verifierId} | Update one global JWT verifiers |
| DELETE | /api/verifiers/{verifierId} | Delete one global JWT verifiers |
| GET | /health | Return current Otoroshi health |
| GET | /lines | Get all environments |
| GET | /lines/{line}/services | Get all services for an environment |
| GET | /new/apikey | Get a template of an Otoroshi Api Key |
Showing the first 100 of 102 endpoints; the full list is in the documentation.
Questions
Does the Otoroshi Admin API API need an API key?
Yes. The Otoroshi Admin API API uses HTTP Basic authentication; the documentation explains how to get credentials.
Does the Otoroshi Admin API API support HTTPS?
Yes, the Otoroshi Admin API API is served over HTTPS.
How many endpoints does the Otoroshi Admin API API have?
Its OpenAPI description lists 102 endpoints in version 1.5.0-dev. The first 100 are shown on this page.
What are alternatives to the Otoroshi Admin API API?
Other Development APIs include Cloudflare, Azure DevOps, IPify, App Store Connect API, StackExchange.
Similar development APIs
Compare alternatives →Cloudflare
DevelopmentManage DNS, CDN, Workers and other services; documented with an official OpenAPI 3.0 spec
API key
Azure DevOps
DevelopmentThe Azure DevOps basic components of a REST API request/response pair
API key
IPify
DevelopmentA simple IP Address API
No auth
App Store Connect API
DevelopmentThe data structure that represents an app store connect api resource.
Bearer token252 endpoints
StackExchange
DevelopmentQ&A forum for developers
OAuth124 endpoints
IPinfo
DevelopmentAnother simple IP Address API
No auth
Listed from APIs.guru (CC0).