github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

website: use 127.0.0.1 instead of consul.rocks (#4523) 

By default, the Consul agent listens on the local interface
at port 8500 for API requests. This change makes the API examples
using `curl` copy-pasteable for this default configuration.
pull/4604/head
Jack Pearkes 2018-08-28 09:07:15 -07:00 committed by GitHub
parent b1a34f899f
commit c1bf14be30
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
25 changed files with 127 additions and 127 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
website/source/api/acl.html.md
View File

@ -39,7 +39,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
--request PUT \ --request PUT \
https://consul.rocks/v1/acl/bootstrap http://127.0.0.1:8500/v1/acl/bootstrap
``` ```
### Sample Response ### Sample Response
@ -104,7 +104,7 @@ The table below shows this endpoint's support for
$ curl \ $ curl \
--request PUT \ --request PUT \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/acl/create http://127.0.0.1:8500/v1/acl/create
``` ```
### Sample Response ### Sample Response
@ -155,7 +155,7 @@ required.
$ curl \ $ curl \
--request PUT \ --request PUT \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/acl/update http://127.0.0.1:8500/v1/acl/update
``` ```
## Delete ACL Token ## Delete ACL Token
@ -185,7 +185,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
--request PUT \ --request PUT \
https://consul.rocks/v1/acl/destroy/8f246b77-f3e1-ff88-5b48-8ec93abf3e05 http://127.0.0.1:8500/v1/acl/destroy/8f246b77-f3e1-ff88-5b48-8ec93abf3e05
``` ```
## Read ACL Token ## Read ACL Token
@ -216,7 +216,7 @@ Note: No ACL is required because the ACL is specified in the URL path.
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/acl/info/8f246b77-f3e1-ff88-5b48-8ec93abf3e05 http://127.0.0.1:8500/v1/acl/info/8f246b77-f3e1-ff88-5b48-8ec93abf3e05
``` ```
### Sample Response ### Sample Response
@ -263,7 +263,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
--request PUT \ --request PUT \
https://consul.rocks/v1/acl/clone/8f246b77-f3e1-ff88-5b48-8ec93abf3e05 http://127.0.0.1:8500/v1/acl/clone/8f246b77-f3e1-ff88-5b48-8ec93abf3e05
``` ```
### Sample Response ### Sample Response
@ -295,7 +295,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/acl/list http://127.0.0.1:8500/v1/acl/list
``` ```
### Sample Response ### Sample Response
@ -345,7 +345,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/acl/replication http://127.0.0.1:8500/v1/acl/replication
``` ```
### Sample Response ### Sample Response

20
website/source/api/agent.html.md
View File

@ -54,7 +54,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/agent/members http://127.0.0.1:8500/v1/agent/members
``` ```
### Sample Response ### Sample Response
@ -107,7 +107,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/agent/self http://127.0.0.1:8500/v1/agent/self
``` ```
### Sample Response ### Sample Response
@ -187,7 +187,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
--request PUT \ --request PUT \
https://consul.rocks/v1/agent/reload http://127.0.0.1:8500/v1/agent/reload
``` ```
## Enable Maintenance Mode ## Enable Maintenance Mode
@ -229,7 +229,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
--request PUT \ --request PUT \
https://consul.rocks/v1/agent/maintenance?enable=true&reason=For+API+docs http://127.0.0.1:8500/v1/agent/maintenance?enable=true&reason=For+API+docs
``` ```
## View Metrics ## View Metrics
@ -258,7 +258,7 @@ configuration directive
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/agent/metrics http://127.0.0.1:8500/v1/agent/metrics
``` ```
### Sample Response ### Sample Response
@ -384,7 +384,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/agent/monitor http://127.0.0.1:8500/v1/agent/monitor
``` ```
### Sample Response ### Sample Response
@ -429,7 +429,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/agent/join/1.2.3.4 http://127.0.0.1:8500/v1/agent/join/1.2.3.4
``` ```
## Graceful Leave and Shutdown ## Graceful Leave and Shutdown
@ -460,7 +460,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
--request PUT \ --request PUT \
https://consul.rocks/v1/agent/leave http://127.0.0.1:8500/v1/agent/leave
``` ```
## Force Leave and Shutdown ## Force Leave and Shutdown
@ -489,7 +489,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
--request PUT \ --request PUT \
https://consul.rocks/v1/agent/force-leave http://127.0.0.1:8500/v1/agent/force-leave
``` ```
## Update ACL Tokens ## Update ACL Tokens
@ -538,5 +538,5 @@ The table below shows this endpoint's support for
$ curl \ $ curl \
--request PUT \ --request PUT \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/agent/token/acl_token http://127.0.0.1:8500/v1/agent/token/acl_token
``` ```

14
website/source/api/agent/check.html.md
View File

@ -40,7 +40,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/agent/checks http://127.0.0.1:8500/v1/agent/checks
``` ```
### Sample Response ### Sample Response
@ -204,7 +204,7 @@ The table below shows this endpoint's support for
$ curl \ $ curl \
--request PUT \ --request PUT \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/agent/check/register http://127.0.0.1:8500/v1/agent/check/register
``` ```
## Deregister Check ## Deregister Check
@ -236,7 +236,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
--request PUT \ --request PUT \
https://consul.rocks/v1/agent/check/deregister/my-check-id http://127.0.0.1:8500/v1/agent/check/deregister/my-check-id
``` ```
## TTL Check Pass ## TTL Check Pass
@ -269,7 +269,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/agent/check/pass/my-check-id http://127.0.0.1:8500/v1/agent/check/pass/my-check-id
``` ```
## TTL Check Warn ## TTL Check Warn
@ -302,7 +302,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/agent/check/warn/my-check-id http://127.0.0.1:8500/v1/agent/check/warn/my-check-id
``` ```
## TTL Check Fail ## TTL Check Fail
@ -335,7 +335,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/agent/check/fail/my-check-id http://127.0.0.1:8500/v1/agent/check/fail/my-check-id
``` ```
## TTL Check Update ## TTL Check Update
@ -382,5 +382,5 @@ The table below shows this endpoint's support for
$ curl \ $ curl \
--request PUT \ --request PUT \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/agent/check/update/my-check-id http://127.0.0.1:8500/v1/agent/check/update/my-check-id
``` ```

8
website/source/api/agent/connect.html.md
View File

@ -72,7 +72,7 @@ The table below shows this endpoint's support for
$ curl \ $ curl \
--request POST \ --request POST \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/agent/connect/authorize http://127.0.0.1:8500/v1/agent/connect/authorize
``` ```
### Sample Response ### Sample Response
@ -113,7 +113,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/connect/ca/roots http://127.0.0.1:8500/v1/connect/ca/roots
``` ```
### Sample Response ### Sample Response
@ -179,7 +179,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/connect/ca/leaf/web http://127.0.0.1:8500/v1/connect/ca/leaf/web
``` ```
### Sample Response ### Sample Response
@ -250,7 +250,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/connect/proxy/web-proxy http://127.0.0.1:8500/v1/connect/proxy/web-proxy
``` ```
### Sample Response ### Sample Response

8
website/source/api/agent/service.html.md
View File

@ -41,7 +41,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/agent/services http://127.0.0.1:8500/v1/agent/services
``` ```
### Sample Response ### Sample Response
@ -199,7 +199,7 @@ For the `Connect` field, the parameters are:
$ curl \ $ curl \
--request PUT \ --request PUT \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/agent/service/register http://127.0.0.1:8500/v1/agent/service/register
``` ```
## Deregister Service ## Deregister Service
@ -233,7 +233,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
--request PUT \ --request PUT \
https://consul.rocks/v1/agent/service/deregister/my-service-id http://127.0.0.1:8500/v1/agent/service/deregister/my-service-id
``` ```
## Enable Maintenance Mode ## Enable Maintenance Mode
@ -276,5 +276,5 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
--request PUT \ --request PUT \
https://consul.rocks/v1/agent/service/maintenance/my-service-id?enable=true&reason=For+the+docs http://127.0.0.1:8500/v1/agent/service/maintenance/my-service-id?enable=true&reason=For+the+docs
``` ```

14
website/source/api/catalog.html.md
View File

@ -134,7 +134,7 @@ and vice versa. A catalog entry can have either, neither, or both.
$ curl \ $ curl \
--request PUT \ --request PUT \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/catalog/register http://127.0.0.1:8500/v1/catalog/register
``` ```
## Deregister Entity ## Deregister Entity
@ -204,7 +204,7 @@ The behavior of the endpoint depends on what keys are provided.
$ curl \ $ curl \
--request PUT \ --request PUT \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/catalog/deregister http://127.0.0.1:8500/v1/catalog/deregister
``` ```
## List Datacenters ## List Datacenters
@ -234,7 +234,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/catalog/datacenters http://127.0.0.1:8500/v1/catalog/datacenters
``` ```
### Sample Response ### Sample Response
@ -280,7 +280,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/catalog/nodes http://127.0.0.1:8500/v1/catalog/nodes
``` ```
### Sample Response ### Sample Response
@ -348,7 +348,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/catalog/services http://127.0.0.1:8500/v1/catalog/services
``` ```
### Sample Response ### Sample Response
@ -409,7 +409,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/catalog/service/my-service http://127.0.0.1:8500/v1/catalog/service/my-service
``` ```
### Sample Response ### Sample Response
@ -536,7 +536,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/catalog/node/my-node http://127.0.0.1:8500/v1/catalog/node/my-node
``` ```
### Sample Response ### Sample Response

6
website/source/api/connect/ca.html.md
View File

@ -34,7 +34,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/connect/ca/roots http://127.0.0.1:8500/v1/connect/ca/roots
``` ```
### Sample Response ### Sample Response
@ -82,7 +82,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/connect/ca/configuration http://127.0.0.1:8500/v1/connect/ca/configuration
``` ```
### Sample Response ### Sample Response
@ -146,5 +146,5 @@ providers, see [Provider Config](/docs/connect/ca.html).
$ curl \ $ curl \
--request PUT \ --request PUT \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/connect/ca/configuration http://127.0.0.1:8500/v1/connect/ca/configuration
``` ```

14
website/source/api/connect/intentions.html.md
View File

@ -76,7 +76,7 @@ See [Intention Management Permissions](/docs/connect/intentions.html#intention-m
$ curl \ $ curl \
--request POST \ --request POST \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/connect/intentions http://127.0.0.1:8500/v1/connect/intentions
``` ```
### Sample Response ### Sample Response
@ -116,7 +116,7 @@ See [Intention Management Permissions](/docs/connect/intentions.html#intention-m
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/connect/intentions/e9ebc19f-d481-42b1-4871-4d298d3acd5c http://127.0.0.1:8500/v1/connect/intentions/e9ebc19f-d481-42b1-4871-4d298d3acd5c
``` ```
### Sample Response ### Sample Response
@ -166,7 +166,7 @@ See [Intention Management Permissions](/docs/connect/intentions.html#intention-m
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/connect/intentions http://127.0.0.1:8500/v1/connect/intentions
``` ```
### Sample Response ### Sample Response
@ -239,7 +239,7 @@ See [Intention Management Permissions](/docs/connect/intentions.html#intention-m
$ curl \ $ curl \
--request PUT \ --request PUT \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/connect/intentions/e9ebc19f-d481-42b1-4871-4d298d3acd5c http://127.0.0.1:8500/v1/connect/intentions/e9ebc19f-d481-42b1-4871-4d298d3acd5c
``` ```
## Delete Intention ## Delete Intention
@ -273,7 +273,7 @@ See [Intention Management Permissions](/docs/connect/intentions.html#intention-m
```text ```text
$ curl \ $ curl \
--request DELETE \ --request DELETE \
https://consul.rocks/v1/connect/intentions/e9ebc19f-d481-42b1-4871-4d298d3acd5c http://127.0.0.1:8500/v1/connect/intentions/e9ebc19f-d481-42b1-4871-4d298d3acd5c
``` ```
## Check Intention Result ## Check Intention Result
@ -315,7 +315,7 @@ See [Intention Management Permissions](/docs/connect/intentions.html#intention-m
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/connect/intentions/check?source=web&destination=db http://127.0.0.1:8500/v1/connect/intentions/check?source=web&destination=db
``` ```
### Sample Response ### Sample Response
@ -361,7 +361,7 @@ See [Intention Management Permissions](/docs/connect/intentions.html#intention-m
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/connect/intentions/match?by=source&name=web http://127.0.0.1:8500/v1/connect/intentions/match?by=source&name=web
``` ```
### Sample Response ### Sample Response

8
website/source/api/coordinate.html.md
View File

@ -42,7 +42,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/coordinate/datacenters http://127.0.0.1:8500/v1/coordinate/datacenters
``` ```
### Sample Response ### Sample Response
@ -104,7 +104,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/coordinate/nodes http://127.0.0.1:8500/v1/coordinate/nodes
``` ```
### Sample Response ### Sample Response
@ -160,7 +160,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/coordinate/node/agent-one http://127.0.0.1:8500/v1/coordinate/node/agent-one
``` ```
### Sample Response ### Sample Response
@ -229,5 +229,5 @@ The table below shows this endpoint's support for
$ curl \ $ curl \
--request PUT \ --request PUT \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/coordinate/update http://127.0.0.1:8500/v1/coordinate/update
``` ```

4
website/source/api/event.html.md
View File

@ -63,7 +63,7 @@ Lorem ipsum dolor sit amet, consectetur adipisicing elit...
$ curl \ $ curl \
--request PUT \ --request PUT \
--data @payload \ --data @payload \
https://consul.rocks/v1/event/fire/my-event http://127.0.0.1:8500/v1/event/fire/my-event
``` ```
### Sample Response ### Sample Response
@ -122,7 +122,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/event/list http://127.0.0.1:8500/v1/event/list
``` ```
### Sample Response ### Sample Response

8
website/source/api/health.html.md
View File

@ -45,7 +45,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/health/node/my-node http://127.0.0.1:8500/v1/health/node/my-node
``` ```
### Sample Response ### Sample Response
@ -120,7 +120,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/health/checks/my-service http://127.0.0.1:8500/v1/health/checks/my-service
``` ```
### Sample Response ### Sample Response
@ -190,7 +190,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/health/service/my-service http://127.0.0.1:8500/v1/health/service/my-service
``` ```
### Sample Response ### Sample Response
@ -305,7 +305,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/health/state/passing http://127.0.0.1:8500/v1/health/state/passing
``` ```
### Sample Response ### Sample Response

4
website/source/api/index.html.md
View File

@ -40,7 +40,7 @@ Here is an example using `curl`:
```text ```text
$ curl \ $ curl \
--header "X-Consul-Token: abcd1234" \ --header "X-Consul-Token: abcd1234" \
https://consul.rocks/v1/agent/members http://127.0.0.1:8500/v1/agent/members
``` ```
Previously this was provided via a `?token=` query parameter. This functionality Previously this was provided via a `?token=` query parameter. This functionality
@ -141,7 +141,7 @@ Here is the same example using `curl`:
$ curl \ $ curl \
--request PUT \ --request PUT \
--data 'hello consul' \ --data 'hello consul' \
https://consul.rocks/v1/kv/foo http://127.0.0.1:8500/v1/kv/foo
``` ```
## Translated Addresses ## Translated Addresses

8
website/source/api/kv.html.md
View File

@ -69,7 +69,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/kv/my-key http://127.0.0.1:8500/v1/kv/my-key
``` ```
### Sample Response ### Sample Response
@ -208,14 +208,14 @@ The payload is arbitrary, and is loaded directly into Consul as supplied.
$ curl \ $ curl \
--request PUT \ --request PUT \
--data @contents \ --data @contents \
https://consul.rocks/v1/kv/my-key http://127.0.0.1:8500/v1/kv/my-key
# or # or
$ curl \ $ curl \
--request PUT \ --request PUT \
--data-binary @contents \ --data-binary @contents \
https://consul.rocks/v1/kv/my-key http://127.0.0.1:8500/v1/kv/my-key
``` ```
### Sample Response ### Sample Response
@ -258,7 +258,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
--request DELETE \ --request DELETE \
https://consul.rocks/v1/kv/my-key http://127.0.0.1:8500/v1/kv/my-key
``` ```
### Sample Response ### Sample Response

14
website/source/api/operator/area.html.md
View File

@ -83,7 +83,7 @@ The table below shows this endpoint's support for
$ curl \ $ curl \
--request POST \ --request POST \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/operator/area http://127.0.0.1:8500/v1/operator/area
``` ```
### Sample Response ### Sample Response
@ -121,7 +121,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/operator/area http://127.0.0.1:8500/v1/operator/area
``` ```
### Sample Response ### Sample Response
@ -176,7 +176,7 @@ The table below shows this endpoint's support for
$ curl \ $ curl \
--request PUT \ --request PUT \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/operator/area/8f246b77-f3e1-ff88-5b48-8ec93abf3e05 http://127.0.0.1:8500/v1/operator/area/8f246b77-f3e1-ff88-5b48-8ec93abf3e05
``` ```
## List Specific Network Area ## List Specific Network Area
@ -209,7 +209,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/operator/area/8f246b77-f3e1-ff88-5b48-8ec93abf3e05 http://127.0.0.1:8500/v1/operator/area/8f246b77-f3e1-ff88-5b48-8ec93abf3e05
``` ```
### Sample Response ### Sample Response
@ -255,7 +255,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
--request DELETE \ --request DELETE \
https://consul.rocks/v1/operator/area/8f246b77-f3e1-ff88-5b48-8ec93abf3e05 http://127.0.0.1:8500/v1/operator/area/8f246b77-f3e1-ff88-5b48-8ec93abf3e05
``` ```
## Join Network Area ## Join Network Area
@ -299,7 +299,7 @@ This can be provided as `IP`, `IP:port`, `hostname`, or `hostname:port`.
$ curl \ $ curl \
--request PUT \ --request PUT \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/operator/area/8f246b77-f3e1-ff88-5b48-8ec93abf3e05/join http://127.0.0.1:8500/v1/operator/area/8f246b77-f3e1-ff88-5b48-8ec93abf3e05/join
``` ```
### Sample Response ### Sample Response
@ -361,7 +361,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/operator/area/8f246b77-f3e1-ff88-5b48-8ec93abf3e05/members http://127.0.0.1:8500/v1/operator/area/8f246b77-f3e1-ff88-5b48-8ec93abf3e05/members
``` ```
### Sample Response ### Sample Response

4
website/source/api/operator/autopilot.html.md
View File

@ -47,7 +47,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/operator/autopilot/configuration http://127.0.0.1:8500/operator/autopilot/configuration
``` ```
### Sample Response ### Sample Response
@ -168,7 +168,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/operator/autopilot/health http://127.0.0.1:8500/v1/operator/autopilot/health
``` ```
### Sample response ### Sample response

8
website/source/api/operator/keyring.html.md
View File

@ -45,7 +45,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/operator/keyring http://127.0.0.1:8500/v1/operator/keyring
``` ```
### Sample Response ### Sample Response
@ -130,7 +130,7 @@ The table below shows this endpoint's support for
$ curl \ $ curl \
--request POST \ --request POST \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/operator/keyring http://127.0.0.1:8500/v1/operator/keyring
``` ```
## Change Primary Gossip Encryption Key ## Change Primary Gossip Encryption Key
@ -175,7 +175,7 @@ The table below shows this endpoint's support for
$ curl \ $ curl \
--request PUT \ --request PUT \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/operator/keyring http://127.0.0.1:8500/v1/operator/keyring
``` ```
## Delete Gossip Encryption Key ## Delete Gossip Encryption Key
@ -219,5 +219,5 @@ The table below shows this endpoint's support for
$ curl \ $ curl \
--request DELETE \ --request DELETE \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/operator/keyring http://127.0.0.1:8500/v1/operator/keyring
``` ```

4
website/source/api/operator/license.html.md
View File

@ -42,7 +42,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/operator/license http://127.0.0.1:8500/v1/operator/license
``` ```
### Sample Response ### Sample Response
@ -109,7 +109,7 @@ The payload is the raw license blob.
$ curl \ $ curl \
--request PUT \ --request PUT \
--data @consul.license \ --data @consul.license \
https://consul.rocks/v1/operator/license http://127.0.0.1:8500/v1/operator/license
``` ```
### Sample Response ### Sample Response

4
website/source/api/operator/raft.html.md
View File

@ -49,7 +49,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/operator/raft/configuration http://127.0.0.1:8500/v1/operator/raft/configuration
``` ```
### Sample Response ### Sample Response
@ -142,5 +142,5 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
--request DELETE \ --request DELETE \
https://consul.rocks/v1/operator/raft/peer?address=1.2.3.4:5678 http://127.0.0.1:8500/v1/operator/raft/peer?address=1.2.3.4:5678
``` ```

2
website/source/api/operator/segment.html.md
View File

@ -49,7 +49,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/operator/segment http://127.0.0.1:8500/v1/operator/segment
``` ```
### Sample Response ### Sample Response

14
website/source/api/query.html.md
View File

@ -276,7 +276,7 @@ The table below shows this endpoint's support for
$ curl \ $ curl \
--request POST \ --request POST \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/query http://127.0.0.1:8500/v1/query
``` ```
### Sample Response ### Sample Response
@ -314,7 +314,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/query http://127.0.0.1:8500/v1/query
``` ```
### Sample Response ### Sample Response
@ -383,7 +383,7 @@ more information.
$ curl \ $ curl \
--request PUT \ --request PUT \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/query/8f246b77-f3e1-ff88-5b48-8ec93abf3e05 http://127.0.0.1:8500/v1/query/8f246b77-f3e1-ff88-5b48-8ec93abf3e05
``` ```
## Read Prepared Query ## Read Prepared Query
@ -417,7 +417,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/query/8f246b77-f3e1-ff88-5b48-8ec93abf3e05 http://127.0.0.1:8500/v1/query/8f246b77-f3e1-ff88-5b48-8ec93abf3e05
``` ```
### Sample Response ### Sample Response
@ -457,7 +457,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
--request DELETE \ --request DELETE \
https://consul.rocks/v1/query/8f246b77-f3e1-ff88-5b48-8ec93abf3e05 http://127.0.0.1:8500/v1/query/8f246b77-f3e1-ff88-5b48-8ec93abf3e05
``` ```
## Execute Prepared Query ## Execute Prepared Query
@ -513,7 +513,7 @@ Token will be used.
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/query/8f246b77-f3e1-ff88-5b48-8ec93abf3e05/execute?near=_agent http://127.0.0.1:8500/v1/query/8f246b77-f3e1-ff88-5b48-8ec93abf3e05/execute?near=_agent
``` ```
### Sample Response ### Sample Response
@ -620,7 +620,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/query/8f246b77-f3e1-ff88-5b48-8ec93abf3e05/explain http://127.0.0.1:8500/v1/query/8f246b77-f3e1-ff88-5b48-8ec93abf3e05/explain
``` ```
### Sample Response ### Sample Response

12
website/source/api/session.html.md
View File

@ -77,7 +77,7 @@ The table below shows this endpoint's support for
$ curl \ $ curl \
--request PUT \ --request PUT \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/session/create http://127.0.0.1:8500/v1/session/create
``` ```
### Sample Response ### Sample Response
@ -127,7 +127,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
--request PUT --request PUT
https://consul.rocks/v1/session/destroy/adf4238a-882b-9ddc-4a9d-5b6758e4159e http://127.0.0.1:8500/v1/session/destroy/adf4238a-882b-9ddc-4a9d-5b6758e4159e
``` ```
### Sample Response ### Sample Response
@ -166,7 +166,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/session/info/adf4238a-882b-9ddc-4a9d-5b6758e4159e http://127.0.0.1:8500/v1/session/info/adf4238a-882b-9ddc-4a9d-5b6758e4159e
``` ```
### Sample Response ### Sample Response
@ -217,7 +217,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/session/node/node-abcd1234 http://127.0.0.1:8500/v1/session/node/node-abcd1234
``` ```
### Sample Response ### Sample Response
@ -263,7 +263,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
https://consul.rocks/v1/session/list http://127.0.0.1:8500/v1/session/list
``` ```
### Sample Response ### Sample Response
@ -314,7 +314,7 @@ The table below shows this endpoint's support for
```text ```text
$ curl \ $ curl \
--request PUT \ --request PUT \
https://consul.rocks/v1/session/renew/adf4238a-882b-9ddc-4a9d-5b6758e4159e http://127.0.0.1:8500/v1/session/renew/adf4238a-882b-9ddc-4a9d-5b6758e4159e
``` ```
### Sample Response ### Sample Response

4
website/source/api/snapshot.html.md
View File

@ -60,7 +60,7 @@ The table below shows this endpoint's support for
With a custom datacenter: With a custom datacenter:
```text ```text
$ curl https://consul.rocks/v1/snapshot?dc=my-datacenter -o snapshot.tgz $ curl http://127.0.0.1:8500/v1/snapshot?dc=my-datacenter -o snapshot.tgz
``` ```
The above example results in a tarball named `snapshot.tgz` in the current working directory. The above example results in a tarball named `snapshot.tgz` in the current working directory.
@ -104,7 +104,7 @@ The table below shows this endpoint's support for
$ curl \ $ curl \
--request PUT \ --request PUT \
--data-binary @snapshot \ --data-binary @snapshot \
https://consul.rocks/v1/snapshot http://127.0.0.1:8500/v1/snapshot
``` ```
~> Some tools default to www/encoded uploads. Consul expects the snapshot to be ~> Some tools default to www/encoded uploads. Consul expects the snapshot to be

4
website/source/api/status.html.md
View File

@ -35,7 +35,7 @@ The table below shows this endpoint's support for
### Sample Request ### Sample Request
```text ```text
$ curl https://consul.rocks/v1/status/leader $ curl http://127.0.0.1:8500/v1/status/leader
``` ```
### Sample Response ### Sample Response
@ -66,7 +66,7 @@ The table below shows this endpoint's support for
### Sample Request ### Sample Request
```text ```text
$ curl https://consul.rocks/v1/status/peers $ curl http://127.0.0.1:8500/v1/status/peers
``` ```
### Sample Response ### Sample Response

2
website/source/api/txn.html.md
View File

@ -100,7 +100,7 @@ atomic transaction. Up to 64 operations may be present in a single transaction.
$ curl \ $ curl \
--request PUT \ --request PUT \
--data @payload.json \ --data @payload.json \
https://consul.rocks/v1/txn http://127.0.0.1:8500/v1/txn
``` ```
### Sample Response ### Sample Response

4
website/source/docs/guides/acl.html.md
View File

@ -588,7 +588,7 @@ $ curl \
"Name": "my-app-token", "Name": "my-app-token",
"Type": "client", "Type": "client",
"Rules": "key \"\" { policy = \"read\" } key \"foo/\" { policy = \"write\" } key \"foo/private/\" { policy = \"deny\" } operator = \"read\"" "Rules": "key \"\" { policy = \"read\" } key \"foo/\" { policy = \"write\" } key \"foo/private/\" { policy = \"deny\" } operator = \"read\""
}' https://consul.rocks/v1/acl/create?token=<management token> }' http://127.0.0.1:8500/v1/acl/create?token=<management token>
``` ```
Here's an equivalent request using the JSON form: Here's an equivalent request using the JSON form:
@ -601,7 +601,7 @@ $ curl \
"Name": "my-app-token", "Name": "my-app-token",
"Type": "client", "Type": "client",
"Rules": "{\"key\":{\"\":{\"policy\":\"read\"},\"foo/\":{\"policy\":\"write\"},\"foo/private\":{\"policy\":\"deny\"}},\"operator\":\"read\"}" "Rules": "{\"key\":{\"\":{\"policy\":\"read\"},\"foo/\":{\"policy\":\"write\"},\"foo/private\":{\"policy\":\"deny\"}},\"operator\":\"read\"}"
}' https://consul.rocks/v1/acl/create?token=<management token> }' http://127.0.0.1:8500/v1/acl/create?token=<management token>
``` ```
On success, the token ID is returned: On success, the token ID is returned: