open-nomad/website/source/docs/http/allocs.html.md

layout	page_title	sidebar_current	description
http	HTTP API: /v1/allocations	docs-http-allocs	The '/1/allocations' endpoint is used to list the allocations.

/v1/allocations

The allocations endpoint is used to query the status of allocations. By default, the agent's local region is used; another region can be specified using the ?region= query parameter.

GET

Description

Lists all the allocations.

Method

GET

URL

`/v1/allocations`

Parameters

• prefix optional even-length Filter allocations based on an identifier prefix.

Blocking Queries

[Supported](/docs/http/index.html#blocking-queries)

Returns

```javascript
[
{
  "ID": "203266e5-e0d6-9486-5e05-397ed2b184af",
  "EvalID": "e68125ed-3fba-fb46-46cc-291addbc4455",
  "Name": "example.cache[0]",
  "NodeID": "e02b6169-83bd-9df6-69bd-832765f333eb",
  "JobID": "example",
  "TaskGroup": "cache",
  "DesiredStatus": "run",
  "DesiredDescription": ""
  "ClientDescription": "",
  "ClientStatus": "running",
  "TaskStates": {
    "redis": {
      "Events": [
        {
          "KillError": "",
          "Message": "",
          "Signal": 0,
          "ExitCode": 0,
          "DriverError": "",
          "Time": 1447806038427841000,
          "Type": "Started"
        }
      ],
      "State": "running"
    }
  },
  "CreateIndex": 7,
  "ModifyIndex": 9,
}
...
]
```