Skip to main content
PATCH
Update component metadata

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string<uuid>
required

UUID of the component

Body

application/json
friendly_name
string

User-defined friendly name for the component. Pass empty string to remove.

xgress_friendly_names
object | null

Map of boundary ID to friendly name. Pass null value to remove a friendly name.

Response

200 - application/json

Component updated successfully

success
boolean