Updates a workspace connector.

PUT

/v1/m/sourcescope/workspace-connectors/{id}

curl --request PUT \
  --url https://example.com/v1/m/sourcescope/workspace-connectors/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "config": { "additionalProperty": "example" }, "enabled": true, "id": "example", "kind": "example", "name": "example", "note": "example", "poll_seconds": 1, "secrets": { "additionalProperty": "example" }, "status": "example", "workspace_ref": "example" }'

• this engine

Updates a workspace connector. The name, kind and workspace_ref are immutable (they form the natural key + unique index).

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Path parameter id.

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Request Body ^required

Media type application/json

Any of:

object

object

config

Any of:

object

Non-secret settings. Credential-bearing keys and inline credential values are rejected.

object

key

additional properties

Any of:

string

string

null

null

null

null

enabled

Any of:

boolean

boolean

null

null

id

Any of:

string

Accepted by the DTO but ignored on input; identity comes from the store.

string

null

null

kind

Any of:

string

After trimming it must be non-empty. On update the stored value wins.

string

null

null

name

Any of:

string

After trimming it must be non-empty and no longer than 128 bytes. On update the stored value wins.

string

null

null

note

Any of:

string

Trimmed and capped at 512 bytes.

string

null

null

poll_seconds

Any of:

integer

integer

null

null

secrets

Any of:

object

Secret references or inline literals for sealing; URLs with embedded credentials are rejected.

object

key

additional properties

Any of:

string

string

null

null

null

null

status

Any of:

string

Create always overwrites this with pending; update persists the supplied value.

string

null

null

workspace_ref

Any of:

string

After trimming it must resolve to a workspace. On update the stored value wins.

string

null

null

null

null

Example ^generated

{
  "config": {
    "additionalProperty": "example"
  },
  "enabled": true,
  "id": "example",
  "kind": "example",
  "name": "example",
  "note": "example",
  "poll_seconds": 1,
  "secrets": {
    "additionalProperty": "example"
  },
  "status": "example",
  "workspace_ref": "example"
}

Responses

200

OK

Media type application/json

object

Example ^generated

{}

400

Bad request

Media type application/json

object

Example ^generated

{}

401

Unauthenticated

Media type application/json

object

Example ^generated

{}

403

Forbidden

Media type application/json

object

Example ^generated

{}

404

Not found

Media type application/json

object

Example ^generated

{}

409

Conflict / setup required

Media type application/json

object

Example ^generated

{}

429

Rate limited

Media type application/json

object

Example ^generated

{}