KV Management

Get the KV container-name setting

Changed on

Returns the Docker container the KV service runs in on this instance, the default an empty setting resolves to, and whether the name can still be changed (it cannot once the service exists).

get/kv/settings

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/kv/settings
  • Auth: HTTP bearer

Response

KV container-name settings

container_namestring required

Docker container the service runs in on this instance.

customboolean required

Whether an operator-chosen name is saved.

default_container_namestring required

The container an empty setting resolves to: the pre-existing fixed name when this install already enabled the service, otherwise a name derived from this instance.

in_useboolean required

Whether the service already exists. The name cannot change then: delete the service first.

required_prefixstring required

Every container name for this service must start with this.

Example response

{
  "container_name": "redis-temps-kv-3fa91c07",
  "default_container_name": "redis-temps-kv-3fa91c07",
  "required_prefix": "redis-"
}

Changes