Config
Read and write swarm configuration values — global, agent-scoped, and repo-scoped settings
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Query Parameters
scope?string
scopeId?string
includeSecrets?string
Value in
"true" | "false"Response Body
curl -X GET "http://localhost:3013/api/config"Empty
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X PUT "http://localhost:3013/api/config" \ -H "Content-Type: application/json" \ -d '{ "scope": "global", "key": "string" }'Empty
Empty
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
id*string
Response Body
curl -X DELETE "http://localhost:3013/api/config/string"Empty
Empty
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
id*string
Query Parameters
includeSecrets?string
Value in
"true" | "false"Response Body
curl -X GET "http://localhost:3013/api/config/string"Empty
Empty
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Query Parameters
keys*string
Length
1 <= lengthResponse Body
curl -X GET "http://localhost:3013/api/config/env-presence?keys=string"Empty
Empty
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X POST "http://localhost:3013/api/config/reload" \ -H "Content-Type: application/json" \ -d '{}'Empty
Empty
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Query Parameters
agentId?string
repoId?string
includeSecrets?string
Value in
"true" | "false"Response Body
curl -X GET "http://localhost:3013/api/config/resolved"Empty