Overview
Policy Groups
- GETList active policy groups
- GETGet a policy group by ID
- GETGet version history for a policy group
- GETGet lifecycle event log for a policy group
- POSTCreate a policy group with Rego source
- POSTTransfer ownership of a policy group
- POSTEvaluate Rego source with test input (dry-run)
- PUTUpdate a policy group by creating a new version
- DELDisable a policy group
Policy Bindings
- GETList active policy bindings with optional filters
- GETList available group versions a binding can be upgraded to
- GETGet version history for a policy binding
- GETGet lifecycle event log for a policy binding
- GETGet all bindings that would apply to a specific agent execution, ordered by priority
- POSTCreate a policy binding
- POSTUpgrade a policy binding to a specific group version
- PUTReorder policy bindings
- DELDisable a policy binding
Webhooks
Channel JSON-RPC
HITL Approvals
Tasks
Push Notifications
User Subscriptions
Channels
Channel Subscriptions
Agents
Agent Subscriptions
Identity Providers
Groups
- GETList groups within a tenant
- GETGet group by ID
- GETList members of a group
- GETList all versions of a group (audit history)
- GETList groups a user belongs to
- POSTCreate a group
- POSTAdd users to a group
- PUTUpdate a group (creates new immutable version)
- DELArchive a group (soft delete)
- DELRemove a user from a group
Authentication
- GETDiscover available login methods for an email address
- GETGet current user's identity, groups, and effective permissions
- GETList all possible entity-permission combinations
- POSTAccept a user invite and set password
- POSTRequest a password reset email
- POSTLogin and obtain access token
- POSTRefresh access token
- POSTResend verification email
- POSTReset password using token
- POSTExchange SSO authorization code for tokens
- POSTVerify email address using token
Users
Audit Events
Audit Traces
Upgrade a policy binding to a specific group version
curl --request POST \
--url https://api.swarmd.ai/relay/v1/policy-bindings/{bindingId}/upgrade \
--header 'Authorization: Bearer <token>'{
"bindingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": "<string>",
"groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"groupName": "<string>",
"groupVersion": "<string>",
"isLatestGroupVersion": true,
"bindingLevel": "TENANT",
"agent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"sourceAgent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"sinkAgent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"priority": 123,
"validFrom": "2023-11-07T05:31:56Z",
"validTo": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
}Policy Bindings
Upgrade a policy binding to a specific group version
Security Requirements
| Auth Types | Entities | Permissions | Required Roles |
|---|---|---|---|
| USER | TENANT | WRITE | TENANT:WRITE |
POST
/
relay
/
v1
/
policy-bindings
/
{bindingId}
/
upgrade
Upgrade a policy binding to a specific group version
curl --request POST \
--url https://api.swarmd.ai/relay/v1/policy-bindings/{bindingId}/upgrade \
--header 'Authorization: Bearer <token>'{
"bindingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": "<string>",
"groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"groupName": "<string>",
"groupVersion": "<string>",
"isLatestGroupVersion": true,
"bindingLevel": "TENANT",
"agent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"sourceAgent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"sinkAgent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"priority": 123,
"validFrom": "2023-11-07T05:31:56Z",
"validTo": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
}Authorizations
JWT token (USER, AGENT, or SERVICE auth)
Path Parameters
Query Parameters
Response
200 - application/json
OK
Available options:
TENANT, AGENT, SUBSCRIPTION Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I