2018-10-01 17:27:15 +00:00
|
|
|
---
|
2020-09-01 15:14:13 +00:00
|
|
|
layout: commands
|
2020-04-07 18:55:19 +00:00
|
|
|
page_title: 'Commands: Services Deregister'
|
2018-10-01 17:27:15 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
# Consul Agent Service Deregistration
|
|
|
|
|
|
|
|
Command: `consul services deregister`
|
|
|
|
|
2023-01-25 16:52:43 +00:00
|
|
|
Corresponding HTTP API Endpoint: [\[PUT\] /v1/agent/service/deregister/:service_id](/consul/api-docs/agent/service#deregister-service)
|
2022-01-10 17:40:11 +00:00
|
|
|
|
2018-10-01 17:27:15 +00:00
|
|
|
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 (defaults to the local agent) and is meant to
|
|
|
|
be paired with `services register`.
|
|
|
|
|
|
|
|
This is just one method for service deregistration. If the service was
|
|
|
|
registered with a configuration file, then deleting that file and
|
2023-01-25 16:52:43 +00:00
|
|
|
[reloading](/consul/commands/reload) Consul is the correct method to
|
|
|
|
deregister. See [Service Definition](/consul/docs/discovery/services) for more
|
2018-10-01 17:27:15 +00:00
|
|
|
information about registering services generally.
|
|
|
|
|
2023-01-25 16:52:43 +00:00
|
|
|
The table below shows this command's [required ACLs](/consul/api-docs/api-structure#authentication). Configuration of
|
|
|
|
[blocking queries](/consul/api-docs/features/blocking) and [agent caching](/consul/api-docs/features/caching)
|
2022-01-10 21:44:56 +00:00
|
|
|
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
|
|
|
|
|
|
|
| ACL Required |
|
|
|
|
| --------------- |
|
|
|
|
| `service:write` |
|
|
|
|
|
2018-10-01 17:27:15 +00:00
|
|
|
## 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.
|
|
|
|
|
2022-07-27 06:17:11 +00:00
|
|
|
#### Command Options
|
2018-10-01 17:27:15 +00:00
|
|
|
|
2022-07-27 06:17:11 +00:00
|
|
|
- `-id` - Specifies the ID of a service instance to deregister.
|
|
|
|
Do not use this flag if any FILE arguments are given.
|
2018-10-01 17:27:15 +00:00
|
|
|
|
2019-12-10 02:26:41 +00:00
|
|
|
#### Enterprise Options
|
|
|
|
|
2021-12-15 01:55:21 +00:00
|
|
|
@include 'http_api_partition_options.mdx'
|
|
|
|
|
2022-07-27 06:17:11 +00:00
|
|
|
@include 'http_api_namespace_options.mdx'
|
2018-10-01 17:27:15 +00:00
|
|
|
|
2022-07-27 06:17:11 +00:00
|
|
|
#### API Options
|
2018-10-01 17:27:15 +00:00
|
|
|
|
2022-07-27 06:17:11 +00:00
|
|
|
@include 'http_api_options_client.mdx'
|
2018-10-01 17:27:15 +00:00
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
|
|
To deregister by ID:
|
|
|
|
|
2020-05-19 18:32:38 +00:00
|
|
|
```shell-session
|
2018-10-01 17:27:15 +00:00
|
|
|
$ consul services deregister -id=web
|
|
|
|
```
|
|
|
|
|
|
|
|
To deregister from a configuration file:
|
|
|
|
|
2020-05-19 18:32:38 +00:00
|
|
|
```shell-session
|
2018-10-01 17:27:15 +00:00
|
|
|
$ cat web.json
|
|
|
|
{
|
|
|
|
"Service": {
|
|
|
|
"Name": "web"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
$ consul services deregister web.json
|
|
|
|
```
|