Meta
This reads the daemon’s version and its API version:
curl --unix-socket /var/lib/shard/shard.sock http://localhost/v0/versionEvery route on this page accepts any valid token.
Each route answers an error with the Error body, unless its responses say otherwise.
Read the daemon and API versions
Section titled “Read the daemon and API versions”GET /v0/version · scope any token
Responses
| Status | Body |
|---|---|
| 200 | VersionResponse as application/json |
List the lifecycle verbs and whether this server supports each
Section titled “List the lifecycle verbs and whether this server supports each”GET /v0/capabilities · scope any token
Responses
| Status | Body |
|---|---|
| 200 | Capabilities as application/json |
List the scopes a token can carry
Section titled “List the scopes a token can carry”GET /v0/scopes · scope any token
Responses
| Status | Body |
|---|---|
| 200 | ScopesResponse as application/json |
Objects
Section titled “Objects”Capabilities
Section titled “Capabilities”| Field | Type | Required |
|---|---|---|
create |
boolean | yes |
fork |
boolean | yes |
pause |
boolean | yes |
port |
boolean | yes |
remove |
boolean | yes |
resume |
boolean | yes |
snapshot |
boolean | yes |
start |
boolean | yes |
stop |
boolean | yes |
swap |
boolean | yes |
| Field | Type | Required |
|---|---|---|
description |
string | yes |
name |
string | yes |
ScopesResponse
Section titled “ScopesResponse”| Field | Type | Required |
|---|---|---|
scopes |
array of Scope | yes |
VersionResponse
Section titled “VersionResponse”| Field | Type | Required |
|---|---|---|
api_version |
string | yes |
version |
string | yes |