Consul Secrets Engine (API)

This is the API documentation for the Vault Consul secrets engine. For general information about the usage and operation of the Consul secrets engine, please see the Vault Consul documentation.

This documentation assumes the Consul secrets engine is enabled at the /consul path in Vault. Since it is possible to enable secrets engines at any location, please update your API calls accordingly.

Configure Access

This endpoint configures the access information for Consul. This access information is used so that Vault can communicate with Consul and generate Consul tokens.

Parameters

• address (string: <required>) – Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".

• scheme (string: "http") – Specifies the URL scheme to use.

• token (string: <required>) – Specifies the Consul ACL token to use. This must be a management type token.

• ca_cert (string: "") - CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.

• client_cert (string: "") - Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.

• client_key (string: "") - Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.

Sample Payload

{
  "address": "127.0.0.1:8500",
  "scheme": "https",
  "token": "adha..."
}

Sample Request

$ curl \
    --request POST \
    --header "X-Vault-Token: ..." \
    --data @payload.json \
    http://127.0.0.1:8200/v1/consul/config/access

Create/Update Role

This endpoint creates or updates the Consul role definition. If the role does not exist, it will be created. If the role already exists, it will receive updated attributes.

Parameters for Consul versions 1.7 and above

• consul_namespace (string: "") EnterpriseEnterprise - Specifies the Consul namespace the token will be generated within. The namespace must exist, and the policies or roles assigned to the Vault role must also exist inside the given Consul namespace. If not provided, the "default" namespace is used.

Parameters for Consul versions 1.11 and above

• partition (string: "") EnterpriseEnterprise - Specifies the Consul admin partition the token will be generated within. The partition must exist, and the policies or roles assigned to the Vault role must also exist inside the given partition. If not provided, the "default" partition is used.

To create a client token within a particular Consul namespace:

{
  "consul_namespace": "ns1"
}

To create a client token within a particular Consul admin partition:

{
  "partition": "admin1"
}

Parameters for Consul versions 1.4 and above

• name (string: <required>) – Specifies the name of an existing role against which to create this Consul credential. This is part of the request URL.

• token_type (string: "client") - Specifies the type of token to create when using this role. Valid values are "client" or "management". If a "management" token, the policy, policies, and consul_roles parameters are not required. Defaults to "client".

• policy (string: <policy>) – Specifies the base64-encoded ACL policy. This is required unless the token_type is "management". Deprecated as of Consul 1.4 and removed as of Consul 1.11.

• policies (list: <policy or policies>) – The list of policies to assign to the generated token. Either policies or consul_roles are required for Consul 1.5 and above, or just policies if using Consul 1.4.

• consul_roles (list: <role or roles>) – The list of Consul roles to assign to the generated token. Either policies or consul_roles are required for Consul 1.5 and above.

• local (bool: false) - Indicates that the token should not be replicated globally and instead be local to the current datacenter. Only available in Consul 1.4 and greater.

• ttl (duration: "") – Specifies the TTL for this role. This is provided as a string duration with a time suffix like "30s" or "1h" or as seconds. If not provided, the default Vault TTL is used.

• max_ttl (duration: "") – Specifies the max TTL for this role. This is provided as a string duration with a time suffix like "30s" or "1h" or as seconds. If not provided, the default Vault Max TTL is used.

Sample Payload

To create management tokens:

{
  "token_type": "management"
}

To create a client token with defined policies:

{
  "policies": "global-management,policy-2"
}

To create a client token with defined roles:

{
  "consul_roles": "role-a,role-b"
}

Sample Request

$ curl \
    --request POST \
    --header "X-Vault-Token: ..." \
    --data @payload.json \
    http://127.0.0.1:8200/v1/consul/roles/example-role

Parameters for Consul version below 1.4

• lease (string: "") – Specifies the lease for this role. This is provided as a string duration with a time suffix like "30s" or "1h". If not provided, the default Vault lease is used.

• policy (string: <policy>) – Specifies the base64-encoded ACL policy. The ACL format can be found in the Consul ACL documentation. This is required unless the token_type is "management".

Sample payload

To create a client token with a custom base64-encoded policy:

{
  "policy": "a2V5ICIi...=="
}

Sample request

$ curl \
    --request POST \
    --header "X-Vault-Token: ..." \
    --data @payload.json \
    http://127.0.0.1:8200/v1/consul/roles/example-role

Read Role

This endpoint queries for information about a Consul role with the given name. If no role exists with that name, a 404 is returned.

Parameters

• name (string: <required>) – Specifies the name of the role to query. This is part of the request URL.

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/consul/roles/example-role

Sample Response

{
  "data": {
    "policy": "abd2...==",
    "lease": "1h0m0s",
    "token_type": "client"
  }
}

List Roles

This endpoint lists all existing roles in the secrets engine.

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request LIST \
    http://127.0.0.1:8200/v1/consul/roles

Sample Response

{
  "data": {
    "keys": ["example-role"]
  }
}

Delete Role

This endpoint deletes a Consul role with the given name. Even if the role does not exist, this endpoint will still return a successful response.

Parameters

• name (string: <required>) – Specifies the name of the role to delete. This is part of the request URL.

Sample Request

$ curl \
    --request DELETE \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/consul/roles/example-role

Generate Credential

This endpoint generates a dynamic Consul token based on the given role definition.

Parameters

• name (string: <required>) – Specifies the name of an existing role against which to create this Consul credential. This is part of the request URL.

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/consul/creds/example-role

Sample Response

{
  "data": {
    "token": "973a31ea-1ec4-c2de-0f63-623f477c2510"
  }
}