Update a directory connector fleet instance

POST

/api/admin/tenants/{tenantId}/directory-connectors/fleet/{instanceId}

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/tenants/example/directory-connectors/fleet/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "action": "deactivate", "connector_id": "wwcon_8K4M2Q9F7D3H6P1X", "reason": "suspected host compromise" }'

Acknowledges the current status episode, deactivates an instance, or reactivates an instance.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

tenantId

required

string

instanceId

required

string

<= 128 characters

Request Body ^required

Connector fleet instance action.

Media type application/json

object

action

required

string

Allowed values: acknowledge deactivate reactivate

connector_id

required

string

/^wwcon_[a-zA-Z0-9]{16}$/

reason

string

<= 1000 characters

key

additional properties

Example

{
  "action": "deactivate",
  "connector_id": "wwcon_8K4M2Q9F7D3H6P1X",
  "reason": "suspected host compromise"
}

Responses

200

Directory connector fleet instance action result.

Media type application/json

object

ok

required

boolean

instance_id

required

string

connector_id

required

string

/^wwcon_[a-zA-Z0-9]{16}$/

action

required

string

Allowed values: acknowledge deactivate reactivate

key

additional properties

Example

{
  "ok": true,
  "instance_id": "wwi_1234567890123456789012",
  "connector_id": "wwcon_8K4M2Q9F7D3H6P1X",
  "action": "deactivate"
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}