Update API Definition

Update an API Definition. api_id can be updated for On-Premise installations, but it cannot be updated when the Dashboard resides in Tyk Cloud. Updates to api_id in Tyk Cloud will be ignored.

PUT /api/apis/{apiId}

Try it

Update API Definition

cURL

curl --request PUT \
  --url https://{tenant}/api/apis/{apiId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "api_definition": {
    "CORS": {
      "allow_credentials": true,
      "allowed_headers": [
        "<string>"
      ],
      "allowed_methods": [
        "<string>"
      ],
      "allowed_origins": [
        "<string>"
      ],
      "debug": true,
      "enable": true,
      "exposed_headers": [
        "<string>"
      ],
      "max_age": 123,
      "options_passthrough": true
    },
    "active": true,
    "allowed_ips": [
      "<string>"
    ],
    "analytics_plugin": {
      "enable": true,
      "func_name": "<string>",
      "plugin_path": "<string>"
    },
    "api_id": "<string>",
    "auth": {
      "auth_header_name": "<string>",
      "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": true,
      "cache_by_headers": [
        "<string>"
      ],
      "cache_control_ttl_header": "<string>",
      "cache_response_codes": [
        123
      ],
      "cache_timeout": 123,
      "enable_cache": true,
      "enable_upstream_cache_control": true
    },
    "certificate_pinning_disabled": true,
    "certificates": [
      "<string>"
    ],
    "client_certificates": [
      "<string>"
    ],
    "config_data": {},
    "config_data_disabled": true,
    "custom_middleware": {
      "auth_check": {
        "disabled": true,
        "name": "<string>",
        "path": "<string>",
        "raw_body_only": true,
        "require_session": true
      },
      "driver": "<string>",
      "id_extractor": {
        "disabled": true,
        "extract_from": "<string>",
        "extract_with": "<string>",
        "extractor_config": {}
      },
      "post": [
        {
          "disabled": true,
          "name": "<string>",
          "path": "<string>",
          "raw_body_only": true,
          "require_session": true
        }
      ],
      "post_key_auth": [
        {
          "disabled": true,
          "name": "<string>",
          "path": "<string>",
          "raw_body_only": true,
          "require_session": true
        }
      ],
      "pre": [
        {
          "disabled": true,
          "name": "<string>",
          "path": "<string>",
          "raw_body_only": true,
          "require_session": true
        }
      ],
      "response": [
        {
          "disabled": true,
          "name": "<string>",
          "path": "<string>",
          "raw_body_only": true,
          "require_session": true
        }
      ]
    },
    "custom_middleware_bundle": "<string>",
    "custom_middleware_bundle_disabled": true,
    "custom_plugin_auth_enabled": true,
    "definition": {
      "default": "<string>",
      "enabled": true,
      "fallback_to_default": true,
      "key": "<string>",
      "location": "<string>",
      "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": "<string>",
      "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": "<string>"
    },
    "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": "<string>",
      "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": "<string>",
      "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": [
      "<string>"
    ],
    "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": "30s",
          "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": {}
    }
  },
  "api_model": {},
  "categories": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "hook_references": [
    {
      "event_name": "<string>",
      "event_timeout": 123,
      "hook": {
        "method": "POST",
        "target_path": "https://httpbin.org/expired-keys",
        "api_model": {},
        "event_timeout": 0,
        "header_map": {
          "secret": "superscretkey",
          "x-auth": "authvalue"
        },
        "id": "664b613f5715ec4c96cbef3e",
        "name": "Expired Keys webhook",
        "org_id": "5e9d9544a1dcd60001d0ed20",
        "template_path": "templates/default_webhook.json",
        "webhook_id": "1f78e319202b430e92286cff3ca759e3"
      }
    }
  ],
  "is_site": true,
  "oas": {
    "components": {
      "callbacks": {},
      "examples": {},
      "headers": {},
      "links": {},
      "parameters": {},
      "requestBodies": {},
      "responses": {},
      "schemas": {},
      "securitySchemes": {}
    },
    "externalDocs": {
      "description": "<string>",
      "url": "<string>"
    },
    "info": {
      "contact": {
        "email": "<string>",
        "name": "<string>",
        "url": "<string>"
      },
      "description": "<string>",
      "license": {
        "name": "<string>",
        "url": "<string>"
      },
      "termsOfService": "<string>",
      "title": "<string>",
      "version": "<string>"
    },
    "openapi": "<string>",
    "paths": {},
    "security": [
      {}
    ],
    "servers": [
      {
        "description": "<string>",
        "url": "<string>",
        "variables": {}
      }
    ],
    "tags": [
      {
        "description": "<string>",
        "externalDocs": {
          "description": "<string>",
          "url": "<string>"
        },
        "name": "<string>"
      }
    ]
  },
  "sort_by": 123,
  "updated_at": "2023-11-07T05:31:56Z",
  "user_group_owners": [
    "<string>"
  ],
  "user_owners": [
    "<string>"
  ]
}
'

200

{
  "ID": "<string>",
  "Message": "<string>",
  "Meta": "<unknown>",
  "Status": "<string>"
}

Authorizations

Authorization · string · header · required

The Tyk Dashboard API Access Credentials

Path Parameters

apiId · string · required

ID of API to get. Can either be internal or public API ID.

Body

application/json

api_definition · object

Show child attributes

api_definition. CORS · object

Show child attributes

api_definition.CORS. allow_credentials · boolean

api_definition.CORS. allowed_headers · string[] | null

api_definition.CORS. allowed_methods · string[] | null

api_definition.CORS. allowed_origins · string[] | null

api_definition.CORS. debug · boolean

api_definition.CORS. enable · boolean

api_definition.CORS. exposed_headers · string[] | null

api_definition.CORS. max_age · integer

api_definition.CORS. options_passthrough · boolean

api_definition. active · boolean

api_definition. allowed_ips · string[] | null

api_definition. analytics_plugin · object

Show child attributes

api_definition.analytics_plugin. enable · boolean

api_definition.analytics_plugin. func_name · string

api_definition.analytics_plugin. plugin_path · string

api_definition. api_id · string

api_definition. auth · object

Show child attributes

api_definition.auth. auth_header_name · string

api_definition.auth. cookie_name · string

api_definition.auth. disable_header · boolean

api_definition.auth. name · string

api_definition.auth. param_name · string

api_definition.auth. signature · object

Show child attributes

api_definition.auth.signature. algorithm · string

api_definition.auth.signature. allowed_clock_skew · integer<int64>

api_definition.auth.signature. error_code · integer

api_definition.auth.signature. error_message · string

api_definition.auth.signature. header · string

api_definition.auth.signature. param_name · string

api_definition.auth.signature. secret · string

api_definition.auth.signature. use_param · boolean

api_definition.auth. use_certificate · boolean

api_definition.auth. use_cookie · boolean

api_definition.auth. use_param · boolean

api_definition.auth. validate_signature · boolean

api_definition. auth_configs · object

Show child attributes

api_definition.auth_configs. {key} · object

Show child attributes

api_definition.auth_configs.{key}. auth_header_name · string

api_definition.auth_configs.{key}. cookie_name · string

api_definition.auth_configs.{key}. disable_header · boolean

api_definition.auth_configs.{key}. name · string

api_definition.auth_configs.{key}. param_name · string

api_definition.auth_configs.{key}. signature · object

Show child attributes

api_definition.auth_configs.{key}.signature. algorithm · string

api_definition.auth_configs.{key}.signature. allowed_clock_skew · integer<int64>

api_definition.auth_configs.{key}.signature. error_code · integer

api_definition.auth_configs.{key}.signature. error_message · string

api_definition.auth_configs.{key}.signature. header · string

api_definition.auth_configs.{key}.signature. param_name · string

api_definition.auth_configs.{key}.signature. secret · string

api_definition.auth_configs.{key}.signature. use_param · boolean

api_definition.auth_configs.{key}. use_certificate · boolean

api_definition.auth_configs.{key}. use_cookie · boolean

api_definition.auth_configs.{key}. use_param · boolean

api_definition.auth_configs.{key}. validate_signature · boolean

api_definition. auth_provider · object

Show child attributes

api_definition.auth_provider. meta · object

Show child attributes

api_definition.auth_provider.meta. {key} · any

api_definition.auth_provider. name · string

api_definition.auth_provider. storage_engine · string

api_definition. base_identity_provided_by · string

api_definition. basic_auth · object

Show child attributes

api_definition.basic_auth. body_password_regexp · string

api_definition.basic_auth. body_user_regexp · string

api_definition.basic_auth. cache_ttl · integer

api_definition.basic_auth. disable_caching · boolean

api_definition.basic_auth. extract_from_body · boolean

api_definition. blacklisted_ips · string[] | null

api_definition. cache_options · object

Show child attributes

api_definition.cache_options. cache_all_safe_requests · boolean

api_definition.cache_options. cache_by_headers · string[] | null

api_definition.cache_options. cache_control_ttl_header · string

api_definition.cache_options. cache_response_codes · integer[] | null

api_definition.cache_options. cache_timeout · integer<int64>

api_definition.cache_options. enable_cache · boolean

api_definition.cache_options. enable_upstream_cache_control · boolean

api_definition. certificate_pinning_disabled · boolean

api_definition. certificates · string[] | null

api_definition. client_certificates · string[] | null

api_definition. config_data · object

Show child attributes

api_definition.config_data. {key} · any

api_definition. config_data_disabled · boolean

api_definition. custom_middleware · object

Show child attributes

api_definition.custom_middleware. auth_check · object

Show child attributes

api_definition.custom_middleware.auth_check. disabled · boolean

api_definition.custom_middleware.auth_check. name · string

api_definition.custom_middleware.auth_check. path · string

api_definition.custom_middleware.auth_check. raw_body_only · boolean

api_definition.custom_middleware.auth_check. require_session · boolean

api_definition.custom_middleware. driver · string

api_definition.custom_middleware. id_extractor · object

Show child attributes

api_definition.custom_middleware.id_extractor. disabled · boolean

api_definition.custom_middleware.id_extractor. extract_from · string

api_definition.custom_middleware.id_extractor. extract_with · string

api_definition.custom_middleware.id_extractor. extractor_config · object

Show child attributes

api_definition.custom_middleware.id_extractor.extractor_config. {key} · any

api_definition.custom_middleware. post · object[] | null

Show child attributes

api_definition.custom_middleware.post. disabled · boolean

api_definition.custom_middleware.post. name · string

api_definition.custom_middleware.post. path · string

api_definition.custom_middleware.post. raw_body_only · boolean

api_definition.custom_middleware.post. require_session · boolean

api_definition.custom_middleware. post_key_auth · object[] | null

Show child attributes

api_definition.custom_middleware.post_key_auth. disabled · boolean

api_definition.custom_middleware.post_key_auth. name · string

api_definition.custom_middleware.post_key_auth. path · string

api_definition.custom_middleware.post_key_auth. raw_body_only · boolean

api_definition.custom_middleware.post_key_auth. require_session · boolean

api_definition.custom_middleware. pre · object[] | null

Show child attributes

api_definition.custom_middleware.pre. disabled · boolean

api_definition.custom_middleware.pre. name · string

api_definition.custom_middleware.pre. path · string

api_definition.custom_middleware.pre. raw_body_only · boolean

api_definition.custom_middleware.pre. require_session · boolean

api_definition.custom_middleware. response · object[] | null

Show child attributes

api_definition.custom_middleware.response. disabled · boolean

api_definition.custom_middleware.response. name · string

api_definition.custom_middleware.response. path · string

api_definition.custom_middleware.response. raw_body_only · boolean

api_definition.custom_middleware.response. require_session · boolean

api_definition. custom_middleware_bundle · string

api_definition. custom_middleware_bundle_disabled · boolean

api_definition. custom_plugin_auth_enabled · boolean

api_definition. definition · object

Show child attributes

api_definition.definition. default · string

api_definition.definition. enabled · boolean

api_definition.definition. fallback_to_default · boolean

api_definition.definition. key · string

api_definition.definition. location · string

api_definition.definition. name · string

api_definition.definition. strip_path · boolean

api_definition.definition. strip_versioning_data · boolean

api_definition.definition. url_versioning_pattern · string

api_definition.definition. versions · object

Show child attributes

api_definition.definition.versions. {key} · string

api_definition. detailed_tracing · boolean

api_definition. disable_quota · boolean

api_definition. disable_rate_limit · boolean

api_definition. do_not_track · boolean

api_definition. domain · string

api_definition. domain_disabled · boolean

api_definition. dont_set_quota_on_create · boolean

api_definition. enable_batch_request_support · boolean

api_definition. enable_context_vars · boolean

api_definition. enable_coprocess_auth · boolean

api_definition. enable_detailed_recording · boolean

api_definition. enable_ip_blacklisting · boolean

api_definition. enable_ip_whitelisting · boolean

api_definition. enable_jwt · boolean

api_definition. enable_proxy_protocol · boolean

api_definition. enable_signature_checking · boolean

api_definition. event_handlers · object

Show child attributes

api_definition.event_handlers. events · object

Show child attributes

api_definition.event_handlers.events. {key} · object[]

Show child attributes

api_definition.event_handlers.events.{key}. handler_meta · object

Show child attributes

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

api_definition.event_handlers.events.{key}. handler_name · string

api_definition. expiration · string

api_definition. expire_analytics_after · integer<int64>

api_definition. external_oauth · object

Show child attributes

api_definition.external_oauth. enabled · boolean

api_definition.external_oauth. providers · object[] | null

Show child attributes

api_definition.external_oauth.providers. introspection · object

Show child attributes

api_definition.external_oauth.providers.introspection. cache · object

Show child attributes

api_definition.external_oauth.providers.introspection.cache. enabled · boolean

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

api_definition.external_oauth.providers.introspection. client_id · string

api_definition.external_oauth.providers.introspection. client_secret · string

api_definition.external_oauth.providers.introspection. enabled · boolean

api_definition.external_oauth.providers.introspection. identity_base_field · string

api_definition.external_oauth.providers.introspection. url · string

api_definition.external_oauth.providers. jwt · object

Show child attributes

api_definition.external_oauth.providers.jwt. enabled · boolean

api_definition.external_oauth.providers.jwt. expires_at_validation_skew · integer

Required range: x >= 0

api_definition.external_oauth.providers.jwt. identity_base_field · string

api_definition.external_oauth.providers.jwt. issued_at_validation_skew · integer

Required range: x >= 0

api_definition.external_oauth.providers.jwt. not_before_validation_skew · integer

Required range: x >= 0

api_definition.external_oauth.providers.jwt. signing_method · string

api_definition.external_oauth.providers.jwt. source · string

api_definition. global_rate_limit · object

Show child attributes

api_definition.global_rate_limit. disabled · boolean

api_definition.global_rate_limit. per · number<double>

api_definition.global_rate_limit. rate · number<double>

api_definition. graphql · object

Show child attributes

api_definition.graphql. enabled · boolean

api_definition.graphql. engine · object

Show child attributes

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

Show child attributes

api_definition.graphql.engine.data_sources. config · any

api_definition.graphql.engine.data_sources. internal · boolean

api_definition.graphql.engine.data_sources. kind · string

api_definition.graphql.engine.data_sources. name · string

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

Show child attributes

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

api_definition.graphql.engine.data_sources.root_fields. type · string

api_definition.graphql.engine. field_configs · object[] | null

Show child attributes

api_definition.graphql.engine.field_configs. disable_default_mapping · boolean

api_definition.graphql.engine.field_configs. field_name · string

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

api_definition.graphql.engine.field_configs. type_name · string

api_definition.graphql.engine. global_headers · object[] | null

Show child attributes

api_definition.graphql.engine.global_headers. key · string

api_definition.graphql.engine.global_headers. value · string

api_definition.graphql. execution_mode · string

api_definition.graphql. introspection · object

Show child attributes

api_definition.graphql.introspection. disabled · boolean

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

api_definition.graphql. playground · object

Show child attributes

api_definition.graphql.playground. enabled · boolean

api_definition.graphql.playground. path · string

api_definition.graphql. proxy · object

Show child attributes

api_definition.graphql.proxy. auth_headers · object

Show child attributes

api_definition.graphql.proxy.auth_headers. {key} · string

api_definition.graphql.proxy. features · object

Show child attributes

api_definition.graphql.proxy.features. use_immutable_headers · boolean

api_definition.graphql.proxy. request_headers · object

Show child attributes

api_definition.graphql.proxy.request_headers. {key} · string

api_definition.graphql.proxy. request_headers_rewrite · object

Show child attributes

api_definition.graphql.proxy.request_headers_rewrite. {key} · object

Show child attributes

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

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

api_definition.graphql.proxy. subscription_type · string

api_definition.graphql.proxy. use_response_extensions · object

Show child attributes

api_definition.graphql.proxy.use_response_extensions. on_error_forwarding · boolean

api_definition.graphql. schema · string

api_definition.graphql. subgraph · object

Show child attributes

api_definition.graphql.subgraph. sdl · string

api_definition.graphql. supergraph · object

Show child attributes

api_definition.graphql.supergraph. disable_query_batching · boolean

api_definition.graphql.supergraph. global_headers · object

Show child attributes

api_definition.graphql.supergraph.global_headers. {key} · string

api_definition.graphql.supergraph. merged_sdl · string

api_definition.graphql.supergraph. subgraphs · object[] | null

Show child attributes

api_definition.graphql.supergraph.subgraphs. api_id · string

api_definition.graphql.supergraph.subgraphs. headers · object

Show child attributes

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

api_definition.graphql.supergraph.subgraphs. name · string

api_definition.graphql.supergraph.subgraphs. sdl · string

api_definition.graphql.supergraph.subgraphs. subscription_type · string

api_definition.graphql.supergraph.subgraphs. url · string

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

api_definition.graphql. type_field_configurations · object[] | null

Show child attributes

api_definition.graphql.type_field_configurations. data_source · object

Show child attributes

api_definition.graphql.type_field_configurations.data_source. data_source_config · any

api_definition.graphql.type_field_configurations.data_source. kind · string

api_definition.graphql.type_field_configurations. field_name · string

api_definition.graphql.type_field_configurations. mapping · object

Show child attributes

api_definition.graphql.type_field_configurations.mapping. disabled · boolean

api_definition.graphql.type_field_configurations.mapping. path · string

api_definition.graphql.type_field_configurations. type_name · string

api_definition.graphql. version · string

api_definition. hmac_allowed_algorithms · string[] | null

api_definition. hmac_allowed_clock_skew · number<double>

api_definition. id · string

api_definition. idp_client_id_mapping_disabled · boolean

api_definition. internal · boolean

api_definition. is_oas · boolean

api_definition. jwt_client_base_field · string

api_definition. jwt_default_policies · string[] | null

api_definition. jwt_expires_at_validation_skew · integer

Required range: x >= 0

api_definition. jwt_identity_base_field · string

api_definition. jwt_issued_at_validation_skew · integer

Required range: x >= 0

api_definition. jwt_not_before_validation_skew · integer

Required range: x >= 0

api_definition. jwt_policy_field_name · string

api_definition. jwt_scope_claim_name · string

api_definition. jwt_scope_to_policy_mapping · object

Show child attributes

api_definition.jwt_scope_to_policy_mapping. {key} · string

api_definition. jwt_signing_method · string

api_definition. jwt_skip_kid · boolean

api_definition. jwt_source · string

api_definition. listen_port · integer

api_definition. name · string

api_definition. notifications · object

Show child attributes

api_definition.notifications. oauth_on_keychange_url · string

api_definition.notifications. shared_secret · string

api_definition. oauth_meta · object

Show child attributes

api_definition.oauth_meta. allowed_access_types · string[] | null

api_definition.oauth_meta. allowed_authorize_types · string[] | null

api_definition.oauth_meta. auth_login_redirect · string

api_definition. openid_options · object

Show child attributes

api_definition.openid_options. providers · object[] | null

Show child attributes

api_definition.openid_options.providers. client_ids · object

Show child attributes

api_definition.openid_options.providers.client_ids. {key} · string

api_definition.openid_options.providers. issuer · string

api_definition.openid_options. segregate_by_client · boolean

api_definition. org_id · string

api_definition. pinned_public_keys · object

Show child attributes

api_definition.pinned_public_keys. {key} · string

api_definition. protocol · string

api_definition. proxy · object

Show child attributes

api_definition.proxy. check_host_against_uptime_tests · boolean

api_definition.proxy. disable_strip_slash · boolean

api_definition.proxy. enable_load_balancing · boolean

api_definition.proxy. listen_path · string

api_definition.proxy. preserve_host_header · boolean

api_definition.proxy. service_discovery · object

Show child attributes

api_definition.proxy.service_discovery. cache_disabled · boolean

api_definition.proxy.service_discovery. cache_timeout · integer<int64>

api_definition.proxy.service_discovery. data_path · string

api_definition.proxy.service_discovery. endpoint_returns_list · boolean

api_definition.proxy.service_discovery. parent_data_path · string

api_definition.proxy.service_discovery. port_data_path · string

api_definition.proxy.service_discovery. query_endpoint · string

api_definition.proxy.service_discovery. target_path · string

api_definition.proxy.service_discovery. use_discovery_service · boolean

api_definition.proxy.service_discovery. use_nested_query · boolean

api_definition.proxy.service_discovery. use_target_list · boolean

api_definition.proxy. strip_listen_path · boolean

api_definition.proxy. target_list · string[] | null

api_definition.proxy. target_url · string

api_definition.proxy. transport · object

Show child attributes

api_definition.proxy.transport. proxy_url · string

api_definition.proxy.transport. ssl_ciphers · string[] | null

api_definition.proxy.transport. ssl_force_common_name_check · boolean

api_definition.proxy.transport. ssl_insecure_skip_verify · boolean

api_definition.proxy.transport. ssl_max_version · integer

Required range: x >= 0

api_definition.proxy.transport. ssl_min_version · integer

Required range: x >= 0

api_definition. request_signing · object

Show child attributes

api_definition.request_signing. algorithm · string

api_definition.request_signing. certificate_id · string

api_definition.request_signing. header_list · string[] | null

api_definition.request_signing. is_enabled · boolean

api_definition.request_signing. key_id · string

api_definition.request_signing. secret · string

api_definition.request_signing. signature_header · string

api_definition. response_processors · object[] | null

Show child attributes

api_definition.response_processors. name · string

api_definition.response_processors. options · any

api_definition. scopes · object

Show child attributes

api_definition.scopes. jwt · object

Show child attributes

api_definition.scopes.jwt. scope_claim_name · string

api_definition.scopes.jwt. scope_to_policy · object

Show child attributes

api_definition.scopes.jwt.scope_to_policy. {key} · string

api_definition.scopes. oidc · object

Show child attributes

api_definition.scopes.oidc. scope_claim_name · string

api_definition.scopes.oidc. scope_to_policy · object

Show child attributes

api_definition.scopes.oidc.scope_to_policy. {key} · string

api_definition. session_lifetime · integer<int64>

api_definition. session_lifetime_respects_key_expiration · boolean

api_definition. session_provider · object

Show child attributes

api_definition.session_provider. meta · object

Show child attributes

api_definition.session_provider.meta. {key} · any

api_definition.session_provider. name · string

api_definition.session_provider. storage_engine · string

api_definition. slug · string

api_definition. strip_auth_data · boolean

api_definition. tag_headers · string[] | null

api_definition. tags · string[] | null

api_definition. tags_disabled · boolean

api_definition. upstream_certificates · object

Show child attributes

api_definition.upstream_certificates. {key} · string

api_definition. upstream_certificates_disabled · boolean

api_definition. uptime_tests · object

Show child attributes

api_definition.uptime_tests. check_list · object[] | null

Show child attributes

api_definition.uptime_tests.check_list. body · string

api_definition.uptime_tests.check_list. commands · object[] | null

Show child attributes

api_definition.uptime_tests.check_list.commands. message · string

api_definition.uptime_tests.check_list.commands. name · string

api_definition.uptime_tests.check_list. enable_proxy_protocol · boolean

api_definition.uptime_tests.check_list. headers · object

Show child attributes

api_definition.uptime_tests.check_list.headers. {key} · string

api_definition.uptime_tests.check_list. method · string

api_definition.uptime_tests.check_list. protocol · string

api_definition.uptime_tests.check_list. timeout · string<duration>

Example:

"30s"

api_definition.uptime_tests.check_list. url · string

api_definition.uptime_tests. config · object

Show child attributes

api_definition.uptime_tests.config. expire_utime_after · integer<int64>

api_definition.uptime_tests.config. recheck_wait · integer

api_definition.uptime_tests.config. service_discovery · object

Show child attributes

api_definition.uptime_tests.config.service_discovery. cache_disabled · boolean

api_definition.uptime_tests.config.service_discovery. cache_timeout · integer<int64>

api_definition.uptime_tests.config.service_discovery. data_path · string

api_definition.uptime_tests.config.service_discovery. endpoint_returns_list · boolean

api_definition.uptime_tests.config.service_discovery. parent_data_path · string

api_definition.uptime_tests.config.service_discovery. port_data_path · string

api_definition.uptime_tests.config.service_discovery. query_endpoint · string

api_definition.uptime_tests.config.service_discovery. target_path · string

api_definition.uptime_tests.config.service_discovery. use_discovery_service · boolean

api_definition.uptime_tests.config.service_discovery. use_nested_query · boolean

api_definition.uptime_tests.config.service_discovery. use_target_list · boolean

api_definition. use_basic_auth · boolean

api_definition. use_go_plugin_auth · boolean

api_definition. use_keyless · boolean

api_definition. use_mutual_tls_auth · boolean

api_definition. use_oauth2 · boolean

api_definition. use_openid · boolean

api_definition. use_standard_auth · boolean

api_definition. version_data · object

Show child attributes

api_definition.version_data. default_version · string

api_definition.version_data. not_versioned · boolean

api_definition.version_data. versions · object

Show child attributes

api_definition.version_data.versions. {key} · object

Show child attributes

api_definition.version_data.versions.{key}. expires · string

api_definition.version_data.versions.{key}. extended_paths · object

Show child attributes

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

Show child attributes

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

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

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

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

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

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

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

Show child attributes

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

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

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

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

Show child attributes

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

Show child attributes

api_definition.version_data.versions.{key}.extended_paths.black_list.method_actions.{key}. action · string

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

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

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

Show child attributes

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

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

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

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

Show child attributes

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

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

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

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

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

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

api_definition.version_data.versions.{key}.extended_paths.circuit_breakers. threshold_percent · number<double>

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

Show child attributes

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

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

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

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

Show child attributes

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

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

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

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

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

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

Show child attributes

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

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

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

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

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

Show child attributes

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

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

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

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

Show child attributes

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

Show child attributes

api_definition.version_data.versions.{key}.extended_paths.ignored.method_actions.{key}. action · string

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

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

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

Show child attributes

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

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

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

Show child attributes

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

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

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

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

Show child attributes

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

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

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

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

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

Show child attributes

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

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

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

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

Show child attributes

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

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

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

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

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

Show child attributes

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

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

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

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

Show child attributes

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

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

Show child attributes

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

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

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

api_definition.version_data.versions.{key}.extended_paths.rate_limit. per · number<double>

api_definition.version_data.versions.{key}.extended_paths.rate_limit. rate · number<double>

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

Show child attributes

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

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

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

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

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

Show child attributes

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

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

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

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

Show child attributes

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

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

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

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

Show child attributes

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

api_definition.version_data.versions.{key}.extended_paths.transform.template_data. input_type · string

api_definition.version_data.versions.{key}.extended_paths.transform.template_data. template_mode · string

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

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

Show child attributes

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

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

Show child attributes

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

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

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

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

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

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

Show child attributes

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

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

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

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

Show child attributes

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

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

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

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

Show child attributes

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

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

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

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

Show child attributes

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

api_definition.version_data.versions.{key}.extended_paths.transform_response.template_data. input_type · string

api_definition.version_data.versions.{key}.extended_paths.transform_response.template_data. template_mode · string

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

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

Show child attributes

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

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

Show child attributes

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

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

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

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

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

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

Show child attributes

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

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

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

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

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

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

Show child attributes

api_definition.version_data.versions.{key}.extended_paths.url_rewrites.triggers. on · string

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

Show child attributes

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

Show child attributes

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

Show child attributes

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

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

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

Show child attributes

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

Show child attributes

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

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

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

Show child attributes

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

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

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

Show child attributes

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

Show child attributes

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

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

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

Show child attributes

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

Show child attributes

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

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

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

Show child attributes

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

Show child attributes

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

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

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

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

Show child attributes

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

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

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

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

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

Show child attributes

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

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

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

Show child attributes

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

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

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

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

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

Show child attributes

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

api_definition.version_data.versions.{key}.extended_paths.virtual. function_source_type · string

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

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

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

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

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

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

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

Show child attributes

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

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

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

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

Show child attributes

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

Show child attributes

api_definition.version_data.versions.{key}.extended_paths.white_list.method_actions.{key}. action · string

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

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

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

Show child attributes

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

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

api_definition.version_data.versions.{key}. global_headers · object

Show child attributes

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

api_definition.version_data.versions.{key}. global_headers_disabled · boolean

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

api_definition.version_data.versions.{key}. global_response_headers · object

Show child attributes

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

api_definition.version_data.versions.{key}. global_response_headers_disabled · boolean

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

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

api_definition.version_data.versions.{key}. ignore_endpoint_case · boolean

api_definition.version_data.versions.{key}. name · string

api_definition.version_data.versions.{key}. override_target · string

api_definition.version_data.versions.{key}. paths · object

Show child attributes

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

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

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

api_definition.version_data.versions.{key}. use_extended_paths · boolean

api_model · object

categories · string[]

created_at · string<date-time> | null

hook_references · object[] | null

Show child attributes

hook_references. event_name · string

hook_references. event_timeout · integer<int64>

hook_references. hook · object

Show child attributes

hook_references.hook. method · string · required

Example:

"POST"

hook_references.hook. target_path · string · required

Example:

"https://httpbin.org/expired-keys"

hook_references.hook. api_model · object

hook_references.hook. event_timeout · integer<int64>

Example:

0

hook_references.hook. header_map · object

Show child attributes

hook_references.hook.header_map. {key} · string

Example:

{
  "secret": "superscretkey",
  "x-auth": "authvalue"
}

hook_references.hook. id · string

Example:

"664b613f5715ec4c96cbef3e"

hook_references.hook. name · string

Example:

"Expired Keys webhook"

hook_references.hook. org_id · string

Example:

"5e9d9544a1dcd60001d0ed20"

hook_references.hook. template_path · string

Example:

"templates/default_webhook.json"

hook_references.hook. webhook_id · string

Example:

"1f78e319202b430e92286cff3ca759e3"

is_site · boolean

oas · object

Show child attributes

oas. components · object

Show child attributes

oas.components. callbacks · object

Show child attributes

oas.components.callbacks. {key} · object

oas.components. examples · object

Show child attributes

oas.components.examples. {key} · object

oas.components. headers · object

Show child attributes

oas.components.headers. {key} · object

oas.components. links · object

Show child attributes

oas.components.links. {key} · object

oas.components. parameters · object

Show child attributes

oas.components.parameters. {key} · object

oas.components. requestBodies · object

Show child attributes

oas.components.requestBodies. {key} · object

oas.components. responses · object

Show child attributes

oas.components.responses. {key} · object

oas.components. schemas · object

Show child attributes

oas.components.schemas. {key} · object

oas.components. securitySchemes · object

Show child attributes

oas.components.securitySchemes. {key} · object

oas. externalDocs · object

Show child attributes

oas.externalDocs. description · string

oas.externalDocs. url · string

oas. info · object

Show child attributes

oas.info. contact · object

Show child attributes

oas.info.contact. email · string

oas.info.contact. name · string

oas.info.contact. url · string

oas.info. description · string

oas.info. license · object

Show child attributes

oas.info.license. name · string

oas.info.license. url · string

oas.info. termsOfService · string

oas.info. title · string

oas.info. version · string

oas. openapi · string

oas. paths · object

Show child attributes

oas.paths. {key} · object

Show child attributes

oas.paths.{key}. type · any

oas.paths.{key}. connect · object

Show child attributes

oas.paths.{key}.connect. callbacks · object

Show child attributes

oas.paths.{key}.connect.callbacks. {key} · object

oas.paths.{key}.connect. deprecated · boolean

oas.paths.{key}.connect. description · string

oas.paths.{key}.connect. externalDocs · object

Show child attributes

oas.paths.{key}.connect.externalDocs. description · string

oas.paths.{key}.connect.externalDocs. url · string

oas.paths.{key}.connect. operationId · string

oas.paths.{key}.connect. parameters · object[]

oas.paths.{key}.connect. requestBody · object

oas.paths.{key}.connect. responses · object

Show child attributes

oas.paths.{key}.connect.responses. {key} · object

oas.paths.{key}.connect. security · object[] | null

Show child attributes

oas.paths.{key}.connect.security. {key} · string[]

oas.paths.{key}.connect. servers · object[] | null

Show child attributes

oas.paths.{key}.connect.servers. description · string

oas.paths.{key}.connect.servers. url · string

oas.paths.{key}.connect.servers. variables · object

Show child attributes

oas.paths.{key}.connect.servers.variables. {key} · object

Show child attributes

oas.paths.{key}.connect.servers.variables.{key}. default · string

oas.paths.{key}.connect.servers.variables.{key}. description · string

oas.paths.{key}.connect.servers.variables.{key}. enum · string[]

oas.paths.{key}.connect. summary · string

oas.paths.{key}.connect. tags · string[]

oas.paths.{key}. delete · object

Show child attributes

oas.paths.{key}.delete. callbacks · object

Show child attributes

oas.paths.{key}.delete.callbacks. {key} · object

oas.paths.{key}.delete. deprecated · boolean

oas.paths.{key}.delete. description · string

oas.paths.{key}.delete. externalDocs · object

Show child attributes

oas.paths.{key}.delete.externalDocs. description · string

oas.paths.{key}.delete.externalDocs. url · string

oas.paths.{key}.delete. operationId · string

oas.paths.{key}.delete. parameters · object[]

oas.paths.{key}.delete. requestBody · object

oas.paths.{key}.delete. responses · object

Show child attributes

oas.paths.{key}.delete.responses. {key} · object

oas.paths.{key}.delete. security · object[] | null

Show child attributes

oas.paths.{key}.delete.security. {key} · string[]

oas.paths.{key}.delete. servers · object[] | null

Show child attributes

oas.paths.{key}.delete.servers. description · string

oas.paths.{key}.delete.servers. url · string

oas.paths.{key}.delete.servers. variables · object

Show child attributes

oas.paths.{key}.delete.servers.variables. {key} · object

Show child attributes

oas.paths.{key}.delete.servers.variables.{key}. default · string

oas.paths.{key}.delete.servers.variables.{key}. description · string

oas.paths.{key}.delete.servers.variables.{key}. enum · string[]

oas.paths.{key}.delete. summary · string

oas.paths.{key}.delete. tags · string[]

oas.paths.{key}. description · string

oas.paths.{key}. get · object

Show child attributes

oas.paths.{key}.get. callbacks · object

Show child attributes

oas.paths.{key}.get.callbacks. {key} · object

oas.paths.{key}.get. deprecated · boolean

oas.paths.{key}.get. description · string

oas.paths.{key}.get. externalDocs · object

Show child attributes

oas.paths.{key}.get.externalDocs. description · string

oas.paths.{key}.get.externalDocs. url · string

oas.paths.{key}.get. operationId · string

oas.paths.{key}.get. parameters · object[]

oas.paths.{key}.get. requestBody · object

oas.paths.{key}.get. responses · object

Show child attributes

oas.paths.{key}.get.responses. {key} · object

oas.paths.{key}.get. security · object[] | null

Show child attributes

oas.paths.{key}.get.security. {key} · string[]

oas.paths.{key}.get. servers · object[] | null

Show child attributes

oas.paths.{key}.get.servers. description · string

oas.paths.{key}.get.servers. url · string

oas.paths.{key}.get.servers. variables · object

Show child attributes

oas.paths.{key}.get.servers.variables. {key} · object

Show child attributes

oas.paths.{key}.get.servers.variables.{key}. default · string

oas.paths.{key}.get.servers.variables.{key}. description · string

oas.paths.{key}.get.servers.variables.{key}. enum · string[]

oas.paths.{key}.get. summary · string

oas.paths.{key}.get. tags · string[]

oas.paths.{key}. head · object

Show child attributes

oas.paths.{key}.head. callbacks · object

Show child attributes

oas.paths.{key}.head.callbacks. {key} · object

oas.paths.{key}.head. deprecated · boolean

oas.paths.{key}.head. description · string

oas.paths.{key}.head. externalDocs · object

Show child attributes

oas.paths.{key}.head.externalDocs. description · string

oas.paths.{key}.head.externalDocs. url · string

oas.paths.{key}.head. operationId · string

oas.paths.{key}.head. parameters · object[]

oas.paths.{key}.head. requestBody · object

oas.paths.{key}.head. responses · object

Show child attributes

oas.paths.{key}.head.responses. {key} · object

oas.paths.{key}.head. security · object[] | null

Show child attributes

oas.paths.{key}.head.security. {key} · string[]

oas.paths.{key}.head. servers · object[] | null

Show child attributes

oas.paths.{key}.head.servers. description · string

oas.paths.{key}.head.servers. url · string

oas.paths.{key}.head.servers. variables · object

Show child attributes

oas.paths.{key}.head.servers.variables. {key} · object

Show child attributes

oas.paths.{key}.head.servers.variables.{key}. default · string

oas.paths.{key}.head.servers.variables.{key}. description · string

oas.paths.{key}.head.servers.variables.{key}. enum · string[]

oas.paths.{key}.head. summary · string

oas.paths.{key}.head. tags · string[]

oas.paths.{key}. options · object

Show child attributes

oas.paths.{key}.options. callbacks · object

Show child attributes

oas.paths.{key}.options.callbacks. {key} · object

oas.paths.{key}.options. deprecated · boolean

oas.paths.{key}.options. description · string

oas.paths.{key}.options. externalDocs · object

Show child attributes

oas.paths.{key}.options.externalDocs. description · string

oas.paths.{key}.options.externalDocs. url · string

oas.paths.{key}.options. operationId · string

oas.paths.{key}.options. parameters · object[]

oas.paths.{key}.options. requestBody · object

oas.paths.{key}.options. responses · object

Show child attributes

oas.paths.{key}.options.responses. {key} · object

oas.paths.{key}.options. security · object[] | null

Show child attributes

oas.paths.{key}.options.security. {key} · string[]

oas.paths.{key}.options. servers · object[] | null

Show child attributes

oas.paths.{key}.options.servers. description · string

oas.paths.{key}.options.servers. url · string

oas.paths.{key}.options.servers. variables · object

Show child attributes

oas.paths.{key}.options.servers.variables. {key} · object

Show child attributes

oas.paths.{key}.options.servers.variables.{key}. default · string

oas.paths.{key}.options.servers.variables.{key}. description · string

oas.paths.{key}.options.servers.variables.{key}. enum · string[]

oas.paths.{key}.options. summary · string

oas.paths.{key}.options. tags · string[]

oas.paths.{key}. parameters · object[]

oas.paths.{key}. patch · object

Show child attributes

oas.paths.{key}.patch. callbacks · object

Show child attributes

oas.paths.{key}.patch.callbacks. {key} · object

oas.paths.{key}.patch. deprecated · boolean

oas.paths.{key}.patch. description · string

oas.paths.{key}.patch. externalDocs · object

Show child attributes

oas.paths.{key}.patch.externalDocs. description · string

oas.paths.{key}.patch.externalDocs. url · string

oas.paths.{key}.patch. operationId · string

oas.paths.{key}.patch. parameters · object[]

oas.paths.{key}.patch. requestBody · object

oas.paths.{key}.patch. responses · object

Show child attributes

oas.paths.{key}.patch.responses. {key} · object

oas.paths.{key}.patch. security · object[] | null

Show child attributes

oas.paths.{key}.patch.security. {key} · string[]

oas.paths.{key}.patch. servers · object[] | null

Show child attributes

oas.paths.{key}.patch.servers. description · string

oas.paths.{key}.patch.servers. url · string

oas.paths.{key}.patch.servers. variables · object

Show child attributes

oas.paths.{key}.patch.servers.variables. {key} · object

Show child attributes

oas.paths.{key}.patch.servers.variables.{key}. default · string

oas.paths.{key}.patch.servers.variables.{key}. description · string

oas.paths.{key}.patch.servers.variables.{key}. enum · string[]

oas.paths.{key}.patch. summary · string

oas.paths.{key}.patch. tags · string[]

oas.paths.{key}. post · object

Show child attributes

oas.paths.{key}.post. callbacks · object

Show child attributes

oas.paths.{key}.post.callbacks. {key} · object

oas.paths.{key}.post. deprecated · boolean

oas.paths.{key}.post. description · string

oas.paths.{key}.post. externalDocs · object

Show child attributes

oas.paths.{key}.post.externalDocs. description · string

oas.paths.{key}.post.externalDocs. url · string

oas.paths.{key}.post. operationId · string

oas.paths.{key}.post. parameters · object[]

oas.paths.{key}.post. requestBody · object

oas.paths.{key}.post. responses · object

Show child attributes

oas.paths.{key}.post.responses. {key} · object

oas.paths.{key}.post. security · object[] | null

Show child attributes

oas.paths.{key}.post.security. {key} · string[]

oas.paths.{key}.post. servers · object[] | null

Show child attributes

oas.paths.{key}.post.servers. description · string

oas.paths.{key}.post.servers. url · string

oas.paths.{key}.post.servers. variables · object

Show child attributes

oas.paths.{key}.post.servers.variables. {key} · object

Show child attributes

oas.paths.{key}.post.servers.variables.{key}. default · string

oas.paths.{key}.post.servers.variables.{key}. description · string

oas.paths.{key}.post.servers.variables.{key}. enum · string[]

oas.paths.{key}.post. summary · string

oas.paths.{key}.post. tags · string[]

oas.paths.{key}. put · object

Show child attributes

oas.paths.{key}.put. callbacks · object

Show child attributes

oas.paths.{key}.put.callbacks. {key} · object

oas.paths.{key}.put. deprecated · boolean

oas.paths.{key}.put. description · string

oas.paths.{key}.put. externalDocs · object

Show child attributes

oas.paths.{key}.put.externalDocs. description · string

oas.paths.{key}.put.externalDocs. url · string

oas.paths.{key}.put. operationId · string

oas.paths.{key}.put. parameters · object[]

oas.paths.{key}.put. requestBody · object

oas.paths.{key}.put. responses · object

Show child attributes

oas.paths.{key}.put.responses. {key} · object

oas.paths.{key}.put. security · object[] | null

Show child attributes

oas.paths.{key}.put.security. {key} · string[]

oas.paths.{key}.put. servers · object[] | null

Show child attributes

oas.paths.{key}.put.servers. description · string

oas.paths.{key}.put.servers. url · string

oas.paths.{key}.put.servers. variables · object

Show child attributes

oas.paths.{key}.put.servers.variables. {key} · object

Show child attributes

oas.paths.{key}.put.servers.variables.{key}. default · string

oas.paths.{key}.put.servers.variables.{key}. description · string

oas.paths.{key}.put.servers.variables.{key}. enum · string[]

oas.paths.{key}.put. summary · string

oas.paths.{key}.put. tags · string[]

oas.paths.{key}. servers · object[] | null

Show child attributes

oas.paths.{key}.servers. description · string

oas.paths.{key}.servers. url · string

oas.paths.{key}.servers. variables · object

Show child attributes

oas.paths.{key}.servers.variables. {key} · object

Show child attributes

oas.paths.{key}.servers.variables.{key}. default · string

oas.paths.{key}.servers.variables.{key}. description · string

oas.paths.{key}.servers.variables.{key}. enum · string[]

oas.paths.{key}. summary · string

oas.paths.{key}. trace · object

Show child attributes

oas.paths.{key}.trace. callbacks · object

Show child attributes

oas.paths.{key}.trace.callbacks. {key} · object

oas.paths.{key}.trace. deprecated · boolean

oas.paths.{key}.trace. description · string

oas.paths.{key}.trace. externalDocs · object

Show child attributes

oas.paths.{key}.trace.externalDocs. description · string

oas.paths.{key}.trace.externalDocs. url · string

oas.paths.{key}.trace. operationId · string

oas.paths.{key}.trace. parameters · object[]

oas.paths.{key}.trace. requestBody · object

oas.paths.{key}.trace. responses · object

Show child attributes

oas.paths.{key}.trace.responses. {key} · object

oas.paths.{key}.trace. security · object[] | null

Show child attributes

oas.paths.{key}.trace.security. {key} · string[]

oas.paths.{key}.trace. servers · object[] | null

Show child attributes

oas.paths.{key}.trace.servers. description · string

oas.paths.{key}.trace.servers. url · string

oas.paths.{key}.trace.servers. variables · object

Show child attributes

oas.paths.{key}.trace.servers.variables. {key} · object

Show child attributes

oas.paths.{key}.trace.servers.variables.{key}. default · string

oas.paths.{key}.trace.servers.variables.{key}. description · string

oas.paths.{key}.trace.servers.variables.{key}. enum · string[]

oas.paths.{key}.trace. summary · string

oas.paths.{key}.trace. tags · string[]

oas. security · object[] | null

Show child attributes

oas.security. {key} · string[]

oas. servers · object[] | null

Show child attributes

oas.servers. description · string

oas.servers. url · string

oas.servers. variables · object

Show child attributes

oas.servers.variables. {key} · object

Show child attributes

oas.servers.variables.{key}. default · string

oas.servers.variables.{key}. description · string

oas.servers.variables.{key}. enum · string[]

oas. tags · object[]

Show child attributes

oas.tags. description · string

oas.tags. externalDocs · object

Show child attributes

oas.tags.externalDocs. description · string

oas.tags.externalDocs. url · string

oas.tags. name · string

sort_by · integer

updated_at · string<date-time> | null

user_group_owners · string[] | null

user_owners · string[] | null

Response

200

application/json

API updated

ID · string

Message · string

Meta · any

Status · string