SoulFire LogoSoulFire

Deactivate script

Deactivates an active script. Unregisters all event listeners and cancels any pending async operations.

POST
/v1/instances/p0/scripts/p1:deactivate

Deactivates an active script. Unregisters all event listeners and cancels any pending async operations.

Authorization

AuthorizationBearer <token>

Preferred API authentication. Use a JWT with the api audience.

In: header

Path Parameters

instance_id*string

The instance containing the script. Format: UUID string.

script_id*string

The ID of the script to deactivate. Format: UUID string.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://127.0.0.1:38765/v1/instances/p0/scripts/p1:deactivate"
{}
{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}
{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}
{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}

How is this page?