Armon Dadgar ae336e5529 website: Alloc API docs

2015-09-20 17:59:57 -07:00

1.2 KiB

Raw Blame History

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

None

Returns

```javascript
[
{
    "ID": "3575ba9d-7a12-0c96-7b28-add168c67984",
    "EvalID": "151accaa-1ac6-90fe-d427-313e70ccbb88",
    "Name": "binstore-storagelocker.binsl[3]",
    "NodeID": "c9972143-861d-46e6-df73-1d8287bc3e66",
    "JobID": "binstore-storagelocker",
    "TaskGroup": "binsl",
    "DesiredStatus": "run",
    "DesiredDescription": "",
    "ClientStatus": "running",
    "ClientDescription": "",
    "CreateIndex": 16,
    "ModifyIndex": 16
},
...
]
```

1.2 KiB Raw Blame History

/v1/allocations

GET

1.2 KiB

Raw Blame History