API Umbrella definition

schema.json

{
  "api": {
    "id": "string",
    "name": "string",
    "sort_order": 0,
    "backend_protocol": "http",
    "frontend_host": "string",
    "backend_host": "string",
    "servers": [
      {
        "id": "string",
        "host": "string",
        "port": 0
      }
    ],
    "url_matches": [
      {
        "id": "string",
        "frontend_prefix": "string",
        "backend_prefix": "string"
      }
    ],
    "balance_algorithm": "least_conn",
    "settings": {
      "id": "string",
      "append_query_string": "string",
      "headers": [
        {
          "id": "string",
          "key": "string",
          "value": "string"
        }
      ],
      "headers_string": "string",
      "default_response_headers": [
        {
          "id": "string",
          "key": "string",
          "value": "string"
        }
      ],
      "default_response_headers_string": "string",
      "override_response_headers": [
        {
          "id": "string",
          "key": "string",
          "value": "string"
        }
      ],
      "override_response_headers_string": "string",
      "http_basic_auth": "string",
      "require_https": "required_return_error",
      "require_https_transition_start_at": "2017-01-21T12:31:44.261Z",
      "disable_api_key": true,
      "api_key_verification_level": "none",
      "api_key_verification_transition_start_at": "2017-01-21T12:31:44.261Z",
      "required_roles": [
        "string"
      ],
      "required_roles_override": true,
      "allowed_ips": [
        "string"
      ],
      "allowed_referers": [
        "string"
      ],
      "rate_limit_mode": "unlimited",
      "rate_limits": [
        {
          "id": "string",
          "duration": 0,
          "accuracy": 0,
          "limit_by": "ip",
          "distributed": true,
          "response_headers": true
        }
      ],
      "anonymous_rate_limit_behavior": "ip_fallback",
      "authenticated_rate_limit_behavior": "all",
      "pass_api_key_header": true,
      "pass_api_key_query_param": true,
      "error_templates": {},
      "error_data": {},
      "error_data_yaml_strings": {}
    },
    "sub_settings": [
      {
        "id": "string",
        "http_method": "any",
        "regex": "string",
        "settings": {
          "id": "string",
          "append_query_string": "string",
          "headers": [
            {
              "id": "string",
              "key": "string",
              "value": "string"
            }
          ],
          "headers_string": "string",
          "default_response_headers": [
            {
              "id": "string",
              "key": "string",
              "value": "string"
            }
          ],
          "default_response_headers_string": "string",
          "override_response_headers": [
            {
              "id": "string",
              "key": "string",
              "value": "string"
            }
          ],
          "override_response_headers_string": "string",
          "http_basic_auth": "string",
          "require_https": "required_return_error",
          "require_https_transition_start_at": "2017-01-21T12:31:44.262Z",
          "disable_api_key": true,
          "api_key_verification_level": "none",
          "api_key_verification_transition_start_at": "2017-01-21T12:31:44.262Z",
          "required_roles": [
            "string"
          ],
          "required_roles_override": true,
          "allowed_ips": [
            "string"
          ],
          "allowed_referers": [
            "string"
          ],
          "rate_limit_mode": "unlimited",
          "rate_limits": [
            {
              "id": "string",
              "duration": 0,
              "accuracy": 0,
              "limit_by": "ip",
              "distributed": true,
              "response_headers": true
            }
          ],
          "anonymous_rate_limit_behavior": "ip_fallback",
          "authenticated_rate_limit_behavior": "all",
          "pass_api_key_header": true,
          "pass_api_key_query_param": true,
          "error_templates": {},
          "error_data": {},
          "error_data_yaml_strings": {}
        }
      }
    ],
    "rewrites": [
      {
        "id": "string",
        "matcher_type": "route",
        "http_method": "any",
        "frontend_matcher": "string",
        "backend_replacement": "string"
      }
    ],
    "created_at": "2017-01-21T12:31:44.262Z",
    "creator": {
      "username": "string"
    },
    "updated_at": "2017-01-21T12:31:44.262Z",
    "updater": {
      "username": "string"
    }
  }
}