Skip to main content
GET
/
secrets
/
search
Search Secrets
curl --request GET \
  --url https://api.example.com/secrets/search \
  --cookie fastapiusersauth=
[
  {
    "id": "<string>",
    "type": "custom",
    "name": "<string>",
    "encrypted_keys": "<string>",
    "environment": "<string>",
    "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "tags": {}
  }
]

Authorizations

​
fastapiusersauth
string
cookie
required

Query Parameters

​
environment
string
required
​
name
string[] | null

Filter by secret name

​
id
string[] | null

Filter by secret ID

Pattern: secret-[0-9a-f]{32}
​
type
enum<string>[] | null

Filter by secret type

The type of a secret.

Available options:
custom,
ssh-key,
mtls,
ca-cert
​
workspace_id
string<uuid>
required

Response

Successful Response

​
id
string
required
​
type
enum<string>
required

The type of a secret.

Available options:
custom,
ssh-key,
mtls,
ca-cert
​
name
string
required
​
encrypted_keys
file
required
​
environment
string
required
​
owner_id
string<uuid>
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
description
string | null
​
tags
Tags · object