Bindings

2 operations in the Adverity Connect API. Replace {{INSTANCE}} and {{KEY}} in the examples with your instance and API key. How authentication works.

List all target bindings

GET/api/v1/bindings/

API key permissionDestination: Read-onlydestination:read

Retrieve all target bindings (datastream-to-destination mappings) accessible within the workspace hierarchy. Filter by datastream_id or target_id to find specific bindings.

Query parameters

• datastream_idinteger
• target_idinteger
• pageinteger

  Default 1 · Min 1

• page_sizeinteger

  Default 50 · Min 1

Responses

200OKapplication/json

Response schema

object PagedBindingResponseSchema

• itemsarray of objectrequired
  Items · BindingResponseSchema

  • idintegerrequired
  • datastream_idintegerrequired
  • target_idintegerrequired
  • target_namestringrequired
  • target_typestringrequired
  • enabledbooleanrequired
  • createdstringrequired
  • updatedstringrequired
• countintegerrequired

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/v1/bindings/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "items": [
    {
      "id": 1,
      "datastream_id": 1,
      "target_id": 1,
      "target_name": "string",
      "target_type": "string",
      "enabled": true,
      "created": "string",
      "updated": "string"
    }
  ],
  "count": 1
}

Update a target binding

PATCH/api/v1/bindings/{binding_id}/

API key permissionDestination: Writedestination:write

Partially update a target binding's configuration (currently only the enabled flag). The binding must be accessible within the API key's workspace hierarchy. Enabling a binding runs the same validation as the web UI: a schema mapping must exist when required, and enabling an Insights binding alongside incompatible destinations is rejected.

Path parameters

• binding_idintegerrequired

Request bodyrequired

application/json

Body schema

object BindingPatchSchema

• enabledbooleanrequired

Responses

200OKapplication/json

Response schema

object BindingResponseSchema

• idintegerrequired
• datastream_idintegerrequired
• target_idintegerrequired
• target_namestringrequired
• target_typestringrequired
• enabledbooleanrequired
• createdstringrequired
• updatedstringrequired

400Bad Requestapplication/json

Response schema

object ErrorSchema

• detailstringrequired

404Not Foundapplication/json

Response schema

object ErrorSchema

• detailstringrequired

RequestcURL

curl --request PATCH 'https://{{INSTANCE}}/api/v1/bindings/{binding_id}/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "enabled": true
  }'

Response200

{
  "id": 1,
  "datastream_id": 1,
  "target_id": 1,
  "target_name": "string",
  "target_type": "string",
  "enabled": true,
  "created": "string",
  "updated": "string"
}

Was this page helpful? Yes No