Merge-patch managed linkage

PATCH

/v1/ns/{nsid}/resources/linkages/{peer}

curl --request PATCH \
  --url https://example.com/v1/ns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/resources/linkages/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "allow_inbound": true, "inbound_transfer_context": "example", "outbound_transfer_context": "example", "caller_id_mode": "fixed", "inbound_caller_id_context": "example", "outbound_caller_id_context": "example", "allowed_caller_ids": [ "example" ], "primary_caller_id": "example", "present_external_caller_id": true, "attestation_mode": "A", "resign_policy": "passthrough", "transmit_passport": "transmit-full", "inheritance": { "profile": "example", "granted_aliases": { "additionalProperty": "example" }, "max_concurrent_calls": 1, "permitted_edge_ips": [ "example" ], "permitted_sip_realms": [ "example" ] }, "clear_inheritance": true }'

Authorizations

• bearerAuth

Parameters

Path Parameters

nsid

required

string format: uuid

Namespace UUID

peer

required

string

Request Body^required

Media typeapplication/json

Merge-patch; omitted fields are no-ops

object

allow_inbound

boolean

inbound_transfer_context

string

outbound_transfer_context

string

caller_id_mode

string

Allowed values: fixed provided modify

inbound_caller_id_context

string

outbound_caller_id_context

string

allowed_caller_ids

Array<string>

primary_caller_id

string

present_external_caller_id

boolean

attestation_mode

string

Allowed values: A B C

resign_policy

string

Allowed values: passthrough passthrough-block resign keep-sign

transmit_passport

string

Allowed values: transmit-full transmit-verstat strip

inheritance

object

profile

string

granted_aliases

object

key

additional properties

string

max_concurrent_calls

integer

permitted_edge_ips

Edge-proxy values (exact host/IP or CIDR) a child may use. Empty means the parent imposes no restriction. Composed with the partition’s own allow-list; a parent can narrow, never widen.

Array<string>

permitted_sip_realms

SIP realms a child may use; each entry permits that realm and any subdomain of it. Empty means no parent restriction.

Array<string>

clear_inheritance

Set true to remove the inheritance block. A present inheritance object replaces the block wholesale; a null/omitted one is a no-op, so this flag is the only way to clear it.

boolean

Responses

200

OK

Media typeapplication/json

object

success

required

boolean

Example

{
  "success": true
}

default

Error response

Media typeapplication/problem+json

RFC 7807 Problem Details

object

type

Problem type slug URI

string

title

string

status

integer

detail

string

key

additional properties

any

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}