Evaluations HTTP API
The /evaluation
endpoints are used to query for and interact with evaluations.
List Evaluations
This endpoint lists all evaluations.
Method | Path | Produces |
---|---|---|
GET | /v1/evaluations | application/json |
The table below shows this endpoint's support for blocking queries and required ACLs.
Blocking Queries | ACL Required |
---|---|
YES | namespace:read-job |
Parameters
prefix
(string: "")
- Specifies a string to filter evaluations based on an ID prefix. Because the value is decoded to bytes, the prefix must have an even number of hexadecimal characters (0-9a-f). This is specified as a query string parameter.next_token
(string: "")
- This endpoint supports paging. Thenext_token
parameter accepts a string which is theID
field of the next expected evaluation. This value can be obtained from theX-Nomad-NextToken
header from the previous response.per_page
(int: 0)
- Specifies a maximum number of evaluations to return for this request. If omitted, the response is not paginated. TheID
of the last evaluation in the response can be used as thelast_token
of the next request to fetch additional pages.job
(string: "")
- Filter the list of evaluations to a specific job ID.status
(string: "")
- Filter the list of evaluations to a specific evaluation status (one ofblocked
,pending
,complete
,failed
, orcanceled
).namespace
(string: "default")
- Specifies the target namespace. Specifying*
will return all evaluations across all authorized namespaces.
Sample Request
Sample Response
Read Evaluation
This endpoint reads information about a specific evaluation by ID.
Method | Path | Produces |
---|---|---|
GET | /v1/evaluation/:eval_id | application/json |
The table below shows this endpoint's support for blocking queries and required ACLs.
Blocking Queries | ACL Required |
---|---|
YES | namespace:read-job |
Parameters
:eval_id
(string: <required>)
- Specifies the UUID of the evaluation. This must be the full UUID, not the short 8-character one. This is specified as part of the path.
Sample Request
Sample Response
List Allocations for Evaluation
This endpoint lists the allocations created or modified for the given evaluation.
Method | Path | Produces |
---|---|---|
GET | /v1/evaluation/:eval_id/allocations | application/json |
The table below shows this endpoint's support for blocking queries and required ACLs.
Blocking Queries | ACL Required |
---|---|
YES | namespace:read-job |
Parameters
:eval_id
(string: <required>)
- Specifies the UUID of the evaluation. This must be the full UUID, not the short 8-character one. This is specified as part of the path.
Sample Request
Sample Response