Skip to content
StratumStratum Docs

List a project's secrets.

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

One page of the project’s live secrets (metadata only, never a value). Keyset-paginated on (name, id); nextPageToken is present whenever more rows exist. A secret scheduled for deletion is listed only with include_deleted=true (AWS IncludePlannedDeletion) it carries deletionScheduledAt, and POST …/restore brings it back. Cedar-gated on secrets:ListSecrets.

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”
include_deleted
boolean

Also list secrets scheduled for deletion (recovery window), so a “pending deletion” view can offer restore.

limit
integer
default: 100 >= 1 <= 500
page_token
string

Opaque cursor from a previous response’s nextPageToken. Omit for the first page.

Responses

Section titled “Responses”

200

Section titled “200”

Secrets.

Media typeapplication/json

A page of a project’s live secrets, ordered name ASC, id ASC — the id is the tiebreaker that makes the order total.

object
items
required
Array<object>

A customer secret’s metadata. The value is never on this shape; it is returned only by GET.../secrets/{secretId}/value (secrets:GetSecretValue, a distinct permission from describing the secret).

object
id
required

s-<base32>; minted fresh per incarnation.

string
arn
required

arn:stratum:secrets:<region>:<projectId>:secret/<id>. The resource segment is the id, so the ARN changes when a secret is deleted and recreated under the same name — a policy that named the old one no longer matches. This is the ARN a resource policy targets for a cross-project share (PUT /v1/iam/resource-policies?resourceArn=).

string
projectId
required
string
name
required

Customer-chosen, 1–256 characters of letters, digits and /_+=.@-; unique per project among secrets that still exist (a soft-deleted secret keeps its name reserved until purged,).

string
description
string
region
required

logical region; a secret is regional.

string
recoveryWindowDays
required

Default recovery window a delete uses, 7–30 (AWS parity).

integer
tags
object
key
additional properties
string
deletionScheduledAt

Present when the secret is soft-deleted: the instant after which the reconciler purges it. Only POST.../restore sees such a secret; every other operation answers 404.

string format: date-time
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
createdBy
string
nextPageToken

Opaque cursor for the next page. Present when more rows exist; absent on the last page. Pass it back as page_token.

string

Example generated

{
  "items": [
    {
      "id": "example",
      "arn": "example",
      "projectId": "example",
      "name": "example",
      "description": "example",
      "region": "example",
      "recoveryWindowDays": 1,
      "tags": {
        "additionalProperty": "example"
      },
      "deletionScheduledAt": "2026-04-15T12:00:00Z",
      "createdAt": "2026-04-15T12:00:00Z",
      "updatedAt": "2026-04-15T12:00:00Z",
      "createdBy": "example"
    }
  ],
  "nextPageToken": "example"
}

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"
    }
  ]
}