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.

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*
    • 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_javascript - boolean required*
    • disable_idp_jwks - 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*
  • 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*
    • 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*
    • archive_prune_interval - integer required*
    • license - string required*
    • allowed_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
devmode = true
backing_store = "string"
generate_secrets = true

[db]
conn_max_lifetime_minutes = 0
hostname = "string"
max_idle_conns = 0
max_open_conns = 0
max_string_length = 0
max_blob_length = 0
max_token_tags = 1
name = "string"
password = "string"
port = 0
require_tls = true
trace_sql = true
user = "string"

[db.gc]
batch_size = 0
retention_period = 0

[db.migration]
auto_run = true
enable_clean_database_validation = true

[features]
encryption = true
mask_license = true
disable_javascript = true
disable_idp_jwks = true
anti_tampering = "off"

[kms]
seed = "string"
uri = "string"
export_seed = "string"
export_uri = "string"
allow_local = true

[log]
customer_env = "string"
customer_identifier = "string"
customer_region = "string"
datadog_enable = "string"
level = "string"
audit_enable = true

[sentry]
enable = true

[service]
admin_api_key = "string"
override_admin_api_key_on_restart = true
allow_origins = "string"
admin_may_read_data = true
pci_restrictions = true
default_page_size = 0
set_iam_on_start_only = true
update_schema_on_start = true
force_access_reason = true
listen_addr = "string"
max_page_size = 0
max_pagination_remaining_count = 0
timeout_seconds = 0
cache_refresh_interval = 0
archive_prune_interval = 0
license = "string"
allowed_http_destinations = "string"
actions_http_call_role = "string"

[tls]
cert_file = "string"
enable = true
key_file = "string"
selfsigned = true

[expiration]
associated_objects = 0
tokens = 0
unassociated_objects = 0

Try the API

Authorization

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

Code examples

Example