Updating an API definition with its ID.

Updating an API definition uses the same signature and object as a POST, however it will first ensure that the API ID that is being updated is the same as the one in the object being PUT.

Updating will completely replace the file descriptor and will not change an API Definition that has already been loaded, the hot-reload endpoint will need to be called to push the new definition to live.

PUT /tyk/apis/{apiID}

Try it

Updating an API definition with its ID.

cURL

curl --request PUT \
  --url https://{tenant}/tyk/apis/{apiID} \
  --header 'Content-Type: application/json' \
  --header 'X-Tyk-Authorization: <api-key>' \
  --data '
{
  "CORS": {
    "allow_credentials": false,
    "allowed_headers": [
      "Origin",
      "Accept",
      "Content-Type",
      "Authorization"
    ],
    "allowed_methods": [
      "GET",
      "HEAD",
      "POST"
    ],
    "allowed_origins": [
      "https://*.foo.com"
    ],
    "debug": true,
    "enable": false,
    "exposed_headers": [
      "Accept",
      "Content-Type"
    ],
    "max_age": 24,
    "options_passthrough": false
  },
  "active": true,
  "allowed_ips": [
    "<string>"
  ],
  "analytics_plugin": {
    "enable": true,
    "func_name": "<string>",
    "plugin_path": "<string>"
  },
  "api_id": "<string>",
  "auth": {
    "auth_header_name": "Authorization",
    "cookie_name": "<string>",
    "disable_header": true,
    "name": "<string>",
    "param_name": "<string>",
    "signature": {
      "algorithm": "<string>",
      "allowed_clock_skew": 123,
      "error_code": 123,
      "error_message": "<string>",
      "header": "<string>",
      "param_name": "<string>",
      "secret": "<string>",
      "use_param": true
    },
    "use_certificate": true,
    "use_cookie": true,
    "use_param": true,
    "validate_signature": true
  },
  "auth_configs": {},
  "auth_provider": {
    "meta": {},
    "name": "<string>",
    "storage_engine": "<string>"
  },
  "base_identity_provided_by": "<string>",
  "basic_auth": {
    "body_password_regexp": "<string>",
    "body_user_regexp": "<string>",
    "cache_ttl": 123,
    "disable_caching": true,
    "extract_from_body": true
  },
  "blacklisted_ips": [
    "<string>"
  ],
  "cache_options": {
    "cache_all_safe_requests": false,
    "cache_by_headers": [
      "<string>"
    ],
    "cache_control_ttl_header": "<string>",
    "cache_response_codes": [
      123
    ],
    "cache_timeout": 60,
    "enable_cache": true,
    "enable_upstream_cache_control": false
  },
  "certificate_pinning_disabled": true,
  "certificates": [
    "<string>"
  ],
  "client_certificates": [
    "<string>"
  ],
  "config_data": {},
  "config_data_disabled": true,
  "custom_middleware": {
    "auth_check": {
      "disabled": true,
      "name": "PreMiddlewareFunction",
      "path": "<string>",
      "raw_body_only": false,
      "require_session": false
    },
    "driver": "<string>",
    "id_extractor": {
      "disabled": true,
      "extract_from": "<string>",
      "extract_with": "<string>",
      "extractor_config": {}
    },
    "post": [
      {
        "disabled": true,
        "name": "PreMiddlewareFunction",
        "path": "<string>",
        "raw_body_only": false,
        "require_session": false
      }
    ],
    "post_key_auth": [
      {
        "disabled": true,
        "name": "PreMiddlewareFunction",
        "path": "<string>",
        "raw_body_only": false,
        "require_session": false
      }
    ],
    "pre": [
      {
        "disabled": true,
        "name": "PreMiddlewareFunction",
        "path": "<string>",
        "raw_body_only": false,
        "require_session": false
      }
    ],
    "response": [
      {
        "disabled": true,
        "name": "PreMiddlewareFunction",
        "path": "<string>",
        "raw_body_only": false,
        "require_session": false
      }
    ]
  },
  "custom_middleware_bundle": "<string>",
  "custom_middleware_bundle_disabled": true,
  "custom_plugin_auth_enabled": true,
  "definition": {
    "default": "<string>",
    "enabled": true,
    "fallback_to_default": true,
    "key": "x-api-version",
    "location": "header",
    "name": "<string>",
    "strip_path": true,
    "strip_versioning_data": true,
    "url_versioning_pattern": "<string>",
    "versions": {}
  },
  "detailed_tracing": true,
  "disable_quota": true,
  "disable_rate_limit": true,
  "do_not_track": true,
  "domain": "<string>",
  "domain_disabled": true,
  "dont_set_quota_on_create": true,
  "enable_batch_request_support": true,
  "enable_context_vars": true,
  "enable_coprocess_auth": true,
  "enable_detailed_recording": true,
  "enable_ip_blacklisting": true,
  "enable_ip_whitelisting": true,
  "enable_jwt": true,
  "enable_proxy_protocol": true,
  "enable_signature_checking": true,
  "event_handlers": {
    "events": {}
  },
  "expiration": "<string>",
  "expire_analytics_after": 123,
  "external_oauth": {
    "enabled": true,
    "providers": [
      {
        "introspection": {
          "cache": {
            "enabled": true,
            "timeout": 123
          },
          "client_id": "<string>",
          "client_secret": "<string>",
          "enabled": true,
          "identity_base_field": "<string>",
          "url": "<string>"
        },
        "jwt": {
          "enabled": true,
          "expires_at_validation_skew": 1,
          "identity_base_field": "<string>",
          "issued_at_validation_skew": 1,
          "not_before_validation_skew": 1,
          "signing_method": "<string>",
          "source": "<string>"
        }
      }
    ]
  },
  "global_rate_limit": {
    "disabled": true,
    "per": 123,
    "rate": 123
  },
  "graphql": {
    "enabled": true,
    "engine": {
      "data_sources": [
        {
          "config": "<unknown>",
          "internal": true,
          "kind": "<string>",
          "name": "<string>",
          "root_fields": [
            {
              "fields": [
                "<string>"
              ],
              "type": "<string>"
            }
          ]
        }
      ],
      "field_configs": [
        {
          "disable_default_mapping": true,
          "field_name": "<string>",
          "path": [
            "<string>"
          ],
          "type_name": "<string>"
        }
      ],
      "global_headers": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    },
    "execution_mode": "proxyOnly",
    "introspection": {
      "disabled": true
    },
    "last_schema_update": "2023-11-07T05:31:56Z",
    "playground": {
      "enabled": true,
      "path": "<string>"
    },
    "proxy": {
      "auth_headers": {},
      "features": {
        "use_immutable_headers": true
      },
      "request_headers": {},
      "request_headers_rewrite": {},
      "subscription_type": "<string>",
      "use_response_extensions": {
        "on_error_forwarding": true
      }
    },
    "schema": "<string>",
    "subgraph": {
      "sdl": "<string>"
    },
    "supergraph": {
      "disable_query_batching": true,
      "global_headers": {},
      "merged_sdl": "<string>",
      "subgraphs": [
        {
          "api_id": "<string>",
          "headers": {},
          "name": "<string>",
          "sdl": "<string>",
          "subscription_type": "<string>",
          "url": "<string>"
        }
      ],
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "type_field_configurations": [
      {
        "data_source": {
          "data_source_config": "<unknown>",
          "kind": "<string>"
        },
        "field_name": "<string>",
        "mapping": {
          "disabled": true,
          "path": "<string>"
        },
        "type_name": "<string>"
      }
    ],
    "version": "1"
  },
  "hmac_allowed_algorithms": [
    "<string>"
  ],
  "hmac_allowed_clock_skew": 123,
  "id": "<string>",
  "idp_client_id_mapping_disabled": true,
  "internal": true,
  "is_oas": true,
  "jwt_client_base_field": "<string>",
  "jwt_default_policies": [
    "<string>"
  ],
  "jwt_expires_at_validation_skew": 1,
  "jwt_identity_base_field": "<string>",
  "jwt_issued_at_validation_skew": 1,
  "jwt_not_before_validation_skew": 1,
  "jwt_policy_field_name": "<string>",
  "jwt_scope_claim_name": "<string>",
  "jwt_scope_to_policy_mapping": {},
  "jwt_signing_method": "<string>",
  "jwt_skip_kid": true,
  "jwt_source": "<string>",
  "listen_port": 123,
  "name": "<string>",
  "notifications": {
    "oauth_on_keychange_url": "<string>",
    "shared_secret": "<string>"
  },
  "oauth_meta": {
    "allowed_access_types": [
      "<string>"
    ],
    "allowed_authorize_types": [
      "<string>"
    ],
    "auth_login_redirect": "<string>"
  },
  "openid_options": {
    "providers": [
      {
        "client_ids": {},
        "issuer": "<string>"
      }
    ],
    "segregate_by_client": true
  },
  "org_id": "<string>",
  "pinned_public_keys": {},
  "protocol": "<string>",
  "proxy": {
    "check_host_against_uptime_tests": true,
    "disable_strip_slash": true,
    "enable_load_balancing": true,
    "listen_path": "/relative-path-examples/",
    "preserve_host_header": true,
    "service_discovery": {
      "cache_disabled": true,
      "cache_timeout": 123,
      "data_path": "<string>",
      "endpoint_returns_list": true,
      "parent_data_path": "<string>",
      "port_data_path": "<string>",
      "query_endpoint": "<string>",
      "target_path": "<string>",
      "use_discovery_service": true,
      "use_nested_query": true,
      "use_target_list": true
    },
    "strip_listen_path": true,
    "target_list": [
      "<string>"
    ],
    "target_url": "https://httpbin.org/",
    "transport": {
      "proxy_url": "<string>",
      "ssl_ciphers": [
        "<string>"
      ],
      "ssl_force_common_name_check": true,
      "ssl_insecure_skip_verify": true,
      "ssl_max_version": 1,
      "ssl_min_version": 1
    }
  },
  "request_signing": {
    "algorithm": "<string>",
    "certificate_id": "<string>",
    "header_list": [
      "<string>"
    ],
    "is_enabled": true,
    "key_id": "<string>",
    "secret": "<string>",
    "signature_header": "<string>"
  },
  "response_processors": [
    {
      "name": "<string>",
      "options": "<unknown>"
    }
  ],
  "scopes": {
    "jwt": {
      "scope_claim_name": "<string>",
      "scope_to_policy": {}
    },
    "oidc": {
      "scope_claim_name": "<string>",
      "scope_to_policy": {}
    }
  },
  "session_lifetime": 123,
  "session_lifetime_respects_key_expiration": true,
  "session_provider": {
    "meta": {},
    "name": "<string>",
    "storage_engine": "<string>"
  },
  "slug": "<string>",
  "strip_auth_data": true,
  "tag_headers": [
    "<string>"
  ],
  "tags": [
    "Default",
    "v1"
  ],
  "tags_disabled": true,
  "upstream_certificates": {},
  "upstream_certificates_disabled": true,
  "uptime_tests": {
    "check_list": [
      {
        "body": "<string>",
        "commands": [
          {
            "message": "<string>",
            "name": "<string>"
          }
        ],
        "enable_proxy_protocol": true,
        "headers": {},
        "method": "<string>",
        "protocol": "<string>",
        "timeout": 123,
        "url": "<string>"
      }
    ],
    "config": {
      "expire_utime_after": 123,
      "recheck_wait": 123,
      "service_discovery": {
        "cache_disabled": true,
        "cache_timeout": 123,
        "data_path": "<string>",
        "endpoint_returns_list": true,
        "parent_data_path": "<string>",
        "port_data_path": "<string>",
        "query_endpoint": "<string>",
        "target_path": "<string>",
        "use_discovery_service": true,
        "use_nested_query": true,
        "use_target_list": true
      }
    }
  },
  "use_basic_auth": true,
  "use_go_plugin_auth": true,
  "use_keyless": true,
  "use_mutual_tls_auth": true,
  "use_oauth2": true,
  "use_openid": true,
  "use_standard_auth": true,
  "version_data": {
    "default_version": "<string>",
    "not_versioned": true,
    "versions": {}
  }
}
'

200

{
  "action": "modified",
  "key": "b13d928b9972bd18",
  "key_hash": "<string>",
  "status": "ok"
}

Authorizations

X-Tyk-Authorization · string · header · required

Api key

Path Parameters

apiID · string · required

The API ID.

Body

application/json

CORS · object

Show child attributes

CORS. allow_credentials · boolean

Example:

false

CORS. allowed_headers · string[] | null

Example:

[
  "Origin",
  "Accept",
  "Content-Type",
  "Authorization"
]

CORS. allowed_methods · string[] | null

Example:

["GET", "HEAD", "POST"]

CORS. allowed_origins · string[] | null

Example:

["https://*.foo.com"]

CORS. debug · boolean

Example:

true

CORS. enable · boolean

Example:

false

CORS. exposed_headers · string[] | null

Example:

["Accept", "Content-Type"]

CORS. max_age · integer

Example:

24

CORS. options_passthrough · boolean

Example:

false

active · boolean

allowed_ips · string[] | null

analytics_plugin · object

Show child attributes

analytics_plugin. enable · boolean

analytics_plugin. func_name · string

analytics_plugin. plugin_path · string

api_id · string

auth · object

Show child attributes

auth. auth_header_name · string

Example:

"Authorization"

auth. cookie_name · string

auth. disable_header · boolean

auth. name · string

auth. param_name · string

auth. signature · object

Show child attributes

auth.signature. algorithm · string

auth.signature. allowed_clock_skew · integer

auth.signature. error_code · integer

auth.signature. error_message · string

auth.signature. header · string

auth.signature. param_name · string

auth.signature. secret · string

auth.signature. use_param · boolean

auth. use_certificate · boolean

auth. use_cookie · boolean

auth. use_param · boolean

auth. validate_signature · boolean

auth_configs · object

Show child attributes

auth_configs. {key} · object

Show child attributes

auth_configs.{key}. auth_header_name · string

Example:

"Authorization"

auth_configs.{key}. cookie_name · string

auth_configs.{key}. disable_header · boolean

auth_configs.{key}. name · string

auth_configs.{key}. param_name · string

auth_configs.{key}. signature · object

Show child attributes

auth_configs.{key}.signature. algorithm · string

auth_configs.{key}.signature. allowed_clock_skew · integer

auth_configs.{key}.signature. error_code · integer

auth_configs.{key}.signature. error_message · string

auth_configs.{key}.signature. header · string

auth_configs.{key}.signature. param_name · string

auth_configs.{key}.signature. secret · string

auth_configs.{key}.signature. use_param · boolean

auth_configs.{key}. use_certificate · boolean

auth_configs.{key}. use_cookie · boolean

auth_configs.{key}. use_param · boolean

auth_configs.{key}. validate_signature · boolean

auth_provider · object

Show child attributes

auth_provider. meta · object

Show child attributes

auth_provider.meta. {key} · any

auth_provider. name · string

auth_provider. storage_engine · string

base_identity_provided_by · string

basic_auth · object

Show child attributes

basic_auth. body_password_regexp · string

basic_auth. body_user_regexp · string

basic_auth. cache_ttl · integer

basic_auth. disable_caching · boolean

basic_auth. extract_from_body · boolean

blacklisted_ips · string[] | null

cache_options · object

Show child attributes

cache_options. cache_all_safe_requests · boolean

Example:

false

cache_options. cache_by_headers · string[] | null

cache_options. cache_control_ttl_header · string

cache_options. cache_response_codes · integer[] | null

cache_options. cache_timeout · integer<int64>

Example:

60

cache_options. enable_cache · boolean

Example:

true

cache_options. enable_upstream_cache_control · boolean

Example:

false

certificate_pinning_disabled · boolean

certificates · string[] | null

client_certificates · string[] | null

config_data · object

Show child attributes

config_data. {key} · any

config_data_disabled · boolean

custom_middleware · object

Show child attributes

custom_middleware. auth_check · object

Show child attributes

custom_middleware.auth_check. disabled · boolean

custom_middleware.auth_check. name · string

Example:

"PreMiddlewareFunction"

custom_middleware.auth_check. path · string

custom_middleware.auth_check. raw_body_only · boolean

Example:

false

custom_middleware.auth_check. require_session · boolean

Example:

false

custom_middleware. driver · string

custom_middleware. id_extractor · object

Show child attributes

custom_middleware.id_extractor. disabled · boolean

custom_middleware.id_extractor. extract_from · string

custom_middleware.id_extractor. extract_with · string

custom_middleware.id_extractor. extractor_config · object

Show child attributes

custom_middleware.id_extractor.extractor_config. {key} · any

custom_middleware. post · object[] | null

Show child attributes

custom_middleware.post. disabled · boolean

custom_middleware.post. name · string

Example:

"PreMiddlewareFunction"

custom_middleware.post. path · string

custom_middleware.post. raw_body_only · boolean

Example:

false

custom_middleware.post. require_session · boolean

Example:

false

custom_middleware. post_key_auth · object[] | null

Show child attributes

custom_middleware.post_key_auth. disabled · boolean

custom_middleware.post_key_auth. name · string

Example:

"PreMiddlewareFunction"

custom_middleware.post_key_auth. path · string

custom_middleware.post_key_auth. raw_body_only · boolean

Example:

false

custom_middleware.post_key_auth. require_session · boolean

Example:

false

custom_middleware. pre · object[] | null

Show child attributes

custom_middleware.pre. disabled · boolean

custom_middleware.pre. name · string

Example:

"PreMiddlewareFunction"

custom_middleware.pre. path · string

custom_middleware.pre. raw_body_only · boolean

Example:

false

custom_middleware.pre. require_session · boolean

Example:

false

custom_middleware. response · object[] | null

Show child attributes

custom_middleware.response. disabled · boolean

custom_middleware.response. name · string

Example:

"PreMiddlewareFunction"

custom_middleware.response. path · string

custom_middleware.response. raw_body_only · boolean

Example:

false

custom_middleware.response. require_session · boolean

Example:

false

custom_middleware_bundle · string

custom_middleware_bundle_disabled · boolean

custom_plugin_auth_enabled · boolean

definition · object

Show child attributes

definition. default · string

definition. enabled · boolean

definition. fallback_to_default · boolean

definition. key · string

Example:

"x-api-version"

definition. location · string

Example:

"header"

definition. name · string

definition. strip_path · boolean

definition. strip_versioning_data · boolean

definition. url_versioning_pattern · string

definition. versions · object

Show child attributes

definition.versions. {key} · string

detailed_tracing · boolean

disable_quota · boolean

disable_rate_limit · boolean

do_not_track · boolean

domain · string

domain_disabled · boolean

dont_set_quota_on_create · boolean

enable_batch_request_support · boolean

enable_context_vars · boolean

enable_coprocess_auth · boolean

enable_detailed_recording · boolean

enable_ip_blacklisting · boolean

enable_ip_whitelisting · boolean

enable_jwt · boolean

enable_proxy_protocol · boolean

enable_signature_checking · boolean

event_handlers · object

Show child attributes

event_handlers. events · object

Show child attributes

event_handlers.events. {key} · object[]

Show child attributes

event_handlers.events.{key}. handler_meta · object

Show child attributes

event_handlers.events.{key}.handler_meta. {key} · any

event_handlers.events.{key}. handler_name · string

expiration · string

expire_analytics_after · integer

external_oauth · object

Show child attributes

external_oauth. enabled · boolean

external_oauth. providers · object[] | null

Show child attributes

external_oauth.providers. introspection · object

Show child attributes

external_oauth.providers.introspection. cache · object

Show child attributes

external_oauth.providers.introspection.cache. enabled · boolean

external_oauth.providers.introspection.cache. timeout · integer<int64>

external_oauth.providers.introspection. client_id · string

external_oauth.providers.introspection. client_secret · string

external_oauth.providers.introspection. enabled · boolean

external_oauth.providers.introspection. identity_base_field · string

external_oauth.providers.introspection. url · string

external_oauth.providers. jwt · object

Show child attributes

external_oauth.providers.jwt. enabled · boolean

external_oauth.providers.jwt. expires_at_validation_skew · integer

Required range: x >= 0

external_oauth.providers.jwt. identity_base_field · string

external_oauth.providers.jwt. issued_at_validation_skew · integer

Required range: x >= 0

external_oauth.providers.jwt. not_before_validation_skew · integer

Required range: x >= 0

external_oauth.providers.jwt. signing_method · string

external_oauth.providers.jwt. source · string

global_rate_limit · object

Show child attributes

global_rate_limit. disabled · boolean

global_rate_limit. per · number

global_rate_limit. rate · number

graphql · object

Show child attributes

graphql. enabled · boolean

graphql. engine · object

Show child attributes

graphql.engine. data_sources · object[] | null

Show child attributes

graphql.engine.data_sources. config · any

graphql.engine.data_sources. internal · boolean

graphql.engine.data_sources. kind · string

graphql.engine.data_sources. name · string

graphql.engine.data_sources. root_fields · object[] | null

Show child attributes

graphql.engine.data_sources.root_fields. fields · string[] | null

graphql.engine.data_sources.root_fields. type · string

graphql.engine. field_configs · object[] | null

Show child attributes

graphql.engine.field_configs. disable_default_mapping · boolean

graphql.engine.field_configs. field_name · string

graphql.engine.field_configs. path · string[] | null

graphql.engine.field_configs. type_name · string

graphql.engine. global_headers · object[] | null

Show child attributes

graphql.engine.global_headers. key · string

graphql.engine.global_headers. value · string

graphql. execution_mode · enum<string>

Available options: proxyOnly, executionEngine, subgraph, supergraph,

graphql. introspection · object

Show child attributes

graphql.introspection. disabled · boolean

graphql. last_schema_update · string<date-time> | null

graphql. playground · object

Show child attributes

graphql.playground. enabled · boolean

graphql.playground. path · string

graphql. proxy · object

Show child attributes

graphql.proxy. auth_headers · object

Show child attributes

graphql.proxy.auth_headers. {key} · string

graphql.proxy. features · object

Show child attributes

graphql.proxy.features. use_immutable_headers · boolean

graphql.proxy. request_headers · object

Show child attributes

graphql.proxy.request_headers. {key} · string

graphql.proxy. request_headers_rewrite · object

Show child attributes

graphql.proxy.request_headers_rewrite. {key} · object

Show child attributes

graphql.proxy.request_headers_rewrite.{key}. remove · boolean

graphql.proxy.request_headers_rewrite.{key}. value · string

graphql.proxy. subscription_type · string

graphql.proxy. use_response_extensions · object

Show child attributes

graphql.proxy.use_response_extensions. on_error_forwarding · boolean

graphql. schema · string

graphql. subgraph · object

Show child attributes

graphql.subgraph. sdl · string

graphql. supergraph · object

Show child attributes

graphql.supergraph. disable_query_batching · boolean

graphql.supergraph. global_headers · object

Show child attributes

graphql.supergraph.global_headers. {key} · string

graphql.supergraph. merged_sdl · string

graphql.supergraph. subgraphs · object[] | null

Show child attributes

graphql.supergraph.subgraphs. api_id · string

graphql.supergraph.subgraphs. headers · object

Show child attributes

graphql.supergraph.subgraphs.headers. {key} · string

graphql.supergraph.subgraphs. name · string

graphql.supergraph.subgraphs. sdl · string

graphql.supergraph.subgraphs. subscription_type · string

graphql.supergraph.subgraphs. url · string

graphql.supergraph. updated_at · string<date-time> | null

graphql. type_field_configurations · object[] | null

Show child attributes

graphql.type_field_configurations. data_source · object

Show child attributes

graphql.type_field_configurations.data_source. data_source_config · any

graphql.type_field_configurations.data_source. kind · string

graphql.type_field_configurations. field_name · string

graphql.type_field_configurations. mapping · object

Show child attributes

graphql.type_field_configurations.mapping. disabled · boolean

graphql.type_field_configurations.mapping. path · string

graphql.type_field_configurations. type_name · string

graphql. version · enum<string>

Available options: 1, 2,

hmac_allowed_algorithms · string[] | null

hmac_allowed_clock_skew · number

id · string

idp_client_id_mapping_disabled · boolean

internal · boolean

is_oas · boolean

jwt_client_base_field · string

jwt_default_policies · string[] | null

jwt_expires_at_validation_skew · integer

Required range: x >= 0

jwt_identity_base_field · string

jwt_issued_at_validation_skew · integer

Required range: x >= 0

jwt_not_before_validation_skew · integer

Required range: x >= 0

jwt_policy_field_name · string

jwt_scope_claim_name · string

jwt_scope_to_policy_mapping · object

Show child attributes

jwt_scope_to_policy_mapping. {key} · string

jwt_signing_method · string

jwt_skip_kid · boolean

jwt_source · string

listen_port · integer

name · string

notifications · object

Show child attributes

notifications. oauth_on_keychange_url · string

notifications. shared_secret · string

oauth_meta · object

Show child attributes

oauth_meta. allowed_access_types · string[] | null

oauth_meta. allowed_authorize_types · string[] | null

oauth_meta. auth_login_redirect · string

openid_options · object

Show child attributes

openid_options. providers · object[] | null

Show child attributes

openid_options.providers. client_ids · object

Show child attributes

openid_options.providers.client_ids. {key} · string

openid_options.providers. issuer · string

openid_options. segregate_by_client · boolean

org_id · string

pinned_public_keys · object

Show child attributes

pinned_public_keys. {key} · string

protocol · string

proxy · object

Show child attributes

proxy. check_host_against_uptime_tests · boolean

proxy. disable_strip_slash · boolean

proxy. enable_load_balancing · boolean

proxy. listen_path · string

Example:

"/relative-path-examples/"

proxy. preserve_host_header · boolean

proxy. service_discovery · object

Show child attributes

proxy.service_discovery. cache_disabled · boolean

proxy.service_discovery. cache_timeout · integer

proxy.service_discovery. data_path · string

proxy.service_discovery. endpoint_returns_list · boolean

proxy.service_discovery. parent_data_path · string

proxy.service_discovery. port_data_path · string

proxy.service_discovery. query_endpoint · string

proxy.service_discovery. target_path · string

proxy.service_discovery. use_discovery_service · boolean

proxy.service_discovery. use_nested_query · boolean

proxy.service_discovery. use_target_list · boolean

proxy. strip_listen_path · boolean

Example:

true

proxy. target_list · string[] | null

proxy. target_url · string

Example:

"https://httpbin.org/"

proxy. transport · object

Show child attributes

proxy.transport. proxy_url · string

proxy.transport. ssl_ciphers · string[] | null

proxy.transport. ssl_force_common_name_check · boolean

proxy.transport. ssl_insecure_skip_verify · boolean

proxy.transport. ssl_max_version · integer

Required range: x >= 0

proxy.transport. ssl_min_version · integer

Required range: x >= 0

request_signing · object

Show child attributes

request_signing. algorithm · string

request_signing. certificate_id · string

request_signing. header_list · string[] | null

request_signing. is_enabled · boolean

request_signing. key_id · string

request_signing. secret · string

request_signing. signature_header · string

response_processors · object[] | null

Show child attributes

response_processors. name · string

response_processors. options · any

scopes · object

Show child attributes

scopes. jwt · object

Show child attributes

scopes.jwt. scope_claim_name · string

scopes.jwt. scope_to_policy · object

Show child attributes

scopes.jwt.scope_to_policy. {key} · string

scopes. oidc · object

Show child attributes

scopes.oidc. scope_claim_name · string

scopes.oidc. scope_to_policy · object

Show child attributes

scopes.oidc.scope_to_policy. {key} · string

session_lifetime · integer

session_lifetime_respects_key_expiration · boolean

session_provider · object

Show child attributes

session_provider. meta · object

Show child attributes

session_provider.meta. {key} · any

session_provider. name · string

session_provider. storage_engine · string

slug · string

strip_auth_data · boolean

tag_headers · string[] | null

tags · string[] | null

Example:

["Default", "v1"]

tags_disabled · boolean

upstream_certificates · object

Show child attributes

upstream_certificates. {key} · string

upstream_certificates_disabled · boolean

uptime_tests · object

Show child attributes

uptime_tests. check_list · object[] | null

Show child attributes

uptime_tests.check_list. body · string

uptime_tests.check_list. commands · object[] | null

Show child attributes

uptime_tests.check_list.commands. message · string

uptime_tests.check_list.commands. name · string

uptime_tests.check_list. enable_proxy_protocol · boolean

uptime_tests.check_list. headers · object

Show child attributes

uptime_tests.check_list.headers. {key} · string

uptime_tests.check_list. method · string

uptime_tests.check_list. protocol · string

uptime_tests.check_list. timeout · integer

uptime_tests.check_list. url · string

uptime_tests. config · object

Show child attributes

uptime_tests.config. expire_utime_after · integer

uptime_tests.config. recheck_wait · integer

uptime_tests.config. service_discovery · object

Show child attributes

uptime_tests.config.service_discovery. cache_disabled · boolean

uptime_tests.config.service_discovery. cache_timeout · integer

uptime_tests.config.service_discovery. data_path · string

uptime_tests.config.service_discovery. endpoint_returns_list · boolean

uptime_tests.config.service_discovery. parent_data_path · string

uptime_tests.config.service_discovery. port_data_path · string

uptime_tests.config.service_discovery. query_endpoint · string

uptime_tests.config.service_discovery. target_path · string

uptime_tests.config.service_discovery. use_discovery_service · boolean

uptime_tests.config.service_discovery. use_nested_query · boolean

uptime_tests.config.service_discovery. use_target_list · boolean

use_basic_auth · boolean

use_go_plugin_auth · boolean

use_keyless · boolean

use_mutual_tls_auth · boolean

use_oauth2 · boolean

use_openid · boolean

use_standard_auth · boolean

version_data · object

Show child attributes

version_data. default_version · string

version_data. not_versioned · boolean

version_data. versions · object

Show child attributes

version_data.versions. {key} · object

Show child attributes

version_data.versions.{key}. expires · string

version_data.versions.{key}. extended_paths · object

Show child attributes

version_data.versions.{key}.extended_paths. advance_cache_config · object[]

Show child attributes

version_data.versions.{key}.extended_paths.advance_cache_config. cache_key_regex · string

version_data.versions.{key}.extended_paths.advance_cache_config. cache_response_codes · integer[] | null

version_data.versions.{key}.extended_paths.advance_cache_config. disabled · boolean

version_data.versions.{key}.extended_paths.advance_cache_config. method · string

version_data.versions.{key}.extended_paths.advance_cache_config. path · string

version_data.versions.{key}.extended_paths.advance_cache_config. timeout · integer<int64>

version_data.versions.{key}.extended_paths. black_list · object[]

Show child attributes

version_data.versions.{key}.extended_paths.black_list. disabled · boolean

version_data.versions.{key}.extended_paths.black_list. ignore_case · boolean

version_data.versions.{key}.extended_paths.black_list. method · string

version_data.versions.{key}.extended_paths.black_list. method_actions · object

Show child attributes

version_data.versions.{key}.extended_paths.black_list.method_actions. {key} · object

Show child attributes

version_data.versions.{key}.extended_paths.black_list.method_actions.{key}. action · enum<string>

Available options: no_action, reply

version_data.versions.{key}.extended_paths.black_list.method_actions.{key}. code · integer

version_data.versions.{key}.extended_paths.black_list.method_actions.{key}. data · string

version_data.versions.{key}.extended_paths.black_list.method_actions.{key}. headers · object

Show child attributes

version_data.versions.{key}.extended_paths.black_list.method_actions.{key}.headers. {key} · string

version_data.versions.{key}.extended_paths.black_list. path · string

version_data.versions.{key}.extended_paths. cache · string[]

version_data.versions.{key}.extended_paths. circuit_breakers · object[]

Show child attributes

version_data.versions.{key}.extended_paths.circuit_breakers. disable_half_open_state · boolean

version_data.versions.{key}.extended_paths.circuit_breakers. disabled · boolean

version_data.versions.{key}.extended_paths.circuit_breakers. method · string

version_data.versions.{key}.extended_paths.circuit_breakers. path · string

version_data.versions.{key}.extended_paths.circuit_breakers. return_to_service_after · integer

version_data.versions.{key}.extended_paths.circuit_breakers. samples · integer<int64>

version_data.versions.{key}.extended_paths.circuit_breakers. threshold_percent · number

version_data.versions.{key}.extended_paths. do_not_track_endpoints · object[]

Show child attributes

version_data.versions.{key}.extended_paths.do_not_track_endpoints. disabled · boolean

version_data.versions.{key}.extended_paths.do_not_track_endpoints. method · string

version_data.versions.{key}.extended_paths.do_not_track_endpoints. path · string

version_data.versions.{key}.extended_paths. go_plugin · object[]

Show child attributes

version_data.versions.{key}.extended_paths.go_plugin. disabled · boolean

version_data.versions.{key}.extended_paths.go_plugin. func_name · string

version_data.versions.{key}.extended_paths.go_plugin. method · string

version_data.versions.{key}.extended_paths.go_plugin. path · string

version_data.versions.{key}.extended_paths.go_plugin. plugin_path · string

version_data.versions.{key}.extended_paths. hard_timeouts · object[]

Show child attributes

version_data.versions.{key}.extended_paths.hard_timeouts. disabled · boolean

version_data.versions.{key}.extended_paths.hard_timeouts. method · string

version_data.versions.{key}.extended_paths.hard_timeouts. path · string

version_data.versions.{key}.extended_paths.hard_timeouts. timeout · integer

version_data.versions.{key}.extended_paths. ignored · object[]

Show child attributes

version_data.versions.{key}.extended_paths.ignored. disabled · boolean

version_data.versions.{key}.extended_paths.ignored. ignore_case · boolean

version_data.versions.{key}.extended_paths.ignored. method · string

version_data.versions.{key}.extended_paths.ignored. method_actions · object

Show child attributes

version_data.versions.{key}.extended_paths.ignored.method_actions. {key} · object

Show child attributes

version_data.versions.{key}.extended_paths.ignored.method_actions.{key}. action · enum<string>

Available options: no_action, reply

version_data.versions.{key}.extended_paths.ignored.method_actions.{key}. code · integer

version_data.versions.{key}.extended_paths.ignored.method_actions.{key}. data · string

version_data.versions.{key}.extended_paths.ignored.method_actions.{key}. headers · object

Show child attributes

version_data.versions.{key}.extended_paths.ignored.method_actions.{key}.headers. {key} · string

version_data.versions.{key}.extended_paths.ignored. path · string

version_data.versions.{key}.extended_paths. internal · object[]

Show child attributes

version_data.versions.{key}.extended_paths.internal. disabled · boolean

version_data.versions.{key}.extended_paths.internal. method · string

version_data.versions.{key}.extended_paths.internal. path · string

version_data.versions.{key}.extended_paths. method_transforms · object[]

Show child attributes

version_data.versions.{key}.extended_paths.method_transforms. disabled · boolean

version_data.versions.{key}.extended_paths.method_transforms. method · string

version_data.versions.{key}.extended_paths.method_transforms. path · string

version_data.versions.{key}.extended_paths.method_transforms. to_method · string

version_data.versions.{key}.extended_paths. mock_response · object[]

Show child attributes

version_data.versions.{key}.extended_paths.mock_response. body · string

version_data.versions.{key}.extended_paths.mock_response. code · integer

version_data.versions.{key}.extended_paths.mock_response. disabled · boolean

version_data.versions.{key}.extended_paths.mock_response. headers · object

Show child attributes

version_data.versions.{key}.extended_paths.mock_response.headers. {key} · string

version_data.versions.{key}.extended_paths.mock_response. ignore_case · boolean

version_data.versions.{key}.extended_paths.mock_response. method · string

version_data.versions.{key}.extended_paths.mock_response. path · string

version_data.versions.{key}.extended_paths. persist_graphql · object[] | null

Show child attributes

version_data.versions.{key}.extended_paths.persist_graphql. method · string

version_data.versions.{key}.extended_paths.persist_graphql. operation · string

version_data.versions.{key}.extended_paths.persist_graphql. path · string

version_data.versions.{key}.extended_paths.persist_graphql. variables · object

Show child attributes

version_data.versions.{key}.extended_paths.persist_graphql.variables. {key} · any

version_data.versions.{key}.extended_paths. rate_limit · object[] | null

Show child attributes

version_data.versions.{key}.extended_paths.rate_limit. disabled · boolean

version_data.versions.{key}.extended_paths.rate_limit. method · string

version_data.versions.{key}.extended_paths.rate_limit. path · string

version_data.versions.{key}.extended_paths.rate_limit. per · number

version_data.versions.{key}.extended_paths.rate_limit. rate · number

version_data.versions.{key}.extended_paths. size_limits · object[]

Show child attributes

version_data.versions.{key}.extended_paths.size_limits. disabled · boolean

version_data.versions.{key}.extended_paths.size_limits. method · string

version_data.versions.{key}.extended_paths.size_limits. path · string

version_data.versions.{key}.extended_paths.size_limits. size_limit · integer<int64>

version_data.versions.{key}.extended_paths. track_endpoints · object[]

Show child attributes

version_data.versions.{key}.extended_paths.track_endpoints. disabled · boolean

version_data.versions.{key}.extended_paths.track_endpoints. method · string

version_data.versions.{key}.extended_paths.track_endpoints. path · string

version_data.versions.{key}.extended_paths. transform · object[]

Show child attributes

version_data.versions.{key}.extended_paths.transform. disabled · boolean

version_data.versions.{key}.extended_paths.transform. method · string

version_data.versions.{key}.extended_paths.transform. path · string

version_data.versions.{key}.extended_paths.transform. template_data · object

Show child attributes

version_data.versions.{key}.extended_paths.transform.template_data. enable_session · boolean

version_data.versions.{key}.extended_paths.transform.template_data. input_type · enum<string>

Available options: json, xml

version_data.versions.{key}.extended_paths.transform.template_data. template_mode · enum<string>

Available options: blob, file

version_data.versions.{key}.extended_paths.transform.template_data. template_source · string

version_data.versions.{key}.extended_paths. transform_headers · object[]

Show child attributes

version_data.versions.{key}.extended_paths.transform_headers. act_on · boolean

version_data.versions.{key}.extended_paths.transform_headers. add_headers · object

Show child attributes

version_data.versions.{key}.extended_paths.transform_headers.add_headers. {key} · string

version_data.versions.{key}.extended_paths.transform_headers. delete_headers · string[] | null

version_data.versions.{key}.extended_paths.transform_headers. disabled · boolean

version_data.versions.{key}.extended_paths.transform_headers. method · string

version_data.versions.{key}.extended_paths.transform_headers. path · string

version_data.versions.{key}.extended_paths. transform_jq · object[]

Show child attributes

version_data.versions.{key}.extended_paths.transform_jq. filter · string

version_data.versions.{key}.extended_paths.transform_jq. method · string

version_data.versions.{key}.extended_paths.transform_jq. path · string

version_data.versions.{key}.extended_paths. transform_jq_response · object[]

Show child attributes

version_data.versions.{key}.extended_paths.transform_jq_response. filter · string

version_data.versions.{key}.extended_paths.transform_jq_response. method · string

version_data.versions.{key}.extended_paths.transform_jq_response. path · string

version_data.versions.{key}.extended_paths. transform_response · object[]

Show child attributes

version_data.versions.{key}.extended_paths.transform_response. disabled · boolean

version_data.versions.{key}.extended_paths.transform_response. method · string

version_data.versions.{key}.extended_paths.transform_response. path · string

version_data.versions.{key}.extended_paths.transform_response. template_data · object

Show child attributes

version_data.versions.{key}.extended_paths.transform_response.template_data. enable_session · boolean

version_data.versions.{key}.extended_paths.transform_response.template_data. input_type · enum<string>

Available options: json, xml

version_data.versions.{key}.extended_paths.transform_response.template_data. template_mode · enum<string>

Available options: blob, file

version_data.versions.{key}.extended_paths.transform_response.template_data. template_source · string

version_data.versions.{key}.extended_paths. transform_response_headers · object[]

Show child attributes

version_data.versions.{key}.extended_paths.transform_response_headers. act_on · boolean

version_data.versions.{key}.extended_paths.transform_response_headers. add_headers · object

Show child attributes

version_data.versions.{key}.extended_paths.transform_response_headers.add_headers. {key} · string

version_data.versions.{key}.extended_paths.transform_response_headers. delete_headers · string[] | null

version_data.versions.{key}.extended_paths.transform_response_headers. disabled · boolean

version_data.versions.{key}.extended_paths.transform_response_headers. method · string

version_data.versions.{key}.extended_paths.transform_response_headers. path · string

version_data.versions.{key}.extended_paths. url_rewrites · object[]

Show child attributes

version_data.versions.{key}.extended_paths.url_rewrites. disabled · boolean

version_data.versions.{key}.extended_paths.url_rewrites. match_pattern · string

version_data.versions.{key}.extended_paths.url_rewrites. method · string

version_data.versions.{key}.extended_paths.url_rewrites. path · string

version_data.versions.{key}.extended_paths.url_rewrites. rewrite_to · string

version_data.versions.{key}.extended_paths.url_rewrites. triggers · object[] | null

Show child attributes

version_data.versions.{key}.extended_paths.url_rewrites.triggers. on · enum<string>

Available options: all, any

version_data.versions.{key}.extended_paths.url_rewrites.triggers. options · object

Show child attributes

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options. header_matches · object

Show child attributes

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options.header_matches. {key} · object

Show child attributes

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options.header_matches.{key}. match_rx · string

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options.header_matches.{key}. reverse · boolean

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options. path_part_matches · object

Show child attributes

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options.path_part_matches. {key} · object

Show child attributes

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options.path_part_matches.{key}. match_rx · string

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options.path_part_matches.{key}. reverse · boolean

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options. payload_matches · object

Show child attributes

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options.payload_matches. match_rx · string

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options.payload_matches. reverse · boolean

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options. query_val_matches · object

Show child attributes

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options.query_val_matches. {key} · object

Show child attributes

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options.query_val_matches.{key}. match_rx · string

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options.query_val_matches.{key}. reverse · boolean

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options. request_context_matches · object

Show child attributes

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options.request_context_matches. {key} · object

Show child attributes

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options.request_context_matches.{key}. match_rx · string

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options.request_context_matches.{key}. reverse · boolean

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options. session_meta_matches · object

Show child attributes

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options.session_meta_matches. {key} · object

Show child attributes

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options.session_meta_matches.{key}. match_rx · string

version_data.versions.{key}.extended_paths.url_rewrites.triggers.options.session_meta_matches.{key}. reverse · boolean

version_data.versions.{key}.extended_paths.url_rewrites.triggers. rewrite_to · string

version_data.versions.{key}.extended_paths. validate_json · object[]

Show child attributes

version_data.versions.{key}.extended_paths.validate_json. disabled · boolean

version_data.versions.{key}.extended_paths.validate_json. error_response_code · integer

version_data.versions.{key}.extended_paths.validate_json. method · string

version_data.versions.{key}.extended_paths.validate_json. path · string

version_data.versions.{key}.extended_paths.validate_json. schema · object

Show child attributes

version_data.versions.{key}.extended_paths.validate_json.schema. {key} · any

version_data.versions.{key}.extended_paths.validate_json. schema_b64 · string

version_data.versions.{key}.extended_paths. validate_request · object[]

Show child attributes

version_data.versions.{key}.extended_paths.validate_request. enabled · boolean

version_data.versions.{key}.extended_paths.validate_request. error_response_code · integer

version_data.versions.{key}.extended_paths.validate_request. method · string

version_data.versions.{key}.extended_paths.validate_request. path · string

version_data.versions.{key}.extended_paths. virtual · object[]

Show child attributes

version_data.versions.{key}.extended_paths.virtual. disabled · boolean

version_data.versions.{key}.extended_paths.virtual. function_source_type · enum<string>

Available options: blob, file

version_data.versions.{key}.extended_paths.virtual. function_source_uri · string

version_data.versions.{key}.extended_paths.virtual. method · string

version_data.versions.{key}.extended_paths.virtual. path · string

version_data.versions.{key}.extended_paths.virtual. proxy_on_error · boolean

version_data.versions.{key}.extended_paths.virtual. response_function_name · string

version_data.versions.{key}.extended_paths.virtual. use_session · boolean

version_data.versions.{key}.extended_paths. white_list · object[]

Show child attributes

version_data.versions.{key}.extended_paths.white_list. disabled · boolean

version_data.versions.{key}.extended_paths.white_list. ignore_case · boolean

version_data.versions.{key}.extended_paths.white_list. method · string

version_data.versions.{key}.extended_paths.white_list. method_actions · object

Show child attributes

version_data.versions.{key}.extended_paths.white_list.method_actions. {key} · object

Show child attributes

version_data.versions.{key}.extended_paths.white_list.method_actions.{key}. action · enum<string>

Available options: no_action, reply

version_data.versions.{key}.extended_paths.white_list.method_actions.{key}. code · integer

version_data.versions.{key}.extended_paths.white_list.method_actions.{key}. data · string

version_data.versions.{key}.extended_paths.white_list.method_actions.{key}. headers · object

Show child attributes

version_data.versions.{key}.extended_paths.white_list.method_actions.{key}.headers. {key} · string

version_data.versions.{key}.extended_paths.white_list. path · string

version_data.versions.{key}. global_headers · object

Show child attributes

version_data.versions.{key}.global_headers. {key} · string

version_data.versions.{key}. global_headers_disabled · boolean

version_data.versions.{key}. global_headers_remove · string[] | null

version_data.versions.{key}. global_response_headers · object

Show child attributes

version_data.versions.{key}.global_response_headers. {key} · string

version_data.versions.{key}. global_response_headers_disabled · boolean

version_data.versions.{key}. global_response_headers_remove · string[] | null

version_data.versions.{key}. global_size_limit · integer<int64>

version_data.versions.{key}. ignore_endpoint_case · boolean

version_data.versions.{key}. name · string

version_data.versions.{key}. override_target · string

version_data.versions.{key}. paths · object

Show child attributes

version_data.versions.{key}.paths. black_list · string[] | null

version_data.versions.{key}.paths. ignored · string[] | null

version_data.versions.{key}.paths. white_list · string[] | null

version_data.versions.{key}. use_extended_paths · boolean

Example:

true

Response

200

application/json

API updated.

action · string

Example:

"modified"

key · string

Example:

"b13d928b9972bd18"

key_hash · string

status · string

Example:

"ok"