Get system configuration
Get the current active system configuration.
The role that performs this operation must have the CapInfoReader
capability.
See Access control for more information about how
capabilities are used to control access to operations.
Request
Query parameters
custom_audit
- stringCustom audit information to be included in the audit log.
Possible responses
- 200
- 400
- 401
- 403
- 404
- 405
- 409
- 410
- 500
- 501
- 503
The request is successful.
- application/toml
db
- object required*conn_max_lifetime_minutes
- integer required*gc
- object required*batch_size
- integer required*retention_period
- integer required*
hostname
- string required*mask_config
- booleanmax_idle_conns
- integer required*max_open_conns
- integer required*max_string_length
- integermax_blob_length
- integermax_token_tags
- integermigration
- object required*auto_run
- boolean required*enable_clean_database_validation
- boolean required*
name
- string required*password
- string required*port
- integer required*require_tls
- boolean required*trace_sql
- boolean required*user
- string required*
devmode
- boolean required*backing_store
- stringgenerate_secrets
- booleanfeatures
- object required*encryption
- boolean required*mask_license
- boolean required*disable_docs
- booleandisable_javascript
- boolean required*disable_idp_jwks
- booleandisable_cc_luhn_validation
- booleananti_tampering
- string
kms
- object required*seed
- string required*uri
- string required*export_seed
- string required*export_uri
- string required*allow_local
- boolean required*
log
- object required*customer_env
- string required*customer_identifier
- string required*customer_region
- string required*datadog_enable
- string required*level
- string required*audit_enable
- boolean required*audit_remote_addr_xff
- booleanaudit_remote_addr_enable
- booleanaudit_disable_delete_tokens
- booleandestination
- string
sentry
- object required*enable
- boolean required*
service
- object required*admin_api_key
- string required*override_admin_api_key_on_restart
- booleanallow_origins
- stringadmin_may_read_data
- boolean required*components
- stringworker_priority
- numberpci_restrictions
- booleandefault_page_size
- integer required*set_iam_on_start_only
- booleanupdate_schema_on_start
- booleanforce_access_reason
- boolean required*listen_addr
- string required*max_page_size
- integer required*max_pagination_remaining_count
- integertimeout_seconds
- number required*cache_refresh_interval
- integer required*cache_refresh_timeout
- integerarchive_prune_interval
- integer required*archive_prune_timeout
- integersubstring_index_refresh_interval
- integerlicense
- string required*allowed_http_destinations
- stringallowed_pci_http_destinations
- stringactions_http_call_role
- string
tls
- object required*cert_file
- string required*enable
- boolean required*key_file
- string required*selfsigned
- boolean required*
expiration
- object required*associated_objects
- integer required*tokens
- integer required*unassociated_objects
- integer required*
db.conn_max_lifetime_minutes = 0.0
db.gc.batch_size = 0.0
db.gc.retention_period = 0.0
db.hostname = 'string'
db.mask_config = true
db.max_idle_conns = 0.0
db.max_open_conns = 0.0
db.max_string_length = 0.0
db.max_blob_length = 0.0
db.max_token_tags = 1.0
db.migration.auto_run = true
db.migration.enable_clean_database_validation = true
db.name = 'string'
db.password = 'string'
db.port = 0.0
db.require_tls = true
db.trace_sql = true
db.user = 'string'
devmode = true
backing_store = 'string'
generate_secrets = true
features.encryption = true
features.mask_license = true
features.disable_docs = true
features.disable_javascript = true
features.disable_idp_jwks = true
features.disable_cc_luhn_validation = true
features.anti_tampering = 'off'
kms.seed = 'string'
kms.uri = 'string'
kms.export_seed = 'string'
kms.export_uri = 'string'
kms.allow_local = true
log.customer_env = 'string'
log.customer_identifier = 'string'
log.customer_region = 'string'
log.datadog_enable = 'string'
log.level = 'string'
log.audit_enable = true
log.audit_remote_addr_xff = true
log.audit_remote_addr_enable = true
log.audit_disable_delete_tokens = true
log.destination = 'stdout'
sentry.enable = true
service.admin_api_key = 'string'
service.override_admin_api_key_on_restart = true
service.allow_origins = 'string'
service.admin_may_read_data = true
service.components = 'string'
service.worker_priority = 0.0
service.pci_restrictions = true
service.default_page_size = 0.0
service.set_iam_on_start_only = true
service.update_schema_on_start = true
service.force_access_reason = true
service.listen_addr = 'string'
service.max_page_size = 0.0
service.max_pagination_remaining_count = 0.0
service.timeout_seconds = 0.0
service.cache_refresh_interval = 0.0
service.cache_refresh_timeout = 0.0
service.archive_prune_interval = 0.0
service.archive_prune_timeout = 0.0
service.substring_index_refresh_interval = 0.0
service.license = 'string'
service.allowed_http_destinations = 'string'
service.allowed_pci_http_destinations = 'string'
service.actions_http_call_role = 'string'
tls.cert_file = 'string'
tls.enable = true
tls.key_file = 'string'
tls.selfsigned = true
expiration.associated_objects = 0.0
expiration.tokens = 0.0
expiration.unassociated_objects = 0.0
The request is invalid.
- application/json
context
- object required*The error context.
Values of additional properties are stringsExample{
"objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
}error_code
- string required*The error code.
message
- string required*The error message.
error_url
- stringThe URL to the error documentation.
{
"error_code": "PV1001",
"message": "The access reason is missing.",
"context": {
"reason": null
}
}
Authentication credentials are incorrect or missing.
- application/json
context
- object required*The error context.
Values of additional properties are stringsExample{
"objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
}error_code
- string required*The error code.
message
- string required*The error message.
error_url
- stringThe URL to the error documentation.
{
"error_code": "PV1005",
"message": "The request is unauthorized.",
"context": {}
}
The caller doesn't have the required access rights.
- application/json
context
- object required*The error context.
Values of additional properties are stringsExample{
"objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
}error_code
- string required*The error code.
message
- string required*The error message.
error_url
- stringThe URL to the error documentation.
{
"error_code": "PV1007",
"message": "The operation is forbidden due to missing capabilities.",
"context": {
"username": "WebServer"
}
}
The requested resource is not found.
- application/json
context
- object required*The error context.
Values of additional properties are stringsExample{
"objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
}error_code
- string required*The error code.
message
- string required*The error message.
error_url
- stringThe URL to the error documentation.
{
"error_code": "PV1004",
"message": "The collection is not found.",
"context": {}
}
The operation is not allowed.
- application/json
context
- object required*The error context.
Values of additional properties are stringsExample{
"objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
}error_code
- string required*The error code.
message
- string required*The error message.
error_url
- stringThe URL to the error documentation.
{
"error_code": "PV1026",
"message": "The operation is not allowed in in-memory mode.",
"context": {}
}
A conflict occurs.
- application/json
context
- object required*The error context.
Values of additional properties are stringsExample{
"objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
}error_code
- string required*The error code.
message
- string required*The error message.
error_url
- stringThe URL to the error documentation.
{
"error_code": "PV3218",
"message": "Concurrent conflicting updates to the same object.",
"context": {}
}
Access to a resource that is no longer available occurs.
- application/json
context
- object required*The error context.
Values of additional properties are stringsExample{
"objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
}error_code
- string required*The error code.
message
- string required*The error message.
error_url
- stringThe URL to the error documentation.
{
"error_code": "PV1033",
"message": "The resource is gone.",
"context": {}
}
An error occurs on the server.
- application/json
context
- object required*The error context.
Values of additional properties are stringsExample{
"objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
}error_code
- string required*The error code.
message
- string required*The error message.
error_url
- stringThe URL to the error documentation.
{
"error_code": "PV1000",
"message": "Something went wrong",
"context": {}
}
Not implemented.
- application/json
context
- object required*The error context.
Values of additional properties are stringsExample{
"objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
}error_code
- string required*The error code.
message
- string required*The error message.
error_url
- stringThe URL to the error documentation.
{
"error_code": "PV2001",
"message": "This operation is not implemented.",
"context": {}
}
The service is unavailable.
- application/json
context
- object required*The error context.
Values of additional properties are stringsExample{
"objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
}error_code
- string required*The error code.
message
- string required*The error message.
error_url
- stringThe URL to the error documentation.
{
"error_code": "PV1009",
"message": "The operation timed out on the server.",
"context": {}
}
Query parameters
Code examples