Get Secret By Name - Tracecat Docs

Error

A valid request URL is required to generate request examples

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "custom",
  "name": "<string>",
  "encrypted_keys": "<string>",
  "environment": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "tags": {},
  "source": "local",
  "store_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "remote_reference": "<string>",
  "remote_key_mapping": {
    "mode": "whole_string",
    "keys": [
      "<string>"
    ],
    "fields": [
      {
        "key": "<string>",
        "field": "<string>"
      }
    ]
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

/

workspaces

/

{workspace_id}

/

secrets

/

{secret_name}

Error

A valid request URL is required to generate request examples

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "custom",
  "name": "<string>",
  "encrypted_keys": "<string>",
  "environment": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "tags": {},
  "source": "local",
  "store_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "remote_reference": "<string>",
  "remote_key_mapping": {
    "mode": "whole_string",
    "keys": [
      "<string>"
    ],
    "fields": [
      {
        "key": "<string>",
        "field": "<string>"
      }
    ]
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

fastapiusersauth

string

cookie

required

Path Parameters

secret_name

string

required

workspace_id

string<uuid>

required

Response

Successful Response

Read schema for workspace-scoped secrets.

id

string<uuid>

required

type

enum<string>

required

The type of a secret.

Available options:

custom,

ssh_key,

mtls,

ca_cert,

github_app

name

string

required

encrypted_keys

file

required

environment

string

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

workspace_id

string<uuid>

required

description

string | null

tags

Tags · object | null

Show child attributes

source

enum<string>

default:local

Where a workspace secret's values live.

Available options:

local,

aws_secrets_manager

store_id

string<uuid> | null

remote_reference

string | null

remote_key_mapping

AwsSecretKeyMapping · object | null

Declares how a remote AWS secret value maps onto output keys.

whole_string maps the entire SecretString onto exactly one key. json maps selected top-level string fields onto declared keys.

Show child attributes