---
title: "Get the full configuration of Otoroshi"
method: GET
path: "/api/globalconfig"
tags: ["configuration"]
---

# Get the full configuration of Otoroshi

`GET /api/globalconfig`

Get the full configuration of Otoroshi

## Response `200`

Successful operation

- GlobalConfig — The global config object of Otoroshi, used to customize settings of the current Otoroshi instance
  - `alertsEmails` string[], required — Email addresses that will receive all Otoroshi alert events
  - `alertsWebhooks` Webhook[], required — Webhook that will receive all Otoroshi alert events
    - `headers` object, required — Headers to authorize the call or whatever
    - `url` string, uri, required — The URL where events are posted
  - `analyticsWebhooks` Webhook[], required — Webhook that will receive all internal Otoroshi events
    - `headers` object, required — Headers to authorize the call or whatever
    - `url` string, uri, required — The URL where events are posted
  - `apiReadOnly` boolean, required — If enabled, Admin API won't be able to write/update/delete entities
  - `autoLinkToDefaultGroup` boolean, required — If not defined, every new service descriptor will be added to the default group
  - `backofficeAuth0Config` Auth0Config — Configuration for Auth0 domain
    - `callbackUrl` string, required — Auth0 callback URL
    - `clientId` string, required — Auth0 client id
    - `clientSecret` string, required — Auth0 client secret
    - `domain` string, required — Auth0 domain
  - `cleverSettings` CleverSettings — Configuration for CleverCloud client
    - `consumerKey` string, required — CleverCloud consumer key
    - `consumerSecret` string, required — CleverCloud consumer token
    - `orgaId` string, required — CleverCloud organization id
    - `secret` string, required — CleverCloud oauth secret
    - `token` string, required — CleverCloud oauth token
  - `elasticReadsConfig` ElasticConfig — The configuration for elastic access
    - `clusterUri` string, required — URL of the elastic cluster
    - `headers` object, required — Additionnal http headers
    - `index` string, required — Index for events. Default is otoroshi-events
    - `password` string, required — Optional password
    - `type` string, required — Type of events. Default is event
    - `user` string, required — Optional user
  - `elasticWritesConfigs` ElasticConfig[] — Configs. for Elastic writes
    - `clusterUri` string, required — URL of the elastic cluster
    - `headers` object, required — Additionnal http headers
    - `index` string, required — Index for events. Default is otoroshi-events
    - `password` string, required — Optional password
    - `type` string, required — Type of events. Default is event
    - `user` string, required — Optional user
  - `endlessIpAddresses` string[], required — IP addresses for which any request to Otoroshi will respond with 128 Gb of zeros
  - `ipFiltering` IpFiltering, required — The filtering configuration block for a service of globally.
    - `blacklist` string[], required — Blacklisted IP addresses
    - `whitelist` string[], required — Whitelisted IP addresses
  - `limitConcurrentRequests` boolean, required — If enabled, Otoroshi will reject new request if too much at the same time
  - `lines` string[] — Possibles lines for Otoroshi
  - `mailerSettings` MailerSettings — Configuration for mailgun api client
    - `apiKey` string, required — Mailgun mailer api key
    - `apiKeyPrivate` string — Mailjet mailer private api key
    - `apiKeyPublic` string — Mailjet mailer public api key
    - `domain` string, required — Mailgun mailer domain
    - `eu` boolean — Mailgun mailer, use EU tenant api
    - `header` object — Generic mailer headers
    - `type` string — Type of the mailer: console, generic, mailgun, mailjet
    - `url` string — Generic mailer url
  - `maxConcurrentRequests` integer, required — The number of authorized request processed at the same time
  - `maxHttp10ResponseSize` integer — The max size in bytes of an HTTP 1.0 response
  - `maxLogsSize` integer — Number of events kept locally
  - `middleFingers` boolean — Use middle finger emoji as a response character for endless HTTP responses
  - `perIpThrottlingQuota` integer, required — Authorized number of calls per second globally per IP address, measured on 10 seconds
  - `privateAppsAuth0Config` Auth0Config — Configuration for Auth0 domain
    - `callbackUrl` string, required — Auth0 callback URL
    - `clientId` string, required — Auth0 client id
    - `clientSecret` string, required — Auth0 client secret
    - `domain` string, required — Auth0 domain
  - `streamEntityOnly` boolean, required — HTTP will be streamed only. Doesn't work with old browsers
  - `throttlingQuota` integer, required — Authorized number of calls per second globally, measured on 10 seconds
  - `u2fLoginOnly` boolean, required — If enabled, login to backoffice through Auth0 will be disabled
  - `useCircuitBreakers` boolean, required — If enabled, services will be authorized to use circuit breakers

## Other responses

- `400` — Bad resource format. Take another look to the swagger, or open an issue :)
- `401` — You have to provide an Api Key. Api Key can be passed with 'Otoroshi-Client-Id' and 'Otoroshi-Client-Secret' headers, or use basic http authentication
- `404` — Resource not found or does not exist

---

[API](https://skmtc.net/maif/apis/otoroshi.md) · [All operations](https://skmtc.net/maif/apis/otoroshi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/maif/otoroshi/versions/276881687271/schema)