Skip to content

Commit

Permalink
Document usage of 'body' field
Browse files Browse the repository at this point in the history
  • Loading branch information
nick96 committed Mar 18, 2021
1 parent 7375ec7 commit 5da3a70
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions website/content/api-docs/json-jobs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -497,6 +497,8 @@ The `Task` object supports the following keys:

- `Method`: The HTTP method to use for HTTP checks. Defaults to GET.

- `Body`: The HTTP body to use for HTTP checks. Defaults to an empty string.

- `Path`: The path of the HTTP endpoint which Consul will query to query
the health of a service if the type of the check is `http`. Nomad
will add the IP of the service and the port, users are only required
Expand Down
2 changes: 2 additions & 0 deletions website/content/docs/job-specification/service.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,8 @@ scripts.
- `method` `(string: "GET")` - Specifies the HTTP method to use for HTTP
checks.

- `body` `(string: "")` - Specifies the HTTP body to use for HTTP checks.

- `name` `(string: "service: <name> check")` - Specifies the name of the health
check. If the name is not specified Nomad generates one based on the service name.
If you have more than one check you must specify the name.
Expand Down

0 comments on commit 5da3a70

Please sign in to comment.