For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
User GuideDeveloper GuidesAPI Reference
User GuideDeveloper GuidesAPI Reference
    • Overview
  • Runtype API
      • GETList secrets (metadata only)
      • POSTCreate a secret
      • GETGet secret metadata
      • PUTUpdate or rotate a secret
      • DELDelete a secret
      • POSTCheck which secret keys exist, are missing, or revoked
      • POSTGet intake manifest for secret configuration
      • POSTSubmit secret values from intake screen
      • POSTGenerate dashboard URL for configuring missing secrets
Dashboard
LogoLogo
Runtype APISecrets

Create a secret

POST
/v1/secrets
POST
/v1/secrets
$curl -X POST https://api.runtype.com/v1/secrets \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "key": "database_password"
>}'
1{
2  "data": {
3    "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef56gh78",
4    "key": "database_password",
5    "description": "Primary database password for production environment",
6    "valuePreview": "********",
7    "status": "active",
8    "version": 1,
9    "lastRotatedAt": "2024-05-20T10:15:30Z",
10    "phantomToken": "phantom_1234567890abcdef",
11    "createdAt": "2024-05-01T08:00:00Z",
12    "updatedAt": "2024-05-20T10:15:30Z"
13  }
14}
Was this page helpful?
Previous

Get secret metadata

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Request

This endpoint expects an object.
keystringRequired2-100 characters
valuestringOptional8-10000 characters
descriptionstringOptional<=500 characters

Response

Secret created
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
500
Internal Server Error