HashiDays One conference. Three cities. Find a city near you
Consul
Consul Home

Consul Agent Service Deregistration

Command: consul services deregister

Corresponding HTTP API Endpoint: [PUT] /v1/agent/service/deregister/:service_id

The services deregister command deregisters a service with the local agent. Note that this command can only deregister services that were registered with the agent specified and is intended to be paired with services register. By default, the command deregisters services on the local agent.

We recommend deregistering services registered with a configuration file by deleting the file and reloading Consul. Refer to Services Overview for additional information about services.

The following table shows the ACLs required to run the consul services deregister command:

ACL Required
service:write

You cannot use the Consul command line to configure blocking queries and agent caching, you can configure them from the corresponding HTTP endpoint.

Usage

Usage: consul services deregister [options] [FILE...]

This command can deregister either a single service using the -id flag documented below, or one or more services using service definition files in HCL or JSON format. This flexibility makes it easy to pair the command with the services register command since the argument syntax is the same.

Command Options

  • -id - Specifies the ID of a service instance to deregister. Do not use this flag if any FILE arguments are given.

Enterprise Options

  • -partition=<string> - Enterprise Specifies the partition to query. If not provided, the partition is inferred from the request's ACL token, or defaults to the default partition.
  • -namespace=<string> - Specifies the namespace to query. If not provided, the namespace will be inferred from the request's ACL token, or will default to the default namespace. Namespaces are a Consul Enterprise feature added in v1.7.0.

API Options

  • -ca-file=<value> - Path to a CA file to use for TLS when communicating with Consul. This can also be specified via the CONSUL_CACERT environment variable.

  • -ca-path=<value> - Path to a directory of CA certificates to use for TLS when communicating with Consul. This can also be specified via the CONSUL_CAPATH environment variable.

  • -client-cert=<value> - Path to a client cert file to use for TLS when verify_incoming is enabled. This can also be specified via the CONSUL_CLIENT_CERT environment variable.

  • -client-key=<value> - Path to a client key file to use for TLS when verify_incoming is enabled. This can also be specified via the CONSUL_CLIENT_KEY environment variable.

  • -http-addr=<addr> - Address of the Consul agent with the port. This can be an IP address or DNS address, but it must include the port. This can also be specified via the CONSUL_HTTP_ADDR environment variable. In Consul 0.8 and later, the default value is http://127.0.0.1:8500, and https can optionally be used instead. The scheme can also be set to HTTPS by setting the environment variable CONSUL_HTTP_SSL=true. This may be a unix domain socket using unix:///path/to/socket if the agent is configured to listen that way.

  • -tls-server-name=<value> - The server name to use as the SNI host when connecting via TLS. This can also be specified via the CONSUL_TLS_SERVER_NAME environment variable.

  • -token=<value> - ACL token to use in the request. This can also be specified via the CONSUL_HTTP_TOKEN environment variable. If unspecified, the query will default to the token of the Consul agent at the HTTP address.

  • -token-file=<value> - File containing the ACL token to use in the request instead of one specified via the -token argument or CONSUL_HTTP_TOKEN environment variable. This can also be specified via the CONSUL_HTTP_TOKEN_FILE environment variable.

Examples

To deregister by ID:

$ consul services deregister -id=web

To deregister from a configuration file:

$ cat web.json
{
  "Service": {
    "Name": "web"
  }
}

$ consul services deregister web.json
Edit this page on GitHub