SoulFire LogoSoulFire

Deactivate script

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

POST
/v1/instances/{instance_id}/scripts/{script_id}: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.

Formatuuid
script_id*string

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

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/scripts/497f6eca-6276-4993-bfeb-53cbbbba6f08:deactivate"
{}

How is this page?