Skip to content

Update Processing Node

PUT
/processingnodes/{id}/
id
required
integer

A unique integer value identifying this Processing Node.

object
id
ID
integer
online
Online
string
label
Label
string
hostname
required
Hostname

Hostname or IP address where the node is located (can be an internal hostname as well). If you are using Docker, this is never 127.0.0.1 or localhost. Find the IP address of your host machine by running ifconfig on Linux or by checking your network settings.

string
>= 1 characters <= 255 characters
port
required
Port

Port that connects to the node’s API

integer
<= 2147483647
api_version
API Version

API version used by the node

string
>= 1 characters <= 32 characters
last_refreshed
Last Refreshed

When was the information about this node last retrieved?

string format: date-time
queue_count
Queue Count

Number of tasks currently being processed by this node (as reported by the node itself)

integer
<= 2147483647
available_options
Available Options

Description of the options that can be used for processing

object
token
Token

Token to use for authentication. If the node doesn’t have authentication, you can leave this field blank.

string
<= 1024 characters
max_images
Max Images

Maximum number of images accepted by this node.

integer
<= 2147483647
engine_version
Engine Version

Engine version used by the node.

string
>= 1 characters <= 32 characters
engine
Engine

Engine used by the node.

string
>= 1 characters <= 255 characters
object
id
ID
integer
online
Online
string
label
Label
string
hostname
required
Hostname

Hostname or IP address where the node is located (can be an internal hostname as well). If you are using Docker, this is never 127.0.0.1 or localhost. Find the IP address of your host machine by running ifconfig on Linux or by checking your network settings.

string
>= 1 characters <= 255 characters
port
required
Port

Port that connects to the node’s API

integer
<= 2147483647
api_version
API Version

API version used by the node

string
>= 1 characters <= 32 characters
last_refreshed
Last Refreshed

When was the information about this node last retrieved?

string format: date-time
queue_count
Queue Count

Number of tasks currently being processed by this node (as reported by the node itself)

integer
<= 2147483647
available_options
Available Options

Description of the options that can be used for processing

object
token
Token

Token to use for authentication. If the node doesn’t have authentication, you can leave this field blank.

string
<= 1024 characters
max_images
Max Images

Maximum number of images accepted by this node.

integer
<= 2147483647
engine_version
Engine Version

Engine version used by the node.

string
>= 1 characters <= 32 characters
engine
Engine

Engine used by the node.

string
>= 1 characters <= 255 characters