Change who may write through this source connection

PUT

/api/workspaces/{workspaceId}/connections/sources/{id}/writers

const url = 'http://localhost:8080/api/workspaces/example/connections/sources/example/writers';
const options = {
  method: 'PUT',
  headers: {cookie: 'auth_session=<auth_session>', 'Content-Type': 'application/json'},
  body: '{"writers":[{"principal":"workflow:*"}],"liveReads":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url http://localhost:8080/api/workspaces/example/connections/sources/example/writers \
  --header 'Content-Type: application/json' \
  --cookie auth_session=<auth_session> \
  --data '{ "writers": [ { "principal": "workflow:*" } ], "liveReads": true }'

Authorizations

cookieAuth
bearerAuth

Parameters

Path Parameters

workspaceId

required

string

required

string

Request Body

application/json

object

writers

required

Array<object>

<= 200 items

object

principal

required

string

/^(user:[A-Za-z0-9_-]+|workflow:\*|workflow:[A-Za-z0-9][A-Za-z0-9_-]{0,99})$/

Example

workflow:*

liveReads

boolean

Responses

2XX

Successful response

application/json

object

success

Whether the request succeeded.

boolean

data

Endpoint-specific response payload.

message

string

error

string

Example

{
  "message": "Operation completed",
  "error": "Error message"
}

4XX

Invalid request

application/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}

5XX

Internal server error

application/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}