Retrieve current configuration status

curl --request GET \
  --url https://{tenant}/config \
  --header 'X-Tyk-Authorization: <api-key>'

{
  "type": "full",
  "listen_port": 9090,
  "healthcheck_port": 8180,
  "http_port": 8180,
  "enable_http_profiler": false,
  "server_options": {
    "use_ssl": false,
    "certificate": {
      "cert_file": "./server.crt",
      "key_file": "./server.key"
    },
    "min_version": 0,
    "ssl_ciphers": null,
    "ssl_certificates": null
  },
  "http_server_options": {
    "use_ssl": false,
    "certificate": {
      "cert_file": "",
      "key_file": ""
    },
    "min_version": 0,
    "ssl_ciphers": null,
    "ssl_certificates": null
  },
  "security": {
    "private_certificate_encoding_secret": "",
    "enable_http_secure_endpoints": true,
    "secret": ""
  },
  "storage": {
    "type": "redis",
    "host": "localhost",
    "port": 6379,
    "master_name": "",
    "sentinel_password": "",
    "username": "",
    "password": "",
    "database": 0,
    "optimisation_max_idle": 0,
    "optimisation_max_active": 0,
    "enable_cluster": false,
    "hosts": null,
    "addrs": null,
    "redis_use_ssl": false,
    "redis_ssl_insecure_skip_verify": false,
    "debug": false,
    "timeout": 0,
    "use_ssl": false,
    "ssl_insecure_skip_verify": false,
    "ca_file": "",
    "cert_file": "",
    "key_file": "",
    "max_version": "",
    "min_version": ""
  },
  "analytics": {
    "type": "mongo",
    "connection_string": "",
    "table_sharding": false,
    "batch_size": 0,
    "postgres": {
      "prefer_simple_protocol": false
    },
    "mysql": {
      "default_string_size": 0,
      "disable_datetime_precision": false,
      "dont_support_rename_index": false,
      "dont_support_rename_column": false,
      "skip_initialize_with_version": false
    },
    "mongo_url": "",
    "mongo_use_ssl": false,
    "mongo_ssl_insecure_skip_verify": false,
    "mongo_ssl_allow_invalid_hostnames": false,
    "mongo_ssl_ca_file": "",
    "mongo_ssl_pem_keyfile": "",
    "mongo_session_consistency": "",
    "mongo_batch_size": 0,
    "driver": "mongo-go",
    "mongo_direct_connection": false
  },
  "hash_keys": true,
  "session_timeout": 0,
  "forward_analytics_to_pump": false,
  "enable_multiple_analytics_keys": false,
  "dont_store_selective": false,
  "dont_store_aggregate": false,
  "org_session_expiration": 60,
  "org_session_cleanup": 60,
  "license": "",
  "aggregates_ignore_tags": null,
  "track_all_paths": false,
  "store_analytics_per_minute": false,
  "ignore_tag_prefix_list": null,
  "threshold_len_tag_list": 1000,
  "omit_analytics_index_creation": false,
  "enable_separate_analytics_store": false,
  "analytics_storage": {
    "type": "",
    "host": "",
    "port": 0,
    "master_name": "",
    "sentinel_password": "",
    "username": "",
    "password": "",
    "database": 0,
    "optimisation_max_idle": 0,
    "optimisation_max_active": 0,
    "enable_cluster": false,
    "hosts": null,
    "addrs": null,
    "redis_use_ssl": false,
    "redis_ssl_insecure_skip_verify": false,
    "debug": false,
    "timeout": 0,
    "use_ssl": false,
    "ssl_insecure_skip_verify": false,
    "ca_file": "",
    "cert_file": "",
    "key_file": "",
    "max_version": "",
    "min_version": ""
  },
  "log_level": "info",
  "enable_key_logging": false,
  "sync_worker_config": {
    "enabled": true,
    "hash_keys": true,
    "max_batch_size": 1000,
    "time_between_batches": 3,
    "max_workers": 1000,
    "warmup_time": 0,
    "group_key_ttl": 30
  },
  "enable_ownership": false
}

Configuration

Retrieve current configuration status

Returns the current configuration status of the system. You can optionally filter for a specific configuration field.

Example curl commands:

Get full configuration:

curl -X GET \
http://localhost:8181/config \
-H 'X-Tyk-Authorization: your-secret-key'

Get specific configuration field:

curl -X GET \
'http://localhost:8181/config?field=storage.host' \
-H 'X-Tyk-Authorization: your-secret-key'

GET

config

Retrieve current configuration status

curl --request GET \
  --url https://{tenant}/config \
  --header 'X-Tyk-Authorization: <api-key>'

{
  "type": "full",
  "listen_port": 9090,
  "healthcheck_port": 8180,
  "http_port": 8180,
  "enable_http_profiler": false,
  "server_options": {
    "use_ssl": false,
    "certificate": {
      "cert_file": "./server.crt",
      "key_file": "./server.key"
    },
    "min_version": 0,
    "ssl_ciphers": null,
    "ssl_certificates": null
  },
  "http_server_options": {
    "use_ssl": false,
    "certificate": {
      "cert_file": "",
      "key_file": ""
    },
    "min_version": 0,
    "ssl_ciphers": null,
    "ssl_certificates": null
  },
  "security": {
    "private_certificate_encoding_secret": "",
    "enable_http_secure_endpoints": true,
    "secret": ""
  },
  "storage": {
    "type": "redis",
    "host": "localhost",
    "port": 6379,
    "master_name": "",
    "sentinel_password": "",
    "username": "",
    "password": "",
    "database": 0,
    "optimisation_max_idle": 0,
    "optimisation_max_active": 0,
    "enable_cluster": false,
    "hosts": null,
    "addrs": null,
    "redis_use_ssl": false,
    "redis_ssl_insecure_skip_verify": false,
    "debug": false,
    "timeout": 0,
    "use_ssl": false,
    "ssl_insecure_skip_verify": false,
    "ca_file": "",
    "cert_file": "",
    "key_file": "",
    "max_version": "",
    "min_version": ""
  },
  "analytics": {
    "type": "mongo",
    "connection_string": "",
    "table_sharding": false,
    "batch_size": 0,
    "postgres": {
      "prefer_simple_protocol": false
    },
    "mysql": {
      "default_string_size": 0,
      "disable_datetime_precision": false,
      "dont_support_rename_index": false,
      "dont_support_rename_column": false,
      "skip_initialize_with_version": false
    },
    "mongo_url": "",
    "mongo_use_ssl": false,
    "mongo_ssl_insecure_skip_verify": false,
    "mongo_ssl_allow_invalid_hostnames": false,
    "mongo_ssl_ca_file": "",
    "mongo_ssl_pem_keyfile": "",
    "mongo_session_consistency": "",
    "mongo_batch_size": 0,
    "driver": "mongo-go",
    "mongo_direct_connection": false
  },
  "hash_keys": true,
  "session_timeout": 0,
  "forward_analytics_to_pump": false,
  "enable_multiple_analytics_keys": false,
  "dont_store_selective": false,
  "dont_store_aggregate": false,
  "org_session_expiration": 60,
  "org_session_cleanup": 60,
  "license": "",
  "aggregates_ignore_tags": null,
  "track_all_paths": false,
  "store_analytics_per_minute": false,
  "ignore_tag_prefix_list": null,
  "threshold_len_tag_list": 1000,
  "omit_analytics_index_creation": false,
  "enable_separate_analytics_store": false,
  "analytics_storage": {
    "type": "",
    "host": "",
    "port": 0,
    "master_name": "",
    "sentinel_password": "",
    "username": "",
    "password": "",
    "database": 0,
    "optimisation_max_idle": 0,
    "optimisation_max_active": 0,
    "enable_cluster": false,
    "hosts": null,
    "addrs": null,
    "redis_use_ssl": false,
    "redis_ssl_insecure_skip_verify": false,
    "debug": false,
    "timeout": 0,
    "use_ssl": false,
    "ssl_insecure_skip_verify": false,
    "ca_file": "",
    "cert_file": "",
    "key_file": "",
    "max_version": "",
    "min_version": ""
  },
  "log_level": "info",
  "enable_key_logging": false,
  "sync_worker_config": {
    "enabled": true,
    "hash_keys": true,
    "max_batch_size": 1000,
    "time_between_batches": 3,
    "max_workers": 1000,
    "warmup_time": 0,
    "group_key_ttl": 30
  },
  "enable_ownership": false
}

Authorizations

X-Tyk-Authorization

string

header

required

Headers

X-Tyk-Authorization

string

required

Secret value set in sink.conf

Query Parameters

field

string

Optional configuration field name to filter by

Response

Successful retrieval of the current configuration.

listen_port

integer

Example:

9090

healthcheck_port

integer

Example:

8180

http_port

integer

Example:

8180

enable_http_profiler

boolean

Example:

false

server_options

object

Show child attributes

server_options.use_ssl

boolean

Example:

false

server_options.certificate

object

Show child attributes

server_options.certificate.cert_file

string

Example:

"./server.crt"

server_options.certificate.key_file

string

Example:

"./server.key"

server_options.min_version

integer

Example:

0

server_options.ssl_ciphers

string | null

server_options.ssl_certificates

string | null

http_server_options

object

Show child attributes

http_server_options.use_ssl

boolean

Example:

false

http_server_options.certificate

object

Show child attributes

http_server_options.certificate.cert_file

string

Example:

""

http_server_options.certificate.key_file

string

Example:

""

http_server_options.min_version

integer

Example:

0

http_server_options.ssl_ciphers

string | null

http_server_options.ssl_certificates

string | null

security

object

Show child attributes

security.private_certificate_encoding_secret

string

Example:

""

security.enable_http_secure_endpoints

boolean

Example:

true

security.secret

string

Example:

""

storage

object

Show child attributes

storage.type

string

Example:

"redis"

storage.host

string

Example:

"localhost"

storage.port

integer

Example:

6379

storage.master_name

string

Example:

""

storage.sentinel_password

string

Example:

""

storage.username

string

Example:

""

storage.password

string

Example:

""

storage.database

integer

Example:

0

storage.optimisation_max_idle

integer

Example:

0

storage.optimisation_max_active

integer

Example:

0

storage.enable_cluster

boolean

Example:

false

storage.hosts

string | null

storage.addrs

string | null

storage.redis_use_ssl

boolean

Example:

false

storage.redis_ssl_insecure_skip_verify

boolean

Example:

false

storage.debug

boolean

Example:

false

storage.timeout

integer

Example:

0

storage.use_ssl

boolean

Example:

false

storage.ssl_insecure_skip_verify

boolean

Example:

false

storage.ca_file

string

Example:

""

storage.cert_file

string

Example:

""

storage.key_file

string

Example:

""

storage.max_version

string

Example:

""

storage.min_version

string

Example:

""

analytics

object

Show child attributes

analytics.type

string

Example:

"mongo"

analytics.connection_string

string

Example:

""

analytics.table_sharding

boolean

Example:

false

analytics.batch_size

integer

Example:

0

analytics.postgres

object

Show child attributes

analytics.postgres.prefer_simple_protocol

boolean

Example:

false

analytics.mysql

object

Show child attributes

analytics.mysql.default_string_size

integer

Example:

0

analytics.mysql.disable_datetime_precision

boolean

Example:

false

analytics.mysql.dont_support_rename_index

boolean

Example:

false

analytics.mysql.dont_support_rename_column

boolean

Example:

false

analytics.mysql.skip_initialize_with_version

boolean

Example:

false

analytics.mongo_url

string

Example:

""

analytics.mongo_use_ssl

boolean

Example:

false

analytics.mongo_ssl_insecure_skip_verify

boolean

Example:

false

analytics.mongo_ssl_allow_invalid_hostnames

boolean

Example:

false

analytics.mongo_ssl_ca_file

string

Example:

""

analytics.mongo_ssl_pem_keyfile

string

Example:

""

analytics.mongo_session_consistency

string

Example:

""

analytics.mongo_batch_size

integer

Example:

0

analytics.driver

string

Example:

"mongo-go"

analytics.mongo_direct_connection

boolean

Example:

false

hash_keys

boolean

Example:

true

session_timeout

integer

Example:

0

forward_analytics_to_pump

boolean

Example:

false

enable_multiple_analytics_keys

boolean

Example:

false

dont_store_selective

boolean

Example:

false

dont_store_aggregate

boolean

Example:

false

org_session_expiration

integer

Example:

60

org_session_cleanup

integer

Example:

60

license

string

Example:

""

aggregates_ignore_tags

string | null

track_all_paths

boolean

Example:

false

store_analytics_per_minute

boolean

Example:

false

ignore_tag_prefix_list

string | null

Example:

1000

omit_analytics_index_creation

boolean

Example:

false

enable_separate_analytics_store

boolean

Example:

false

analytics_storage

object

Show child attributes

analytics_storage.type

string

Example:

""

analytics_storage.host

string

Example:

""

analytics_storage.port

integer

Example:

0

analytics_storage.master_name

string

Example:

""

analytics_storage.sentinel_password

string

Example:

""

analytics_storage.username

string

Example:

""

analytics_storage.password

string

Example:

""

analytics_storage.database

integer

Example:

0

analytics_storage.optimisation_max_idle

integer

Example:

0

analytics_storage.optimisation_max_active

integer

Example:

0

analytics_storage.enable_cluster

boolean

Example:

false

analytics_storage.hosts

string | null

analytics_storage.addrs

string | null

analytics_storage.redis_use_ssl

boolean

Example:

false

analytics_storage.redis_ssl_insecure_skip_verify

boolean

Example:

false

analytics_storage.debug

boolean

Example:

false

analytics_storage.timeout

integer

Example:

0

analytics_storage.use_ssl

boolean

Example:

false

analytics_storage.ssl_insecure_skip_verify

boolean

Example:

false

analytics_storage.ca_file

string

Example:

""

analytics_storage.cert_file

string

Example:

""

analytics_storage.key_file

string

Example:

""

analytics_storage.max_version

string

Example:

""

analytics_storage.min_version

string

Example:

""

log_level

string

Example:

"info"

enable_key_logging

boolean

Example:

false

sync_worker_config

object

Show child attributes

sync_worker_config.enabled

boolean

Example:

true

sync_worker_config.hash_keys

boolean

Example:

true

sync_worker_config.max_batch_size

integer

Example:

1000

sync_worker_config.time_between_batches

integer

Example:

3

sync_worker_config.max_workers

integer

Example:

1000

sync_worker_config.warmup_time

integer

Example:

0

sync_worker_config.group_key_ttl

integer

Example:

30

enable_ownership

boolean

Example:

false

config_field

string

Example:

"sync_worker_config.warmup_time"

env

string

Example:

"TYK_MDCB_SYNCWORKERCONFIG_WARMUPTIME"

value

string

Example:

"0"

obfuscated

boolean

Example:

false

type

enum<string>

Available options:

full,

single

pprof data Retrieve environment variables

⌘I

Overview

Getting Started

Deploy Tyk

Managing APIs

Security in Tyk

Reference

Developer Support

Retrieve current configuration status

Authorizations

Headers

Query Parameters

Response