Get an endpoint

GET

/endpoints/{endpoint}

const url = 'https://example.com/api/v1/endpoints/boi.17c.415a.%24comp.display-1%2Fhttps';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/endpoints/boi.17c.415a.%24comp.display-1%2Fhttps

Fetches an endpoint by its address (/) or uuid. An endpoint whose component is out of the caller’s read scope is a non-disclosing 404, and a name no endpoint the caller can see answers to is a 404 naming what was looked up (listing each match when more than one does). Gated by endpoint:read.

Parameters

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

Responses

200

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

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

Error

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"
}