Replace the collaborators on a data plane

curl --request PUT \
  --url https://api-dev.narrative.io/data-planes/{data_plane_id}/collaborators \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "participants": {
    "type": "all"
  },
  "manage_compute_pools": {
    "type": "all"
  }
}
'

Data Planes

Replace the collaborators on a data plane

Overwrites the entire collaborators object on the data plane, setting both participants (who may use the data plane) and manage_compute_pools (which companies may create / edit / archive compute pools on it). Mirrors the whole-object PUT pattern used by attributes.

The granular per-company PUT/DELETE /data-planes/{data_plane_id}/collaborators/{collaborator_company_id} endpoints continue to work for incremental mutation of participants; this endpoint is the only way to set manage_compute_pools.

PUT

data-planes

{data_plane_id}

collaborators

Replace the collaborators on a data plane

curl --request PUT \
  --url https://api-dev.narrative.io/data-planes/{data_plane_id}/collaborators \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "participants": {
    "type": "all"
  },
  "manage_compute_pools": {
    "type": "all"
  }
}
'

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

data_plane_id

string

required

Body

application/json

participants

object

required

Option 1
Option 2
Option 3

Show child attributes

manage_compute_pools

object

required

Option 1
Option 2
Option 3

Show child attributes

Response

Collaborators replaced

Trigger a health check Add a collaborator to a data plane

⌘I