Tyk · Example Payload

Tyk Gateway Api Definition Example

API GatewayAPI ManagementGraphQLOpen Source

Tyk Gateway Api Definition Example is an example object payload from Tyk, with 74 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

activeallowed_ipsapi_idauth_configsbase_identity_provided_bybasic_authblacklisted_ipscertificate_pinning_disabledcertificatesclient_certificatesconfig_dataconfig_data_disabledcustom_middleware_bundlecustom_middleware_bundle_disabledcustom_plugin_auth_enableddetailed_tracingdisable_quotadisable_rate_limitdo_not_trackdomaindomain_disableddont_set_quota_on_createenable_batch_request_supportenable_context_varsenable_coprocess_authenable_detailed_recordingenable_ip_blacklistingenable_ip_whitelistingenable_jwtenable_proxy_protocolenable_signature_checkingexpirationexpire_analytics_afterhmac_allowed_algorithmshmac_allowed_clock_skewididp_client_id_mapping_disabledinternalis_oasjwt_client_base_fieldjwt_default_policiesjwt_expires_at_validation_skewjwt_identity_base_fieldjwt_issued_at_validation_skewjwt_not_before_validation_skewjwt_policy_field_namejwt_scope_claim_namejwt_scope_to_policy_mappingjwt_signing_methodjwt_skip_kid

Example Payload

Raw ↑ 
{
  "active": true,
  "allowed_ips": [],
  "api_id": "500123",
  "auth_configs": "example_value",
  "base_identity_provided_by": "example_value",
  "basic_auth": "example_value",
  "blacklisted_ips": [],
  "certificate_pinning_disabled": true,
  "certificates": [],
  "client_certificates": [],
  "config_data": "example_value",
  "config_data_disabled": true,
  "custom_middleware_bundle": "example_value",
  "custom_middleware_bundle_disabled": true,
  "custom_plugin_auth_enabled": true,
  "detailed_tracing": true,
  "disable_quota": true,
  "disable_rate_limit": true,
  "do_not_track": true,
  "domain": "example_value",
  "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,
  "expiration": "example_value",
  "expire_analytics_after": 10,
  "hmac_allowed_algorithms": [],
  "hmac_allowed_clock_skew": 42.5,
  "id": "abc123",
  "idp_client_id_mapping_disabled": true,
  "internal": true,
  "is_oas": true,
  "jwt_client_base_field": "example_value",
  "jwt_default_policies": [],
  "jwt_expires_at_validation_skew": 10,
  "jwt_identity_base_field": "example_value",
  "jwt_issued_at_validation_skew": 10,
  "jwt_not_before_validation_skew": 10,
  "jwt_policy_field_name": "example_value",
  "jwt_scope_claim_name": "example_value",
  "jwt_scope_to_policy_mapping": "example_value",
  "jwt_signing_method": "example_value",
  "jwt_skip_kid": "500123",
  "jwt_source": "example_value",
  "listen_port": 10,
  "name": "Example Title",
  "oauth_meta": "example_value",
  "org_id": "500123",
  "pinned_public_keys": "example_value",
  "protocol": "example_value",
  "response_processors": [],
  "session_lifetime": 10,
  "session_lifetime_respects_key_expiration": true,
  "slug": "example_value",
  "strip_auth_data": true,
  "tag_headers": [],
  "tags": [],
  "tags_disabled": true,
  "upstream_certificates": "example_value",
  "upstream_certificates_disabled": true,
  "use_basic_auth": true,
  "use_go_plugin_auth": true,
  "use_keyless": true,
  "use_mutual_tls_auth": true,
  "use_oauth2": true,
  "use_openid": "500123",
  "use_standard_auth": true
}