Secrets

Secrets represent sensitive information securely stored by Metorial. Secrets are automatically created by Metorial, for example for server deployment configurations.

Secrets object

Attributes

items

Object
{
  "items": {
    "0": {
      "object": "secret",
      "status": "active",
      "type": {},
      "description": "This is a secret",
      "metadata": {},
      "fingerprint": "1234567890abcdef"
    },
    "object": "example_object",
    "id": "example_id",
    "status": "",
    "type": {
      "identifier": "example_identifier",
      "name": "example_name"
    },
    "description": "example_description",
    "metadata": "example_metadata",
    "organization_id": "example_organization_id",
    "instance_id": "example_instance_id",
    "fingerprint": "example_fingerprint",
    "last_used_at": "2025-10-15T16:41:26.546Z",
    "created_at": "2025-10-15T16:41:26.546Z"
  },
  "pagination": {
    "has_more_before": false,
    "has_more_after": false
  }
}

List secrets

Returns a paginated list of secrets for the instance, optionally filtered by type or status.

Query Parameters

limit

NumberOptional

after

StringOptional

before

StringOptional

cursor

StringOptional

order

EnumOptional

type

UnionOptional

status

UnionOptional
GEThttp://api.metorial.com/secrets
curl -X GET "https://api.metorial.com/secrets" \
  -H "Authorization: Bearer metorial_sk_..."

Get secret by ID

Retrieves detailed information about a specific secret by ID.

URL Parameters

secret_id

String

The unique identifier for the secret

GEThttp://api.metorial.com/secrets/:secret_id
curl -X GET "https://api.metorial.com/secrets/sec_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."