Config HTTP Endpoint

The /config endpoints create, update, delete and query central configuration entries registered with Consul. See the agent configuration for more information on how to enable this functionality for centrally configuring services and configuration entries docs for a description of the configuration entries content.

Apply Configuration

This endpoint creates or updates the given config entry.

The table below shows this endpoint's support for blocking queries, consistency modes, agent caching, and required ACLs.

The corresponding CLI command is consul config write.

Permissions

The ACL required depends on the config entry being written:

Query Parameters

• dc (string: "") - Specifies the datacenter to query. This parameter defaults to the datacenter of the agent being queried.

• cas (int: 0) - Specifies to use a Check-And-Set operation. If the index is 0, Consul will only store the entry if it does not already exist. If the index is non-zero, the entry is only set if the current index matches the ModifyIndex of that entry.

• ns (string: "") EnterpriseEnterprise - Specifies the namespace of the config entry you apply. You can also specify the namespace through other methods.

• partition (string: "") EnterpriseEnterprise - The partition to use. If not provided, the partition is inferred from the request's ACL token, or defaults to the default partition.

Sample Payload

{
    "Kind": "service-defaults",
    "Name": "web",
    "Protocol": "http"
}

Sample Request

$ curl \
    --request PUT \
    --data @payload \
    http://127.0.0.1:8500/v1/config

Get Configuration

This endpoint returns a specific config entry.

The table below shows this endpoint's support for blocking queries, consistency modes, agent caching, and required ACLs.

The corresponding CLI command is consul config read.

Permissions

The ACL required depends on the config entry kind being read:

Path Parameters

• kind (string: <required>) - Specifies the kind of the entry to read.

• name (string: <required>) - Specifies the name of the entry to read. The name of the proxy-defaults config entry must be global, and the name of the mesh config entry must be mesh.

Query Parameters

• dc (string: "") - Specifies the datacenter to query. This parameter defaults to the datacenter of the agent being queried.

• ns (string: "") EnterpriseEnterprise - Specifies the namespace of the config entry you lookup You can also specify the namespace through other methods.

• partition (string: "") EnterpriseEnterprise - The partition to use. If not provided, the partition is inferred from the request's ACL token, or defaults to the default partition.

Sample Request

$ curl \
    --request GET \
    http://127.0.0.1:8500/v1/config/service-defaults/web

Sample Response

{
  "Kind": "service-defaults",
  "Name": "web",
  "Protocol": "http",
  "CreateIndex": 15,
  "ModifyIndex": 35
}

List Configurations

This endpoint returns all config entries of the given kind.

The HTTP response includes the X-Consul-Results-Filtered-By-ACLs: true header if the response array excludes results due to ACL policy configuration. Refer to the HTTP API documentation for more information.

The table below shows this endpoint's support for blocking queries, consistency modes, agent caching, and required ACLs.

Permissions

The ACL required depends on the config entry kind being read:

The corresponding CLI command is consul config list.

Path Parameters

• kind (string: <required>) - Specifies the kind of the entry to list.
• filter (string: "") - Specifies an expression to use for filtering the results.

Query Parameters

• dc (string: "") - Specifies the datacenter to query. This parameter defaults to the datacenter of the agent being queried.

• ns (string: "") EnterpriseEnterprise - Specifies the namespace of the config entries you lookup. You can also specify the namespace through other methods.

• partition (string: "") EnterpriseEnterprise - The partition to use. If not provided, the partition is inferred from the request's ACL token, or defaults to the default partition.

Sample Request

$ curl \
    --request GET \
    http://127.0.0.1:8500/v1/config/service-defaults

Sample Response

[
  {
    "Kind": "service-defaults",
    "Name": "db",
    "Protocol": "tcp",
    "CreateIndex": 16,
    "ModifyIndex": 16
  },
  {
    "Kind": "service-defaults",
    "Name": "web",
    "Protocol": "http",
    "CreateIndex": 13,
    "ModifyIndex": 13
  }
]

Delete Configuration

This endpoint deletes the given config entry.

The table below shows this endpoint's support for blocking queries, consistency modes, agent caching, and required ACLs.

Permissions

The ACL required depends on the config entry kind being deleted:

The corresponding CLI command is consul config delete.

Path Parameters

• kind (string: <required>) - Specifies the kind of the entry to delete.

• name (string: <required>) - Specifies the name of the entry to delete. The name of the proxy-defaults config entry must be global, and the name of the mesh config entry must be mesh.

Query Parameters

• dc (string: "") - Specifies the datacenter to query. This parameter defaults to the datacenter of the agent being queried.

• cas (int: 0) - Specifies to use a Check-And-Set operation. Unlike PUT, the index must be greater than 0 for Consul to take any action: a 0 index will not delete the config entry. If the index is non-zero, the config entry is only deleted if the index matches the ModifyIndex of that config entry.

• ns (string: "") EnterpriseEnterprise - Specifies the namespace of the config entry you delete. You can also specify the namespace through other methods.

• partition (string: "") EnterpriseEnterprise - The partition to use. If not provided, the partition is inferred from the request's ACL token, or defaults to the default partition.

Sample Request

$ curl \
    --request DELETE \
    http://127.0.0.1:8500/v1/config/service-defaults/web

Methods to specify namespace EnterpriseEnterprise

Config endpoints support several methods for specifying the namespace of configuration entry resources with the following order of precedence:

1. ns query parameter
2. X-Consul-Namespace request header
3. Namespace is inherited from the namespace of the request's ACL token (if any)
4. The default namespace