Skip to content
StratumStratum Docs

List a project's database snapshots.

GET
/v1/projects/{projectId}/db/snapshots
Code sample: Shell / cURL
curl --request GET \
  --url 'https://stratum.example.com/v1/projects/example/db/snapshots?type=manual&limit=100' \
  --header 'Authorization: Bearer <token>'

Keyset-paginated on (name, id); optionally one instance’s and one type’s. Cedar-gated on db:ListDBSnapshots.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string
/^p-[a-z0-9-]+$/

Query Parameters

Section titled “Query Parameters”
dbInstanceId
string
type
string
Allowed values: manual automated
limit
integer
default: 100 >= 1 <= 500
page_token
string

Responses

Section titled “Responses”

200

Section titled “200”

Snapshots.

Media typeapplication/json
object
items
required
Array<object>

A consistent point of a database instance: a snapshot of the data volume taken while the engine held a backup open, plus the WAL range that makes it consistent. manual snapshots live until deleted; automated ones are taken daily in the backup window and expire with the retention.

object
id
required
string
/^dbsnap-[a-z0-9]+$/
arn
required
string
projectId
required
string
name
required
string
dbInstanceId
required

The source instance; kept after the source is gone.

string
dbInstanceName
required
string
type
required
string
Allowed values: manual automated
status
required
string
Allowed values: creating available deleting failed
statusReason

What the snapshot waits on, or why it failed.

string
nullable
engine
required
string
engineVersion
required
string
instanceClass
required
string
allocatedStorage
required

GiB.

integer
storageClass
required
string
storageEncrypted
required
boolean
masterUsername
required
string
dbSubnetGroupName
required
string
dbParameterGroupName
required
string
vpcId
string
availabilityZone
string
snapshotTime
required

The consistent point — when the engine closed the backup. Null while creating.

string format: date-time
nullable
expiresAt

Automated snapshots only — snapshotTime plus the instance’s backupRetentionPeriod.

string format: date-time
nullable
tags
required
object
key
additional properties
string
createdBy
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
nextPageToken
string

Example 

{
  "items": [
    {
      "type": "manual",
      "status": "creating"
    }
  ]
}

400

Section titled “400”

Bad request.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example 

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}

403

Section titled “403”

Authenticated but not authorized.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example 

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}