Set or remove app secrets
Set or remove manifest-declared write-only secrets for one installed Agent app, then restart the Agent gateway environment. Workspace owner/admin permission is required.
API 2.7.0 · Published service contract ↗
Request
Base URL: https://app.sym.so/v1/workspaces/{workspace_id}
Authentication: bearer. Required scope: secrets:write.
POST /agents/{agent_id}/apps/{app_id}/secrets
Set or remove manifest-declared write-only secrets for one installed Agent app, then restart the Agent gateway environment. Workspace owner/admin permission is required.
| Parameter | Type | Description |
|---|---|---|
agent_idpath · required | string | Required agent_id path identifier. |
app_idpath · required | string | Required app_id path identifier. |
curl --fail-with-body -X POST "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/agents/$AGENT_ID/apps/$APP_ID/secrets" \
-H "Authorization: Bearer $SYM_WORKSPACE_API_KEY" \
-H "Content-Type: application/json" \
--data "{\"values\":{\"EXAMPLE_SERVICE_TOKEN\":\"<secret supplied at runtime>\"},\"unset\":[]}"{
"worker_id": "worker-example-001",
"org_id": "workspace_example",
"data": {
"profile_id": "agent_example",
"app_id": "research-console",
"declared_count": 1,
"configured_count": 1,
"missing_required": [],
"secrets": [
{
"name": "EXAMPLE_SERVICE_TOKEN",
"description": "Example provider access token",
"required": true,
"configured": true
}
],
"gateway_restart": {
"ok": true,
"service": "hermes-gateway-agent_example"
}
},
"ok": true
}Authorization
{
"type": "bearer",
"scope": "secrets:write",
"transport": "Authorization: Bearer <workspace_api_key>"
}Errors
| Status | Description |
|---|---|
| 400 | The request body or parameters are invalid. |
| 401 | The workspace API key is missing, invalid, expired, or revoked. |
| 403 | The key lacks the required scope or its owner no longer has permission. |
| 404 | The resource is missing or intentionally hidden by authorization. |
| 429 | The key exceeded its current rate limit. |
Usage notes
- Undeclared secret names are rejected.
- The response never echoes supplied values.