Skip to main content
GET
/
scripts
/
scheduled
/
{scheduledScriptId}
/
progress
Get Execution Progress
curl --request GET \
  --url https://v1.api.altostrat.io/scripts/scheduled/{scheduledScriptId}/progress \
  --header 'Authorization: Bearer <token>'
{
  "completed": [
    "site_1AbCdEfGhIjKlMnOpQrStUv"
  ],
  "failed": [
    "site_2BcDeFgHiJkLmNoPqRsTuVw"
  ],
  "pending": [
    "site_3CdEfGhIjKlMnOpQrStUvWx"
  ]
}

Authorizations

​
Authorization
string
header
required

Altostrat SDX API uses JWT Bearer tokens for authentication. Obtain a token via the Authentication API and include it in the Authorization header as 'Bearer {token}'.

Path Parameters

​
scheduledScriptId
string<uuid>
required

The unique identifier for the scheduled script.

Example:

"018f5bda-4690-4432-8472-358b2734f19b"

Response

The current progress of the script execution.

Represents the execution progress of a launched script across its target sites.

​
completed
string<uuid>[]

A list of site IDs where the script has completed successfully.

​
failed
string<uuid>[]

A list of site IDs where the script execution has failed.

​
pending
string<uuid>[]

A list of site IDs where the script is still pending or in progress.