Update component metadata

PATCH

component

{id}

curl --request PATCH \
  --url https://{hostname}.gable.ai/v0/component/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "friendly_name": "<string>",
  "xgress_friendly_names": {}
}
'

{
  "success": true
}

Authorizations

X-API-KEY

string

header

required

Path Parameters

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

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

Show child attributes

Response

200 - application/json

Component updated successfully

success

boolean

Get all versions of a componentGet all versions of a component

⌘I

Update component metadata

curl --request PATCH \
  --url https://{hostname}.gable.ai/v0/component/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "friendly_name": "<string>",
  "xgress_friendly_names": {}
}
'

{
  "success": true
}