Skip to main content

Get system configuration

get
/api/pvlt/1.0/system/info/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 - string

    Custom audit information to be included in the audit log.

Possible responses​

The request is successful.

object required*
  • 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 - boolean
    • max_idle_conns - integer required*
    • max_open_conns - integer required*
    • max_string_length - integer
    • max_blob_length - integer
    • max_token_tags - integer
    • migration - 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 - string
  • generate_secrets - boolean
  • features - object required*
    • encryption - boolean required*
    • mask_license - boolean required*
    • disable_docs - boolean
    • disable_javascript - boolean required*
    • disable_idp_jwks - boolean
    • disable_cc_luhn_validation - boolean
    • anti_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 - boolean
    • audit_remote_addr_enable - boolean
    • audit_disable_delete_tokens - boolean
    • destination - string
  • sentry - object required*
    • enable - boolean required*
  • service - object required*
    • admin_api_key - string required*
    • override_admin_api_key_on_restart - boolean
    • allow_origins - string
    • admin_may_read_data - boolean required*
    • components - string
    • worker_priority - number
    • pci_restrictions - boolean
    • default_page_size - integer required*
    • set_iam_on_start_only - boolean
    • update_schema_on_start - boolean
    • force_access_reason - boolean required*
    • listen_addr - string required*
    • max_page_size - integer required*
    • max_pagination_remaining_count - integer
    • timeout_seconds - number required*
    • cache_refresh_interval - integer required*
    • cache_refresh_timeout - integer
    • archive_prune_interval - integer required*
    • archive_prune_timeout - integer
    • substring_index_refresh_interval - integer
    • license - string required*
    • allowed_http_destinations - string
    • allowed_pci_http_destinations - string
    • actions_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*
Example

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

Try the API

Authorization

Query parameters

Navigate to the docs of your local Vault installation to try the API directly from there.

Code examples

Example