---
title: "Create Aws Secret Reference"
method: POST
path: "/workspaces/{workspace_id}/secrets/aws"
tags: ["secrets"]
---

# Create Aws Secret Reference

`POST /workspaces/{workspace_id}/secrets/aws`

## Request

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

Create a custom secret whose values live in AWS Secrets Manager.

## Path parameters

- `workspace_id` string, uuid, required

## Request body

- AwsSecretReferenceCreate: Create a workspace custom secret backed by AWS Secrets Manager.
  - `name` string, required
  - `description` string, nullable
  - `environment` string
  - `tags` object, nullable
  - `store_id` string, uuid, required
  - `remote_reference` string, required
  - `key_mapping` AwsSecretKeyMapping, required: 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.
    - `mode` 'whole_string' | 'json', required: How an AWS Secrets Manager value maps onto declared secret keys.
    - `keys` string[]
    - `fields` AwsSecretJsonField[]
      - `key` string, required
      - `field` string, required

## Response `201`

Successful Response

- unknown

## 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)