Skip to main content
PATCH
TypeScript SDK

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

projectId
string
required
Required string length: 1 - 255
snapshotId
string
required
Required string length: 1 - 255

Body

application/json
name
string | null

Rename the snapshot, or null to clear its name.

Maximum string length: 120
pinned
boolean

Pin the snapshot with true to retain it, or unpin with false. This is separate from user sidebar resource pins.

Response

Update a project snapshot

createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
id
string
required
Required string length: 1 - 255
isActive
boolean
required
name
string | null
required
pinnedAt
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
updatedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
automaticSizing
boolean
required
buildDurationMs
number | null
required
Required range: x >= 0
builtAt
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
cpu
integer | null
required
Required range: 0 < x <= 9007199254740991
diskSizeGb
number | null
required
Required range: x > 0
hasSetupScript
boolean | null
required
includesRepos
boolean | null
required
isKvm
boolean | null
required
memoryMb
integer | null
required
Required range: 0 < x <= 9007199254740991
projectId
string
required
Required string length: 1 - 255
rebuildOfSnapshotId
string | null
required
Required string length: 1 - 255
repositoryIds
string[] | null
required
Required string length: 1 - 255
setupScript
string | null
required
Maximum string length: 100000
size
enum<string> | null
required
Available options:
nano,
micro,
small,
medium,
large,
xl,
xxl,
ultra
sizeBytes
string | null
required
Pattern: ^\d+$
trigger
enum<string> | null
required
Available options:
manual,
scheduled,
rebuild,
manager_reconcile,
admin