API Reference
Auto-generated
Secrets
API reference for secrets endpoints.
Auto-generated
This page was generated from the OpenAPI spec. Run
make generate-docs to refresh after spec changes.POST /api/v1/secrets
POST
/api/v1/secretsCreate Secret
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | Required | Secret name (e.g. SLACK_TOKEN) |
| value | string | Required | Secret value (plaintext) |
| integration | string | Optional | integration |
| kind | "generic" | "site_login" | "profile_field" | "totp" | Optional | generic (workflow secret), site_login (domain-bound credential) or profile_field (résumé/profile value) for Hands fill_secret, or totp (base32 authenticator seed) for Hands fill_totp. Card data is never stored here.Default: generic |
| allowed_domains | string[] | Optional | allowed_domains |
Request Example
Bash
curl -X POST https://api.alterlab.io/api/v1/secrets \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "example_name",
"value": "example_value",
"kind": "..."
}'Response Example
JSON
{
"status": "ok"
}GET /api/v1/secrets
GET
/api/v1/secretsList Secrets
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| integration | string | Optional | integration |
Request Example
Bash
curl -X GET https://api.alterlab.io/api/v1/secrets \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"secrets": [],
"total": 0
}GET /api/v1/secrets/{secret_id}
GET
/api/v1/secrets/{secret_id}Get Secret
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| secret_id | string | Required | secret_id |
Request Example
Bash
curl -X GET https://api.alterlab.io/api/v1/secrets/<secret_id> \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"id": "example",
"name": "example",
"integration": "example",
"masked_value": "example",
"kind": "example",
"allowed_domains": "example"
}PUT /api/v1/secrets/{secret_id}
PUT
/api/v1/secrets/{secret_id}Update Secret
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| secret_id | string | Required | secret_id |
| value | string | Required | New secret value |
Request Example
Bash
curl -X PUT https://api.alterlab.io/api/v1/secrets/<secret_id> \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"value": "example_value"
}'Response Example
JSON
{
"id": "example",
"name": "example",
"integration": "example",
"masked_value": "example",
"kind": "example",
"allowed_domains": "example"
}DELETE /api/v1/secrets/{secret_id}
DELETE
/api/v1/secrets/{secret_id}Delete Secret
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| secret_id | string | Required | secret_id |
Request Example
Bash
curl -X DELETE https://api.alterlab.io/api/v1/secrets/<secret_id> \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"status": "ok"
}