Changed nomad.rocks to localhost:4646 to align with defaults
Should provide cut and paste example for most users. Advanced users should be able to correct URLs to something appropriate.
This commit is contained in:
Charlie Voiselle
parent
cd490958fc
commit
fb5091678b
|
|
@ -33,7 +33,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/acl/policies
|
||||
https://localhost:4646/v1/acl/policies
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -91,7 +91,7 @@ The table below shows this endpoint's support for
|
|||
$ curl \
|
||||
--request POST \
|
||||
--data @payload.json \
|
||||
https://nomad.rocks/v1/acl/policy/my-policy
|
||||
https://localhost:4646/v1/acl/policy/my-policy
|
||||
```
|
||||
|
||||
## Read Policy
|
||||
|
|
@ -116,7 +116,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/acl/policy/foo
|
||||
https://localhost:4646/v1/acl/policy/foo
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -157,6 +157,6 @@ The table below shows this endpoint's support for
|
|||
```text
|
||||
$ curl \
|
||||
--request DELETE \
|
||||
https://nomad.rocks/v1/acl/policy/foo
|
||||
https://localhost:4646/v1/acl/policy/foo
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ The table below shows this endpoint's support for
|
|||
```text
|
||||
$ curl \
|
||||
--request POST \
|
||||
https://nomad.rocks/v1/acl/bootstrap
|
||||
https://localhost:4646/v1/acl/bootstrap
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -75,7 +75,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/acl/tokens
|
||||
https://localhost:4646/v1/acl/tokens
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -139,7 +139,7 @@ The table below shows this endpoint's support for
|
|||
$ curl \
|
||||
--request POST \
|
||||
--data @payload.json \
|
||||
https://nomad.rocks/v1/acl/token
|
||||
https://localhost:4646/v1/acl/token
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -205,7 +205,7 @@ The table below shows this endpoint's support for
|
|||
$ curl \
|
||||
--request POST \
|
||||
--data @payload.json \
|
||||
https://nomad.rocks/v1/acl/token/aa534e09-6a07-0a45-2295-a7f77063d429
|
||||
https://localhost:4646/v1/acl/token/aa534e09-6a07-0a45-2295-a7f77063d429
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -247,7 +247,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/acl/token/aa534e09-6a07-0a45-2295-a7f77063d429
|
||||
https://localhost:4646/v1/acl/token/aa534e09-6a07-0a45-2295-a7f77063d429
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -290,7 +290,7 @@ The table below shows this endpoint's support for
|
|||
```text
|
||||
$ curl \
|
||||
--header "X-Nomad-Token: 8176afd3-772d-0b71-8f85-7fa5d903e9d4" \
|
||||
https://nomad.rocks/v1/acl/token/self
|
||||
https://localhost:4646/v1/acl/token/self
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -337,6 +337,6 @@ The table below shows this endpoint's support for
|
|||
```text
|
||||
$ curl \
|
||||
--request DELETE \
|
||||
https://nomad.rocks/v1/acl/token/aa534e09-6a07-0a45-2295-a7f77063d429
|
||||
https://localhost:4646/v1/acl/token/aa534e09-6a07-0a45-2295-a7f77063d429
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/agent/members
|
||||
https://localhost:4646/v1/agent/members
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -94,7 +94,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/agent/servers
|
||||
https://localhost:4646/v1/agent/servers
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -132,7 +132,7 @@ The table below shows this endpoint's support for
|
|||
```text
|
||||
$ curl \
|
||||
--request POST \
|
||||
https://nomad.rocks/v1/agent/servers?address=1.2.3.4:4647&addres=5.6.7.8:4647
|
||||
https://localhost:4646/v1/agent/servers?address=1.2.3.4:4647&addres=5.6.7.8:4647
|
||||
```
|
||||
|
||||
## Query Self
|
||||
|
|
@ -155,7 +155,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/agent/self
|
||||
https://localhost:4646/v1/agent/self
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -414,7 +414,7 @@ The table below shows this endpoint's support for
|
|||
```text
|
||||
$ curl \
|
||||
--request POST \
|
||||
https://nomad.rocks/v1/agent/join?address=1.2.3.4&address=5.6.7.8
|
||||
https://localhost:4646/v1/agent/join?address=1.2.3.4&address=5.6.7.8
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -453,7 +453,7 @@ The table below shows this endpoint's support for
|
|||
```text
|
||||
$ curl \
|
||||
--request POST \
|
||||
https://nomad.rocks/v1/agent/force-leave?node=client-ab2e23dc
|
||||
https://localhost:4646/v1/agent/force-leave?node=client-ab2e23dc
|
||||
```
|
||||
|
||||
## Health
|
||||
|
|
@ -480,7 +480,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/agent/health
|
||||
https://localhost:4646/v1/agent/health
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
|
|||
|
|
@ -35,12 +35,12 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/allocations
|
||||
https://localhost:4646/v1/allocations
|
||||
```
|
||||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/allocations?prefix=a8198d79
|
||||
https://localhost:4646/v1/allocations?prefix=a8198d79
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -173,7 +173,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/allocation/5456bd7a-9fc0-c0dd-6131-cbee77f57577
|
||||
https://localhost:4646/v1/allocation/5456bd7a-9fc0-c0dd-6131-cbee77f57577
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/client/stats
|
||||
https://localhost:4646/v1/client/stats
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -161,7 +161,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/client/allocation/5fc98185-17ff-26bc-a802-0c74fa471c99/stats
|
||||
https://localhost:4646/v1/client/allocation/5fc98185-17ff-26bc-a802-0c74fa471c99/stats
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -265,12 +265,12 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/client/fs/cat/5fc98185-17ff-26bc-a802-0c74fa471c99
|
||||
https://localhost:4646/v1/client/fs/cat/5fc98185-17ff-26bc-a802-0c74fa471c99
|
||||
```
|
||||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/client/fs/cat/5fc98185-17ff-26bc-a802-0c74fa471c99?path=alloc/file.json
|
||||
https://localhost:4646/v1/client/fs/cat/5fc98185-17ff-26bc-a802-0c74fa471c99?path=alloc/file.json
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -316,7 +316,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/client/fs/readat/5fc98185-17ff-26bc-a802-0c74fa471c99?path=/alloc/foo&offset=1323&limit=19303
|
||||
https://localhost:4646/v1/client/fs/readat/5fc98185-17ff-26bc-a802-0c74fa471c99?path=/alloc/foo&offset=1323&limit=19303
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -360,7 +360,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/client/fs/stream/5fc98185-17ff-26bc-a802-0c74fa471c99?path=/alloc/logs/redis.log
|
||||
https://localhost:4646/v1/client/fs/stream/5fc98185-17ff-26bc-a802-0c74fa471c99?path=/alloc/logs/redis.log
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -433,7 +433,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/client/fs/logs/5fc98185-17ff-26bc-a802-0c74fa471c99
|
||||
https://localhost:4646/v1/client/fs/logs/5fc98185-17ff-26bc-a802-0c74fa471c99
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -493,7 +493,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/client/fs/ls/5fc98185-17ff-26bc-a802-0c74fa471c99
|
||||
https://localhost:4646/v1/client/fs/ls/5fc98185-17ff-26bc-a802-0c74fa471c99
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -546,7 +546,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/client/fs/stat/5fc98185-17ff-26bc-a802-0c74fa471c99
|
||||
https://localhost:4646/v1/client/fs/stat/5fc98185-17ff-26bc-a802-0c74fa471c99
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -583,5 +583,5 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/client/gc
|
||||
https://localhost:4646/v1/client/gc
|
||||
```
|
||||
|
|
|
|||
|
|
@ -35,12 +35,12 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/deployments
|
||||
https://localhost:4646/v1/deployments
|
||||
```
|
||||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/deployments?prefix=25ba81c
|
||||
https://localhost:4646/v1/deployments?prefix=25ba81c
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -97,7 +97,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/deployment/70638f62-5c19-193e-30d6-f9d6e689ab8e
|
||||
https://localhost:4646/v1/deployment/70638f62-5c19-193e-30d6-f9d6e689ab8e
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -153,7 +153,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/deployment/allocations/5456bd7a-9fc0-c0dd-6131-cbee77f57577
|
||||
https://localhost:4646/v1/deployment/allocations/5456bd7a-9fc0-c0dd-6131-cbee77f57577
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -290,7 +290,7 @@ The table below shows this endpoint's support for
|
|||
```text
|
||||
$ curl \
|
||||
--request POST \
|
||||
https://nomad.rocks/v1/deployment/fail/5456bd7a-9fc0-c0dd-6131-cbee77f57577
|
||||
https://localhost:4646/v1/deployment/fail/5456bd7a-9fc0-c0dd-6131-cbee77f57577
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -344,7 +344,7 @@ The table below shows this endpoint's support for
|
|||
```text
|
||||
$ curl \
|
||||
--request POST \
|
||||
https://nomad.rocks/v1/deployment/pause/5456bd7a-9fc0-c0dd-6131-cbee77f57577
|
||||
https://localhost:4646/v1/deployment/pause/5456bd7a-9fc0-c0dd-6131-cbee77f57577
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -408,7 +408,7 @@ The table below shows this endpoint's support for
|
|||
```text
|
||||
$ curl \
|
||||
--request POST \
|
||||
https://nomad.rocks/v1/deployment/promote/5456bd7a-9fc0-c0dd-6131-cbee77f57577
|
||||
https://localhost:4646/v1/deployment/promote/5456bd7a-9fc0-c0dd-6131-cbee77f57577
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -474,7 +474,7 @@ The table below shows this endpoint's support for
|
|||
```text
|
||||
$ curl \
|
||||
--request POST \
|
||||
https://nomad.rocks/v1/deployment/allocation-health/5456bd7a-9fc0-c0dd-6131-cbee77f57577
|
||||
https://localhost:4646/v1/deployment/allocation-health/5456bd7a-9fc0-c0dd-6131-cbee77f57577
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
|
|||
|
|
@ -35,12 +35,12 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/evaluations
|
||||
https://localhost:4646/v1/evaluations
|
||||
```
|
||||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/evaluations?prefix=25ba81c
|
||||
https://localhost:4646/v1/evaluations?prefix=25ba81c
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -102,7 +102,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/evaluation/5456bd7a-9fc0-c0dd-6131-cbee77f57577
|
||||
https://localhost:4646/v1/evaluation/5456bd7a-9fc0-c0dd-6131-cbee77f57577
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -163,7 +163,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/evaluation/5456bd7a-9fc0-c0dd-6131-cbee77f57577/allocations
|
||||
https://localhost:4646/v1/evaluation/5456bd7a-9fc0-c0dd-6131-cbee77f57577/allocations
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ $ curl http://127.0.0.1:4646/v1/agent/members
|
|||
```
|
||||
|
||||
The conventions used in the API documentation do not list a port and use the
|
||||
standard URL `nomad.rocks`. Be sure to replace this with your Nomad agent URL
|
||||
standard URL `localhost:4646`. Be sure to replace this with your Nomad agent URL
|
||||
when using the examples.
|
||||
|
||||
## Data Model and Layout
|
||||
|
|
@ -86,7 +86,7 @@ Here is an example using curl:
|
|||
```text
|
||||
$ curl \
|
||||
--header "X-Nomad-Token: aa534e09-6a07-0a45-2295-a7f77063d429" \
|
||||
https://nomad.rocks/v1/jobs
|
||||
https://localhost:4646/v1/jobs
|
||||
```
|
||||
|
||||
## Blocking Queries
|
||||
|
|
@ -166,7 +166,7 @@ accepts gzip compression. This is achieved by passing the accept encoding:
|
|||
```
|
||||
$ curl \
|
||||
--header "Accept-Encoding: gzip" \
|
||||
https://nomad.rocks/v1/...
|
||||
https://localhost:4646/v1/...
|
||||
```
|
||||
|
||||
## Formatted JSON Output
|
||||
|
|
@ -179,7 +179,7 @@ server-formatted data. Asking the server to format the data takes away
|
|||
processing cycles from more important tasks.
|
||||
|
||||
```
|
||||
$ curl https://nomad.rocks/v1/page?pretty
|
||||
$ curl https://localhost:4646/v1/page?pretty
|
||||
```
|
||||
|
||||
## HTTP Methods
|
||||
|
|
|
|||
|
|
@ -35,12 +35,12 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/jobs
|
||||
https://localhost:4646/v1/jobs
|
||||
```
|
||||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/jobs?prefix=team
|
||||
https://localhost:4646/v1/jobs?prefix=team
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -206,7 +206,7 @@ The table below shows this endpoint's support for
|
|||
$ curl \
|
||||
--request POST \
|
||||
--data @my-job.nomad \
|
||||
https://nomad.rocks/v1/jobs
|
||||
https://localhost:4646/v1/jobs
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -249,7 +249,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/job/my-job
|
||||
https://localhost:4646/v1/job/my-job
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -463,7 +463,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/job/my-job/versions
|
||||
https://localhost:4646/v1/job/my-job/versions
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -639,7 +639,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/job/my-job/allocations
|
||||
https://localhost:4646/v1/job/my-job/allocations
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -792,7 +792,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/job/my-job/evaluations
|
||||
https://localhost:4646/v1/job/my-job/evaluations
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -853,7 +853,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/job/my-job/deployments
|
||||
https://localhost:4646/v1/job/my-job/deployments
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -938,7 +938,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/job/my-job/deployment
|
||||
https://localhost:4646/v1/job/my-job/deployment
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -998,7 +998,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/job/my-job/summary
|
||||
https://localhost:4646/v1/job/my-job/summary
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -1079,7 +1079,7 @@ The table below shows this endpoint's support for
|
|||
$ curl \
|
||||
--request POST \
|
||||
--data @payload.json \
|
||||
https://nomad.rocks/v1/job/my-job
|
||||
https://localhost:4646/v1/job/my-job
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -1136,7 +1136,7 @@ The table below shows this endpoint's support for
|
|||
$ curl \
|
||||
--request POST \
|
||||
--payload @payload.json \
|
||||
https://nomad.rocks/v1/job/my-job/dispatch
|
||||
https://localhost:4646/v1/job/my-job/dispatch
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -1193,7 +1193,7 @@ The table below shows this endpoint's support for
|
|||
$ curl \
|
||||
--request POST \
|
||||
--payload @payload.json \
|
||||
https://nomad.rocks/v1/job/my-job/revert
|
||||
https://localhost:4646/v1/job/my-job/revert
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -1249,7 +1249,7 @@ The table below shows this endpoint's support for
|
|||
$ curl \
|
||||
--request POST \
|
||||
--payload @payload.json \
|
||||
https://nomad.rocks/v1/job/my-job/stable
|
||||
https://localhost:4646/v1/job/my-job/stable
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -1288,7 +1288,7 @@ The table below shows this endpoint's support for
|
|||
```text
|
||||
$ curl \
|
||||
--request POST \
|
||||
https://nomad.rocks/v1/job/my-job/evaluate
|
||||
https://localhost:4646/v1/job/my-job/evaluate
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -1348,7 +1348,7 @@ The table below shows this endpoint's support for
|
|||
$ curl \
|
||||
--request POST \
|
||||
--payload @payload.json \
|
||||
https://nomad.rocks/v1/job/my-job/plan
|
||||
https://localhost:4646/v1/job/my-job/plan
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -1548,7 +1548,7 @@ The table below shows this endpoint's support for
|
|||
```text
|
||||
$ curl \
|
||||
--request POST \
|
||||
https://nomad.rocks/v1/job/my-job/periodic/force
|
||||
https://localhost:4646/v1/job/my-job/periodic/force
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -1590,7 +1590,7 @@ The table below shows this endpoint's support for
|
|||
```text
|
||||
$ curl \
|
||||
--request DELETE \
|
||||
https://nomad.rocks/v1/job/my-job?purge=true
|
||||
https://localhost:4646/v1/job/my-job?purge=true
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
|
|||
|
|
@ -31,11 +31,11 @@ The table below shows this endpoint's support for
|
|||
### Sample Request
|
||||
|
||||
```text
|
||||
$ curl https://nomad.rocks/v1/metrics
|
||||
$ curl https://localhost:4646/v1/metrics
|
||||
```
|
||||
|
||||
```text
|
||||
$ curl https://nomad.rocks/v1/metrics?format=prometheus
|
||||
$ curl https://localhost:4646/v1/metrics?format=prometheus
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
|
|||
|
|
@ -38,12 +38,12 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/namespaces
|
||||
https://localhost:4646/v1/namespaces
|
||||
```
|
||||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/namespaces?prefix=prod
|
||||
https://localhost:4646/v1/namespaces?prefix=prod
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -89,7 +89,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/namespace/api-prod
|
||||
https://localhost:4646/v1/namespace/api-prod
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -143,14 +143,14 @@ The table below shows this endpoint's support for
|
|||
$ curl \
|
||||
--request POST \
|
||||
--data @namespace.json \
|
||||
https://nomad.rocks/v1/namespace/api-prod
|
||||
https://localhost:4646/v1/namespace/api-prod
|
||||
```
|
||||
|
||||
```text
|
||||
$ curl \
|
||||
--request POST \
|
||||
--data @namespace.json \
|
||||
https://nomad.rocks/v1/namespace
|
||||
https://localhost:4646/v1/namespace
|
||||
```
|
||||
|
||||
## Delete Namespace
|
||||
|
|
@ -178,5 +178,5 @@ The table below shows this endpoint's support for
|
|||
```text
|
||||
$ curl \
|
||||
--request DELETE \
|
||||
https://nomad.rocks/v1/namespace/api-prod
|
||||
https://localhost:4646/v1/namespace/api-prod
|
||||
```
|
||||
|
|
|
|||
|
|
@ -35,12 +35,12 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/nodes
|
||||
https://localhost:4646/v1/nodes
|
||||
```
|
||||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/nodes?prefix=prod
|
||||
https://localhost:4646/v1/nodes?prefix=prod
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -87,7 +87,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/node/fb2170a8-257d-3c64-b14d-bc06cc94e34c
|
||||
https://localhost:4646/v1/node/fb2170a8-257d-3c64-b14d-bc06cc94e34c
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -189,7 +189,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/node/e02b6169-83bd-9df6-69bd-832765f333eb/allocations
|
||||
https://localhost:4646/v1/node/e02b6169-83bd-9df6-69bd-832765f333eb/allocations
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -538,7 +538,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/node/fb2170a8-257d-3c64-b14d-bc06cc94e34c/evaluate
|
||||
https://localhost:4646/v1/node/fb2170a8-257d-3c64-b14d-bc06cc94e34c/evaluate
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -598,7 +598,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
-XPOST https://nomad.rocks/v1/node/fb2170a8-257d-3c64-b14d-bc06cc94e34c/drain?enable=true
|
||||
-XPOST https://localhost:4646/v1/node/fb2170a8-257d-3c64-b14d-bc06cc94e34c/drain?enable=true
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -643,7 +643,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
-XPOST https://nomad.rocks/v1/node/fb2170a8-257d-3c64-b14d-bc06cc94e34c/purge
|
||||
-XPOST https://localhost:4646/v1/node/fb2170a8-257d-3c64-b14d-bc06cc94e34c/purge
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/operator/raft/configuration
|
||||
https://localhost:4646/v1/operator/raft/configuration
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -123,7 +123,7 @@ The table below shows this endpoint's support for
|
|||
```text
|
||||
$ curl \
|
||||
--request DELETE \
|
||||
https://nomad.rocks/v1/operator/raft/peer?address=1.2.3.4
|
||||
https://localhost:4646/v1/operator/raft/peer?address=1.2.3.4
|
||||
```
|
||||
|
||||
## Read Autopilot Configuration
|
||||
|
|
@ -157,7 +157,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/operator/autopilot/configuration
|
||||
https://localhost:4646/operator/autopilot/configuration
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -278,7 +278,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/operator/autopilot/health
|
||||
https://localhost:4646/v1/operator/autopilot/health
|
||||
```
|
||||
|
||||
### Sample response
|
||||
|
|
|
|||
|
|
@ -38,12 +38,12 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/quotas
|
||||
https://localhost:4646/v1/quotas
|
||||
```
|
||||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/quotas?prefix=sha
|
||||
https://localhost:4646/v1/quotas?prefix=sha
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -98,7 +98,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/quota/shared-quota
|
||||
https://localhost:4646/v1/quota/shared-quota
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -172,14 +172,14 @@ object](https://github.com/hashicorp/nomad/blob/master/api/quota.go#L100-L131).
|
|||
$ curl \
|
||||
--request POST \
|
||||
--data @spec.json \
|
||||
https://nomad.rocks/v1/quota/shared-quota
|
||||
https://localhost:4646/v1/quota/shared-quota
|
||||
```
|
||||
|
||||
```text
|
||||
$ curl \
|
||||
--request POST \
|
||||
--data @spec.json \
|
||||
https://nomad.rocks/v1/quota
|
||||
https://localhost:4646/v1/quota
|
||||
```
|
||||
|
||||
## Delete Quota Specification
|
||||
|
|
@ -208,7 +208,7 @@ The table below shows this endpoint's support for
|
|||
```text
|
||||
$ curl \
|
||||
--request DELETE \
|
||||
https://nomad.rocks/v1/quota/shared-quota
|
||||
https://localhost:4646/v1/quota/shared-quota
|
||||
```
|
||||
|
||||
## List Quota Usages
|
||||
|
|
@ -236,12 +236,12 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/quota-usages
|
||||
https://localhost:4646/v1/quota-usages
|
||||
```
|
||||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/quota-usages?prefix=sha
|
||||
https://localhost:4646/v1/quota-usages?prefix=sha
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -294,7 +294,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/quota/shared-quota
|
||||
https://localhost:4646/v1/quota/shared-quota
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/regions
|
||||
https://localhost:4646/v1/regions
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
|
|||
|
|
@ -54,7 +54,7 @@ job related results will not be returned. If the token is only valid for
|
|||
$ curl \
|
||||
--request POST \
|
||||
--data @payload.json \
|
||||
https://nomad.rocks/v1/search
|
||||
https://localhost:4646/v1/search
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -86,7 +86,7 @@ $ curl \
|
|||
$ curl \
|
||||
--request POST \
|
||||
--data @payload.json \
|
||||
https://nomad.rocks/v1/search
|
||||
https://localhost:4646/v1/search
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/sentinel/policies
|
||||
https://localhost:4646/v1/sentinel/policies
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -106,7 +106,7 @@ The table below shows this endpoint's support for
|
|||
$ curl \
|
||||
--request POST \
|
||||
--data @payload.json \
|
||||
https://nomad.rocks/v1/sentinel/policy/my-policy
|
||||
https://localhost:4646/v1/sentinel/policy/my-policy
|
||||
```
|
||||
|
||||
## Read Policy
|
||||
|
|
@ -131,7 +131,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/sentinel/policy/foo
|
||||
https://localhost:4646/v1/sentinel/policy/foo
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -175,6 +175,6 @@ The table below shows this endpoint's support for
|
|||
```text
|
||||
$ curl \
|
||||
--request DELETE \
|
||||
https://nomad.rocks/v1/sentinel/policy/foo
|
||||
https://localhost:4646/v1/sentinel/policy/foo
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/status/leader
|
||||
https://localhost:4646/v1/status/leader
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
@ -59,7 +59,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/status/peers
|
||||
https://localhost:4646/v1/status/peers
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ The table below shows this endpoint's support for
|
|||
```text
|
||||
$ curl \
|
||||
--request PUT \
|
||||
https://nomad.rocks/v1/system/gc
|
||||
https://localhost:4646/v1/system/gc
|
||||
```
|
||||
|
||||
## Reconcile Summaries
|
||||
|
|
@ -55,5 +55,5 @@ The table below shows this endpoint's support for
|
|||
|
||||
```text
|
||||
$ curl \
|
||||
https://nomad.rocks/v1/system/reconcile/summaries
|
||||
https://localhost:4646/v1/system/reconcile/summaries
|
||||
```
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@ There are no parameters, but the request _body_ contains the entire job file.
|
|||
$ curl \
|
||||
--request POST \
|
||||
--data @my-job.nomad \
|
||||
https://nomad.rocks/v1/validate/job
|
||||
https://localhost:4646/v1/validate/job
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
|
|
|||
|
|
@ -141,10 +141,10 @@ EOF
|
|||
$ curl --request POST \
|
||||
--data @payload.json \
|
||||
-H "X-Nomad-Token: $NOMAD_TOKEN" \
|
||||
https://nomad.rocks/v1/acl/policy/anonymous
|
||||
https://localhost:4646/v1/acl/policy/anonymous
|
||||
|
||||
# Verify anonymous request works
|
||||
$ curl https://nomad.rocks/v1/jobs
|
||||
$ curl https://localhost:4646/v1/jobs
|
||||
```
|
||||
|
||||
# Rule Specification
|
||||
|
|
|
|||
Loading…
Reference in a new issue