TRtracecat
secrets

Get Secret By Name

Get a secret.

get/workspaces/{workspace_id}/secrets/{secret_name}

Request

  • Base URL
    https://platform.tracecat.com/api
  • Auth
    • API key in cookie fastapiusersauth
    • or HTTP bearer

Path parameters

secret_namestring required
workspace_idstring uuid required

Response

Successful Response

idstring uuid required
type'custom' | 'ssh_key' | 'mtls' | 'ca_cert' | 'github_app' required

The type of a secret.

namestring required
descriptionstring nullable
encrypted_keysstring binary required
environmentstring required
tagsobject nullable
created_atstring date-time required
updated_atstring date-time required
workspace_idstring uuid required
source'local' | 'aws_secrets_manager'

Where a workspace secret's values live.

store_idstring uuid nullable
remote_referencestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.