Tyk · Schema

APIDefinition

API GatewayAPI ManagementGraphQLOpen Source

Properties

Name Type Description
active boolean
allowed_ips array
api_id string
auth_configs object
base_identity_provided_by string
basic_auth object
blacklisted_ips array
certificate_pinning_disabled boolean
certificates array
client_certificates array
config_data object
config_data_disabled boolean
custom_middleware_bundle string
custom_middleware_bundle_disabled boolean
custom_plugin_auth_enabled boolean
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
expiration string
expire_analytics_after integer
hmac_allowed_algorithms array
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 array
jwt_expires_at_validation_skew integer
jwt_identity_base_field string
jwt_issued_at_validation_skew integer
jwt_not_before_validation_skew integer
jwt_policy_field_name string
jwt_scope_claim_name string
jwt_scope_to_policy_mapping object
jwt_signing_method string
jwt_skip_kid boolean
jwt_source string
listen_port integer
name string
oauth_meta object
org_id string
pinned_public_keys object
protocol string
response_processors array
session_lifetime integer
session_lifetime_respects_key_expiration boolean
slug string
strip_auth_data boolean
tag_headers array
tags array
tags_disabled boolean
upstream_certificates object
upstream_certificates_disabled 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
View JSON Schema on GitHub

JSON Schema

tyk-gateway-api-definition-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "APIDefinition",
  "type": "object",
  "properties": {
    "active": {
      "type": "boolean"
    },
    "allowed_ips": {
      "type": "array"
    },
    "api_id": {
      "type": "string"
    },
    "auth_configs": {
      "type": "object"
    },
    "base_identity_provided_by": {
      "type": "string"
    },
    "basic_auth": {
      "type": "object"
    },
    "blacklisted_ips": {
      "type": "array"
    },
    "certificate_pinning_disabled": {
      "type": "boolean"
    },
    "certificates": {
      "type": "array"
    },
    "client_certificates": {
      "type": "array"
    },
    "config_data": {
      "type": "object"
    },
    "config_data_disabled": {
      "type": "boolean"
    },
    "custom_middleware_bundle": {
      "type": "string"
    },
    "custom_middleware_bundle_disabled": {
      "type": "boolean"
    },
    "custom_plugin_auth_enabled": {
      "type": "boolean"
    },
    "detailed_tracing": {
      "type": "boolean"
    },
    "disable_quota": {
      "type": "boolean"
    },
    "disable_rate_limit": {
      "type": "boolean"
    },
    "do_not_track": {
      "type": "boolean"
    },
    "domain": {
      "type": "string"
    },
    "domain_disabled": {
      "type": "boolean"
    },
    "dont_set_quota_on_create": {
      "type": "boolean"
    },
    "enable_batch_request_support": {
      "type": "boolean"
    },
    "enable_context_vars": {
      "type": "boolean"
    },
    "enable_coprocess_auth": {
      "type": "boolean"
    },
    "enable_detailed_recording": {
      "type": "boolean"
    },
    "enable_ip_blacklisting": {
      "type": "boolean"
    },
    "enable_ip_whitelisting": {
      "type": "boolean"
    },
    "enable_jwt": {
      "type": "boolean"
    },
    "enable_proxy_protocol": {
      "type": "boolean"
    },
    "enable_signature_checking": {
      "type": "boolean"
    },
    "expiration": {
      "type": "string"
    },
    "expire_analytics_after": {
      "type": "integer"
    },
    "hmac_allowed_algorithms": {
      "type": "array"
    },
    "hmac_allowed_clock_skew": {
      "type": "number"
    },
    "id": {
      "type": "string"
    },
    "idp_client_id_mapping_disabled": {
      "type": "boolean"
    },
    "internal": {
      "type": "boolean"
    },
    "is_oas": {
      "type": "boolean"
    },
    "jwt_client_base_field": {
      "type": "string"
    },
    "jwt_default_policies": {
      "type": "array"
    },
    "jwt_expires_at_validation_skew": {
      "type": "integer"
    },
    "jwt_identity_base_field": {
      "type": "string"
    },
    "jwt_issued_at_validation_skew": {
      "type": "integer"
    },
    "jwt_not_before_validation_skew": {
      "type": "integer"
    },
    "jwt_policy_field_name": {
      "type": "string"
    },
    "jwt_scope_claim_name": {
      "type": "string"
    },
    "jwt_scope_to_policy_mapping": {
      "type": "object"
    },
    "jwt_signing_method": {
      "type": "string"
    },
    "jwt_skip_kid": {
      "type": "boolean"
    },
    "jwt_source": {
      "type": "string"
    },
    "listen_port": {
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "oauth_meta": {
      "type": "object"
    },
    "org_id": {
      "type": "string"
    },
    "pinned_public_keys": {
      "type": "object"
    },
    "protocol": {
      "type": "string"
    },
    "response_processors": {
      "type": "array"
    },
    "session_lifetime": {
      "type": "integer"
    },
    "session_lifetime_respects_key_expiration": {
      "type": "boolean"
    },
    "slug": {
      "type": "string"
    },
    "strip_auth_data": {
      "type": "boolean"
    },
    "tag_headers": {
      "type": "array"
    },
    "tags": {
      "type": "array"
    },
    "tags_disabled": {
      "type": "boolean"
    },
    "upstream_certificates": {
      "type": "object"
    },
    "upstream_certificates_disabled": {
      "type": "boolean"
    },
    "use_basic_auth": {
      "type": "boolean"
    },
    "use_go_plugin_auth": {
      "type": "boolean"
    },
    "use_keyless": {
      "type": "boolean"
    },
    "use_mutual_tls_auth": {
      "type": "boolean"
    },
    "use_oauth2": {
      "type": "boolean"
    },
    "use_openid": {
      "type": "boolean"
    },
    "use_standard_auth": {
      "type": "boolean"
    }
  }
}