Sign in

v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB
Components Settings

Add component to setting

Adds a component reference to the specified socket-type setting.

post/v1/components/{component_id}/settings/{setting_name}/add-component

Path parameters

component_idstring required
setting_namestring required

Request body

source_component_idstring required

Example request

{
  "component_display_name": "handlebars@buildtime:{{componentDisplayName}}",
  "settings": [
    {
      "priority": "10",
      "description": "handlebars@buildtime:{{description}}"
    }
  ]
}

Response

Successful response

component_idsstring[] required
created_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

descriptionstring required
idstring required
installed_into_socketstring required
namestring required
tagsstring[] required
typestring required
typesstring[] required
updated_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

upload_versionstring required
versioninteger required

Example response

{
  "created_date": "2025-10-24T02:00:00-07:00",
  "display_name": "handlebars@buildtime:{{displayName}}",
  "install": "handlebars@installtime:{{install}}",
  "updated_date": "2025-10-24T02:00:00-07:00",
  "variables": [
    {
      "description": "handlebars@buildtime:{{description}}",
      "priority": "10",
      "values": {
        "default": "handlebars@buildtime:{{default}}",
        "en": "handlebars@buildtime:{{en}}"
      }
    }
  ]
}