v1

latestOpenAPI 3.0.0Apache 2.02026-07-1410280162.7 KB
import

Import the full state of Otoroshi

Import the full state of Otoroshi

post/api/otoroshi.json

Request body

appConfigobject

Current env variables at the time of export

datestring date-time required
dateRawinteger required
labelstring required

Example request

{
  "admins": [
    {
      "createdAt": 123,
      "label": "a string value",
      "password": "a string value",
      "registration": {
        "key": "value"
      },
      "username": "a string value"
    }
  ],
  "apiKeys": [
    {
      "authorizedEntities": [
        "a string value"
      ],
      "clientId": "a string value",
      "clientName": "a string value",
      "clientSecret": "a string value",
      "dailyQuota": 123,
      "enabled": true,
      "metadata": {
        "key": "value"
      },
      "monthlyQuota": 123,
      "throttlingQuota": 123
    }
  ],
  "appConfig": {
    "key": "value"
  },
  "config": {
    "alertsEmails": [
      "admin@otoroshi.io"
    ],
    "alertsWebhooks": [
      {
        "headers": {
          "key": "value"
        },
        "url": "http://www.google.com"
      }
    ],
    "analyticsWebhooks": [
      {
        "headers": {
          "key": "value"
        },
        "url": "http://www.google.com"
      }
    ],
    "apiReadOnly": true,
    "autoLinkToDefaultGroup": true,
    "backofficeAuth0Config": {
      "callbackUrl": "a string value",
      "clientId": "a string value",
      "clientSecret": "a string value",
      "domain": "a string value"
    },
    "cleverSettings": {
      "consumerKey": "a string value",
      "consumerSecret": "a string value",
      "orgaId": "a string value",
      "secret": "a string value",
      "token": "a string value"
    },
    "elasticReadsConfig": {
      "clusterUri": "a string value",
      "headers": {
        "key": "value"
      },
      "index": "a string value",
      "password": "a string value",
      "type": "a string value",
      "user": "a string value"
    },
    "elasticWritesConfigs": [
      {
        "clusterUri": "a string value",
        "headers": {
          "key": "value"
        },
        "index": "a string value",
        "password": "a string value",
        "type": "a string value",
        "user": "a string value"
      }
    ],
    "endlessIpAddresses": [
      "192.192.192.192"
    ],
    "ipFiltering": {
      "blacklist": [
        "192.192.192.192"
      ],
      "whitelist": [
        "192.192.192.192"
      ]
    },
    "limitConcurrentRequests": true,
    "lines": [
      "a string value"
    ],
    "mailerSettings": {
      "apiKey": "a string value",
      "apiKeyPrivate": "a string value",
      "apiKeyPublic": "a string value",
      "domain": "a string value",
      "eu": true,
      "header": {
        "key": "value"
      },
      "type": "a string value",
      "url": "a string value"
    },
    "maxConcurrentRequests": 123,
    "maxHttp10ResponseSize": 123,
    "maxLogsSize": 123123,
    "middleFingers": true,
    "perIpThrottlingQuota": 123,
    "privateAppsAuth0Config": {
      "callbackUrl": "a string value",
      "clientId": "a string value",
      "clientSecret": "a string value",
      "domain": "a string value"
    },
    "streamEntityOnly": true,
    "throttlingQuota": 123,
    "u2fLoginOnly": true,
    "useCircuitBreakers": true
  },
  "date": "2017-07-21T17:32:28Z",
  "dateRaw": 123,
  "errorTemplates": [
    {
      "messages": {
        "key": "value"
      },
      "serviceId": "a string value",
      "template40x": "a string value",
      "template50x": "a string value",
      "templateBuild": "a string value",
      "templateMaintenance": "a string value"
    }
  ],
  "label": "a string value",
  "serviceDescriptors": [
    {
      "Canary": {
        "enabled": true,
        "root": "a string value",
        "targets": [
          {
            "host": "www.google.com",
            "scheme": "a string value"
          }
        ],
        "traffic": 123123
      },
      "additionalHeaders": {
        "key": "value"
      },
      "api": {
        "exposeApi": true,
        "openApiDescriptorUrl": "http://www.google.com"
      },
      "authConfigRef": "a string value",
      "buildMode": true,
      "chaosConfig": {
        "badResponsesFaultConfig": {
          "ratio": 42.2,
          "responses": [
            {
              "body": "a string value",
              "headers": {
                "key": "value"
              },
              "status": 123123
            }
          ]
        },
        "enabled": true,
        "largeRequestFaultConfig": {
          "additionalRequestSize": 123123,
          "ratio": 42.2
        },
        "largeResponseFaultConfig": {
          "additionalRequestSize": 123123,
          "ratio": 42.2
        },
        "latencyInjectionFaultConfig": {
          "from": 123123,
          "ratio": 42.2,
          "to": 123123
        }
      },
      "clientConfig": {
        "backoffFactor": 123123,
        "callTimeout": 123123,
        "globalTimeout": 123123,
        "maxErrors": 123123,
        "retries": 123123,
        "retryInitialDelay": 123123,
        "sampleInterval": 123123,
        "useCircuitBreaker": true
      },
      "clientValidatorRef": "a string value",
      "cors": {
        "allowCredentials": true,
        "allowHeaders": [
          "a string value"
        ],
        "allowMethods": [
          "a string value"
        ],
        "allowOrigin": "a string value",
        "enabled": true,
        "excludedPatterns": [
          "a string value"
        ],
        "exposeHeaders": [
          "a string value"
        ],
        "maxAge": 123123
      },
      "domain": "a string value",
      "enabled": true,
      "enforceSecureCommunication": true,
      "env": "a string value",
      "forceHttps": true,
      "groups": [
        "a string value"
      ],
      "gzip": {
        "blackList": [
          "a string value"
        ],
        "bufferSize": 123,
        "chunkedThreshold": 123,
        "compressionLevel": 123123,
        "enabled": true,
        "excludedPatterns": [
          "a string value"
        ],
        "whiteList": [
          "a string value"
        ]
      },
      "headersVerification": {
        "key": "value"
      },
      "healthCheck": {
        "enabled": true,
        "url": "http://www.google.com"
      },
      "id": "110e8400-e29b-11d4-a716-446655440000",
      "ipFiltering": {
        "blacklist": [
          "192.192.192.192"
        ],
        "whitelist": [
          "192.192.192.192"
        ]
      },
      "jwtVerifier": {
        "algoSettings": {
          "secret": "a string value",
          "size": 123123,
          "type": "a string value"
        },
        "enabled": true,
        "source": {
          "name": "a string value",
          "type": "a string value"
        },
        "strategy": {
          "type": "a string value",
          "verificationSettings": {
            "fields": {
              "key": "value"
            },
            "mappingSettings": {
              "map": {
                "key": "value"
              },
              "remove": [
                "a string value"
              ],
              "values": {
                "key": "value"
              }
            }
          }
        },
        "strict": true,
        "type": "a string value"
      },
      "localHost": "a string value",
      "localScheme": "a string value",
      "maintenanceMode": true,
      "matchingHeaders": {
        "key": "value"
      },
      "matchingRoot": "a string value",
      "metadata": {
        "key": "value"
      },
      "name": "a string value",
      "overrideHost": true,
      "privateApp": true,
      "privatePatterns": [
        "a string value"
      ],
      "publicPatterns": [
        "a string value"
      ],
      "redirectToLocal": true,
      "redirection": {
        "code": 123123,
        "enabled": true,
        "to": "a string value"
      },
      "root": "a string value",
      "secComExcludedPatterns": [
        "a string value"
      ],
      "secComSettings": {
        "secret": "a string value",
        "size": 123123,
        "type": "a string value"
      },
      "sendOtoroshiHeadersBack": true,
      "statsdConfig": {
        "datadog": true,
        "host": "a string value",
        "port": 123123
      },
      "subdomain": "a string value",
      "targets": [
        {
          "host": "www.google.com",
          "scheme": "a string value"
        }
      ],
      "transformerRef": "a string value",
      "userFacing": true,
      "xForwardedHeaders": true
    }
  ],
  "serviceGroups": [
    {
      "description": "a string value",
      "id": "a string value",
      "name": "a string value"
    }
  ],
  "simpleAdmins": [
    {
      "createdAt": 123,
      "label": "a string value",
      "password": "a string value",
      "username": "a string value"
    }
  ],
  "stats": {
    "calls": 123,
    "dataIn": 123,
    "dataOut": 123
  }
}

Response

Successful operation

doneboolean required

Example response

{
  "done": true
}