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

200

The request is successful.

application/toml

object required*

Additional properties: falseProperties:

• db - object required*

  Additional properties: falseProperties:

  • conn_max_lifetime_minutes - integer required*
  • gc - object required*

    Additional properties: falseProperties:

    • 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

    Greater than or equal to: 1Less than or equal to: 200
  • migration - object required*

    Additional properties: falseProperties:

    • auto_run - boolean required*
    • enable_retries - boolean required*
    • enable_clean_database_validation - boolean required*
    • initial_wait_between_retries - integer required*
    • max_retries - integer required*
    • max_wait_between_retries - integer 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*

  Additional properties: falseProperties:

  • encryption - boolean required*
  • mask_license - boolean required*
  • disable_javascript - boolean required*
  • anti_tampering - string

    Allowed values: off, log, enforce
• kms - object required*

  Additional properties: falseProperties:

  • seed - string required*
  • uri - string required*
  • export_seed - string required*
  • export_uri - string required*
  • allow_local - boolean required*
• log - object required*

  Additional properties: falseProperties:

  • customer_env - string required*
  • customer_identifier - string required*
  • datadog_enable - string required*
  • level - string required*
  • audit_enable - boolean required*
• sentry - object required*

  Additional properties: falseProperties:

  • enable - boolean required*
• service - object required*

  Additional properties: falseProperties:

  • admin_api_key - string required*
  • admin_may_read_data - boolean required*
  • 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*
• tls - object required*

  Additional properties: falseProperties:

  • cert_file - string required*
  • enable - boolean required*
  • key_file - string required*
  • selfsigned - boolean required*
• expiration - object required*

  Additional properties: falseProperties:

  • 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_retries = true
  enable_clean_database_validation = true
  initial_wait_between_retries = 0
  max_retries = 0
  max_wait_between_retries = 0

[features]
encryption = true
mask_license = true
disable_javascript = 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"
datadog_enable = "string"
level = "string"
audit_enable = true

[sentry]
enable = true

[service]
admin_api_key = "string"
admin_may_read_data = 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"

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

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

400

The request is invalid.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1001",
  "message": "The access reason is missing.",
  "context": {
    "reason": null
  }
}

401

Authentication credentials are incorrect or missing.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1005",
  "message": "The request is unauthorized.",
  "context": {}
}

403

The caller doesn't have the required access rights.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1007",
  "message": "The operation is forbidden due to missing capabilities.",
  "context": {
    "username": "WebServer"
  }
}

404

The requested resource is not found.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1004",
  "message": "The collection is not found.",
  "context": {}
}

405

The operation is not allowed.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1026",
  "message": "The operation is not allowed in in-memory mode.",
  "context": {}
}

409

A conflict occurs.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV3218",
  "message": "Concurrent conflicting updates to the same object.",
  "context": {}
}

410

Access to a resource that is no longer available occurs.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1033",
  "message": "The resource is gone.",
  "context": {}
}

500

An error occurs on the server.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1000",
  "message": "Something went wrong",
  "context": {}
}

503

The service is unavailable.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1009",
  "message": "The operation timed out on the server.",
  "context": {}
}

Try the API

Authorization

API key:

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

Code examples

Example