Skip to content
Omniglass Omniglass Omniglass

Update an endpoint

PATCH
/endpoints/{endpoint}
 
curl --request PATCH \
  --url https://example.com/api/v1/endpoints/boi.17c.415a.%24comp.display-1%2Fhttps \
  --header 'Content-Type: application/json' \
  --data '{ "inputs": { "additionalProperty": "example" }, "label": "example", "node": "example", "params": "example", "transport": "example" }'

Patches an endpoint’s node placement, params, label, or (driver-attached) its connection inputs in place: the host, port and attached secret references, validated against the driver’s declared inputs, the endpoint’s tasks re-derived in the same transaction. A value the driver refuses is a 400 naming the field. An empty label clears it and the surface falls back to the derived name. Gated by endpoint:update; read and update scopes (through the component) drive the 404 versus 403 split.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
endpoint
required

The endpoint, as / (the component by name, dotted address or uuid) or by its uuid. The slash is percent-encoded in a URL, as the CLI does

string

The endpoint, as / (the component by name, dotted address or uuid) or by its uuid. The slash is percent-encoded in a URL, as the CLI does

Request Body required

Section titled “Request Body required ”
Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
inputs

A driver-attached endpoint’s inputs, edited in place (#1061): the host, the port, an attached secret’s reference name, any input the driver declares. Merged over the stored inputs and validated against the driver; a value it refuses is a 400 naming the input. Changing where a credential is sent needs the caller to be able to use that credential

object
key
additional properties
string
label

A new label; an empty string clears it, and the surface falls back to the derived name. Omit to leave it alone

string
<= 200 characters
node

Reassign the node placement, by name or id

string
params

Replace the address/target settings (jsonb). On a driver-attached endpoint only the timeout is set here: its address derives from its host and port inputs

transport

The transport: a driver-attached endpoint takes only one its driver speaks

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
component

The owning component name; absent for a server-hosted endpoint

string
component_id

The owning component’s id; the stable form of component

string
driver

The driver this endpoint was attached through (#813); absent for a bare probe endpoint

string
driver_id

The attached driver’s id; the stable form of driver

string
id
required

The endpoint’s uuid, the stable handle; / is the address an operator types

string
inputs

The effective inputs supplied at attach, defaults baked; secret inputs are reference names, never values

label

The friendly string an operator reads, and the only identity string an operator types here: the name is derived from the transport. Absent when unset, and a surface with none renders the name verbatim

string
name
required

The derived name (its transport), unique within the owning component

string
node

The node placement name, if assigned

string
node_id

The placed node’s id; the stable form of node

string
params

The address/target settings (jsonb)

transport
required

The transport name (the wire this endpoint speaks over), from the code registry

string
Example 
{
  "$schema": "/api/v1/schemas/EndpointBody.json"
}

default

Section titled “default ”

Error

Media type application/problem+json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank
Example 
{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}