APIs

Updating an API definition uses the same signature an 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}

Request body

tagsstring[]
activeboolean
allowed_ipsstring[]
api_idstring
base_identity_provided_bystring
blacklisted_ipsstring[]
certificatesstring[]
client_certificatesstring[]
config_dataobject
custom_middleware_bundlestring
disable_quotaboolean
disable_rate_limitboolean
do_not_trackboolean
domainstring
dont_set_quota_on_createboolean
enable_batch_request_supportboolean
enable_context_varsboolean
enable_coprocess_authboolean
enable_ip_blacklistingboolean
enable_ip_whitelistingboolean
enable_jwtboolean
enable_signature_checkingboolean
expire_analytics_afterinteger
hmac_allowed_algorithmsstring[]
hmac_allowed_clock_skewnumber double
internalboolean
jwt_client_base_fieldstring
jwt_expires_at_validation_skewinteger
jwt_identity_base_fieldstring
jwt_issued_at_validation_skewinteger
jwt_not_before_validation_skewinteger
jwt_policy_field_namestring
jwt_scope_claim_namestring
jwt_scope_to_policy_mappingobject
jwt_signing_methodstring
jwt_skip_kidboolean
jwt_sourcestring
namestring
org_idstring
pinned_public_keysobject
session_lifetimeinteger
slugstring
strip_auth_databoolean
tag_headersstring[]
upstream_certificatesobject
use_basic_authboolean
use_keylessboolean
use_mutual_tls_authboolean
use_oauth2boolean
use_openidboolean
use_standard_authboolean

Response

API updated

actionstring
keystring

in:body

key_hashstring
statusstring

Changes