SoulFire LogoSoulFire

Get script status

Gets the current status of a script. Returns whether the script is active, which node is executing, and activation count.

GET
/v1/instances/:instance_id/scripts/:script_id/status

Gets the current status of a script. Returns whether the script is active, which node is executing, and activation count.

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 check. Format: UUID string.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://127.0.0.1:38765/v1/instances/:instance_id/scripts/:script_id/status"
{
  "status": {
    "script_id": "74e7d8c3-daa9-40c1-ac0e-b64bfab79c57",
    "is_active": true,
    "active_node_id": "string",
    "activation_count": 0
  }
}

How is this page?