Freeze an agent — blocks all relay traffic to/from the agent

curl --request POST \
  --url https://api.swarmd.ai/registry/v1/kill-switches/agents/{agentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'

import requests

url = "https://api.swarmd.ai/registry/v1/kill-switches/agents/{agentId}"

payload = { "reason": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: '<string>'})
};

fetch('https://api.swarmd.ai/registry/v1/kill-switches/agents/{agentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.swarmd.ai/registry/v1/kill-switches/agents/{agentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.swarmd.ai/registry/v1/kill-switches/agents/{agentId}"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.swarmd.ai/registry/v1/kill-switches/agents/{agentId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.swarmd.ai/registry/v1/kill-switches/agents/{agentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scope": "<string>",
  "targetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "targetName": "<string>",
  "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reason": "<string>",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z"
}

Auth Types	Entities	Permissions	Required Roles
USER	REGISTRY	WRITE	REGISTRY:WRITE

POST

registry

kill-switches

agents

{agentId}

Freeze an agent — blocks all relay traffic to/from the agent

curl --request POST \
  --url https://api.swarmd.ai/registry/v1/kill-switches/agents/{agentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'

import requests

url = "https://api.swarmd.ai/registry/v1/kill-switches/agents/{agentId}"

payload = { "reason": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: '<string>'})
};

fetch('https://api.swarmd.ai/registry/v1/kill-switches/agents/{agentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.swarmd.ai/registry/v1/kill-switches/agents/{agentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.swarmd.ai/registry/v1/kill-switches/agents/{agentId}"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.swarmd.ai/registry/v1/kill-switches/agents/{agentId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.swarmd.ai/registry/v1/kill-switches/agents/{agentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scope": "<string>",
  "targetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "targetName": "<string>",
  "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reason": "<string>",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

JWT token (USER, AGENT, or SERVICE auth)

Path Parameters

agentId

string<uuid>

required

Body

application/json

reason

string

Maximum string length: 500

Response

200 - */*

string<uuid>

scope

string

targetId

string<uuid>

targetName

string

tenantId

string<uuid>

reason

string

createdBy

string<uuid>

createdAt

string<date-time>

Overview

Policy Groups

Policy Bindings

Webhooks

Human JSON-RPC

Channel JSON-RPC

HITL Approvals

Agent JSON-RPC

Tasks

Push Notifications

Messaging

Conversations

Agent Discovery

User Subscriptions

MCP Servers

Kill Switches

Channels

Channel Subscriptions

Agents

Agent Subscriptions

Marketplace

Identity Providers

Groups

Authentication

Users

Tenants

Audit Integrity

Audit Events

Audit Traces

A2A Payments

Freeze an agent — blocks all relay traffic to/from the agent

Authorizations

Path Parameters

Body

Response