Skip to main content
POST
Create a new cross-service edge.

Authorizations

X-API-KEY
string
header
required

Query Parameters

namespace
string

Optional namespace to scope the new edge.

Body

application/json

A cross-service edge connecting two components. This schema is used for both read (GET) and write (POST/PUT) operations to enable round-trip editing. Fields marked readOnly are returned by GET but ignored on POST/PUT. Fields marked writeOnly are accepted on POST/PUT but not returned in GET.

source
object
required

One side (source or destination) of a cross-service edge.

destination
object
required

One side (source or destination) of a cross-service edge.

field_mappings
object[]
required

Field-level mappings captured on this edge.

Minimum array length: 1
namespace
string

The namespace this edge belongs to.

reason
string
write-only

Optional reason for creating or updating this edge (stored in audit trail, not returned in GET).

Response

Edge created successfully

edge
object
required

A cross-service edge connecting two components. This schema is used for both read (GET) and write (POST/PUT) operations to enable round-trip editing. Fields marked readOnly are returned by GET but ignored on POST/PUT. Fields marked writeOnly are accepted on POST/PUT but not returned in GET.