---
title: "List Secret Definitions"
method: GET
path: "/workspaces/{workspace_id}/secrets/definitions"
tags: ["secrets"]
---

# List Secret Definitions

`GET /workspaces/{workspace_id}/secrets/definitions`

## Request

- Base URL: `https://platform.tracecat.com/api`
- URL: `https://platform.tracecat.com/api/workspaces/{workspace_id}/secrets/definitions`
- Auth: one of:
  - API key in cookie `fastapiusersauth`
  - HTTP bearer

List aggregated secret definitions from the registry.

## Path parameters

- `workspace_id` string, uuid, required

## Response `200`

Successful Response

- SecretDefinition[]
  - `name` string, required
  - `keys` string[], required
  - `optional_keys` string[], nullable
  - `optional` boolean
  - `secret_type` 'custom' | 'ssh_key' | 'mtls' | 'ca_cert' | 'github_app': The type of a secret.
  - `actions` string[], required
  - `action_count` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/tracecat/apis/tracecat-api.md) - [All operations](https://skmtc.dev/tracecat/apis/tracecat-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tracecat/apis/tracecat-api/revisions/2efdda25045f?raw)