Update Runner

Update Runner

curl --request PUT \
  --url https://api.comfycontrol.app/v1/runner/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "endpoint": "<string>",
  "headers": {},
  "tags": [
    "<string>"
  ],
  "status": "<string>"
}
'

import requests

url = "https://api.comfycontrol.app/v1/runner/{id}"

payload = {
    "name": "<string>",
    "endpoint": "<string>",
    "headers": {},
    "tags": ["<string>"],
    "status": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    endpoint: '<string>',
    headers: {},
    tags: ['<string>'],
    status: '<string>'
  })
};

fetch('https://api.comfycontrol.app/v1/runner/{id}', 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.comfycontrol.app/v1/runner/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'endpoint' => '<string>',
    'headers' => [
        
    ],
    'tags' => [
        '<string>'
    ],
    'status' => '<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.comfycontrol.app/v1/runner/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"headers\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"status\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.comfycontrol.app/v1/runner/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"headers\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"status\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.comfycontrol.app/v1/runner/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"headers\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"status\": \"<string>\"\n}"

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

{
  "400": {},
  "401": {},
  "404": {},
  "id": "<string>",
  "user_id": "<string>",
  "name": "<string>",
  "status": "<string>",
  "endpoint": "<string>",
  "tags": [
    "<string>"
  ],
  "headers": {},
  "created_at": "<string>",
  "updated_at": "<string>"
}

PUT

runner

{id}

Update Runner

curl --request PUT \
  --url https://api.comfycontrol.app/v1/runner/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "endpoint": "<string>",
  "headers": {},
  "tags": [
    "<string>"
  ],
  "status": "<string>"
}
'

import requests

url = "https://api.comfycontrol.app/v1/runner/{id}"

payload = {
    "name": "<string>",
    "endpoint": "<string>",
    "headers": {},
    "tags": ["<string>"],
    "status": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    endpoint: '<string>',
    headers: {},
    tags: ['<string>'],
    status: '<string>'
  })
};

fetch('https://api.comfycontrol.app/v1/runner/{id}', 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.comfycontrol.app/v1/runner/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'endpoint' => '<string>',
    'headers' => [
        
    ],
    'tags' => [
        '<string>'
    ],
    'status' => '<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.comfycontrol.app/v1/runner/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"headers\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"status\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.comfycontrol.app/v1/runner/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"headers\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"status\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.comfycontrol.app/v1/runner/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"headers\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"status\": \"<string>\"\n}"

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

{
  "400": {},
  "401": {},
  "404": {},
  "id": "<string>",
  "user_id": "<string>",
  "name": "<string>",
  "status": "<string>",
  "endpoint": "<string>",
  "tags": [
    "<string>"
  ],
  "headers": {},
  "created_at": "<string>",
  "updated_at": "<string>"
}

Overview

Update the configuration of an existing runner. You can modify the name, endpoint URL, headers, tags, or status.

Path Parameters

string

required

The unique identifier (UUID) of the runner to update.

Request Body

string

A descriptive name for your runner (1-100 characters).

string

The URL where your ComfyUI instance is accessible. Must be a valid HTTP or HTTPS URL.Example: https://my-comfy.example.com or http://192.168.1.100:8188

object

Custom HTTP headers to include when communicating with your runner.Example: {"Authorization": "Bearer token123", "X-Custom-Header": "value"}

string[]

Array of tags for organizing and selecting runners (maximum 10 tags).Example: ["production", "gpu-a100", "image-generation"]

string

Status of the runner. Values: active, disabledUse disabled to temporarily prevent workflows from using this runner.

Response

string

required

Unique identifier (UUID) for the runner.

string

required

UUID of the user who owns this runner.

string

required

The runner’s name.

string

required

Current status of the runner. Values: active, disabled

string

required

The URL where the runner is accessible.

string[]

required

Array of tags associated with the runner.

object

required

The custom headers configured for this runner.

string

required

ISO 8601 timestamp when the runner was created.

string

required

ISO 8601 timestamp when the runner was last updated.

Example Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "name": "Production GPU Runner - Updated",
  "status": "active",
  "endpoint": "https://new-endpoint.example.com",
  "tags": ["production", "gpu-a100", "video-generation"],
  "headers": {
    "Authorization": "Bearer new_token"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-16T14:20:00Z"
}

Error Responses

error

Bad request - validation error in the request body.Common causes:

Name is empty or too long
Invalid endpoint URL format
Too many tags (max 10)
Invalid headers format
Invalid status value

error

Unauthorized - invalid or missing authentication token.

error

Not Found - runner with the specified ID does not exist or does not belong to your account.

Notes

All fields in the request body are optional - only include fields you want to update
Omitted fields will retain their current values
Setting status to disabled prevents workflows from using this runner
Tags are completely replaced, not merged - send all tags you want to keep

API Overview

Runners

Managed Runners

Workflows

Templates

User

Overview

Path Parameters

Request Body

Response

Example Response

Error Responses

Notes

​Overview

​Path Parameters

​Request Body

​Response

​Example Response

​Error Responses

​Notes

Overview

Path Parameters

Request Body

Response

Example Response

Error Responses

Notes