data-sources

Update a data source

Edit a data source's name, connector configuration, or node.

Send •••••••• back for a credential to keep the stored value. To point the source at a different address or connector type, enter the credential again.

patch/v1/data-sources/{id}

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/data-sources/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Data source id.

Request body

namestring
typestring

A change of type needs config with the credentials entered again.

configobject

Connector settings (JSON). The keys depend on type. Credentials are encrypted at rest and every later read shows them as ••••••••.

nodeIdstring nullable

Move it; the key needs integration.edit at the destination too.

Response

Success.

Example response

{
  "data": {
    "id": "ds_6f7a8b9c0d1e2f3a"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.