Snapshots

Snapshots of the project

GET /snapshots

Parameters

Name	In	Type	Required	Description
page	query	integer	No	(minimum 1, default 1)
per_page	query	integer	No	(minimum 1, maximum 100, default 25)
name	query	string	No	Exact name (maximum length 64)
label_selector	query	string	No	key, !key, key==v, key=v, key!=v, key in (a,b), key notin (a,b); comma-separated (and) (maximum length 1024)
sort	query	string	No	<field>:asc|desc; fields id, name, created; default created:desc (pattern ^(id|name|created):(asc|desc)$)
q	query	string	No	Every word must match, in any case: part of the name or server name, or label:key, label:key=value (minimum length 2, maximum length 100)
status	query	creating, available, deleting	No

Responses

Status	Description
200	Snapshots
401	No valid API key
403	The key's scope or the organization's subscription does not allow the request (forbidden), or a quota is exhausted (resource_limit_exceeded)
422	A field is missing or malformed (invalid_input, details.fields) or an Idempotency-Key was reused with a different request (idempotency_key_mismatch)
429	The key's allowance is used up

Response body

Field	Type	Required	Description
snapshots	array of Snapshot	Yes
meta	Meta	Yes

One snapshot

GET /snapshots/{id}

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes

Responses

Status	Description
200	The snapshot
401	No valid API key
404	No such resource in this project
429	The key's allowance is used up

Response body

Field	Type	Required	Description
snapshot	Snapshot	Yes

Rename or relabel a snapshot

PUT /snapshots/{id}

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes

Request body

Field	Type	Required	Description
name	string	No	1-64 printable characters without @ (minimum length 1, maximum length 64)
labels	map of string	No	At most 32 keys; keys and values of 1-63 (values may be empty) letters, digits, ., _, -, starting and ending with a letter or digit

Responses

Status	Description
200	The snapshot
401	No valid API key
403	The key's scope or the organization's subscription does not allow the request (forbidden), or a quota is exhausted (resource_limit_exceeded)
404	No such resource in this project
409	The request conflicts with the resource's state (conflict) or an Idempotency-Key is still being processed (idempotency_in_progress)
422	A field is missing or malformed (invalid_input, details.fields) or an Idempotency-Key was reused with a different request (idempotency_key_mismatch)
423	The resource has a running action
429	The key's allowance is used up

Response body

Field	Type	Required	Description
snapshot	Snapshot	Yes

Delete a snapshot

DELETE /snapshots/{id}

Releases the snapshot quota when the action succeeds.

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes

Responses

Status	Description
201	The action
401	No valid API key
403	The key's scope or the organization's subscription does not allow the request (forbidden), or a quota is exhausted (resource_limit_exceeded)
404	No such resource in this project
423	The resource has a running action
429	The key's allowance is used up

Response body

Field	Type	Required	Description
action	Action	Yes