Overview
Policy Groups
Policy Bindings
Policies
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
Subscribe a channel to an agent
curl --request POST \
--url https://api.swarmd.ai/registry/v1/channels/{channelId}/subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sinkAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'{
"subscriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sinkAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sinkAgentName": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}Channel Subscriptions
Subscribe a channel to an agent
Security Requirements
| Auth Types | Entities | Permissions | Required Roles |
|---|---|---|---|
| USER | CHANNELS | WRITE | CHANNELS:WRITE |
POST
/
registry
/
v1
/
channels
/
{channelId}
/
subscriptions
Subscribe a channel to an agent
curl --request POST \
--url https://api.swarmd.ai/registry/v1/channels/{channelId}/subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sinkAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'{
"subscriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sinkAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sinkAgentName": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}Authorizations
JWT token (USER, AGENT, or SERVICE auth)
Path Parameters
Body
application/json
⌘I