Skip to content
Aura

Rename Snapshot

PATCH
/api/v1/projects/{project_id}/snapshots/{snapshot_id}
curl --request PATCH \
  --url https://aura.strangeworks.com/api/v1/projects/example/snapshots/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "label": "example" }'

Set or clear a snapshot’s label.

A label doubles as a pin: labeled snapshots are exempt from retention pruning (see snapshot_service.select_expired_snapshots).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
project_id
required
Project Id
string
snapshot_id
required
Snapshot Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
UpdateSnapshotRequest

Rename a snapshot. A blank/whitespace label clears back to the positional default.

label is required (nullable): an omitted field 422s rather than being read as “clear” — clearing also unpins retention, so it must be explicit.

object
label
required
Any of:
string
<= 255 characters
Examplegenerated
{
  "label": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
SnapshotResponse

Metadata for a single workspace snapshot (list view).

Built from the Snapshot ORM object via model_validate; solution_summary is read from the model’s like-named property (the linked execution’s summary), so the execution relationship must be eager-loaded.

object
conversation_id
Any of:
string
created_at
required
Created At
string format: date-time
execution_id
Any of:
string
file_count
required
File Count
integer
id
required
Id
string
kind
SnapshotKind
string
default: solve
Allowed values: solve manual
label
Any of:
string
parent_snapshot_id
Any of:
string
project_id
required
Project Id
string
solution_path
Any of:
string
solution_summary
Any of:
string
tags
Tags
Array<string>
default:
total_size_bytes
required
Total Size Bytes
integer
Example
{
  "kind": "solve",
  "tags": []
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}