> ## Documentation Index
> Fetch the complete documentation index at: https://altostrat.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Execution Progress

> Retrieves the real-time execution progress for a script that has been launched. It provides lists of sites where the script has completed, failed, or is still pending.



## OpenAPI

````yaml /api/en/scripts.yaml get /scripts/scheduled/{scheduledScriptId}/progress
openapi: 3.0.3
info:
  title: Altostrat Scripts API
  version: 1.0.0
  description: >-
    The Altostrat Scripts API is the microservice responsible for creating,
    managing, and executing MikroTik RouterOS scripts across your network
    infrastructure.


    It serves as the core automation engine within the Altostrat SDX platform,
    empowering developers to programmatically deploy configuration changes,
    perform operational tasks, and leverage AI for script generation. This API
    is the foundation for network automation and agentic AI capabilities.


    This API allows you to programmatically manage:

    - **Scheduled Scripts:** The primary resource for defining a script, its
    target devices, and a future execution time, complete with authorization
    workflows and progress tracking.

    - **Script Templates:** Reusable, version-controlled script blueprints that
    can be either private to an organization or shared globally to enforce
    standardization and best practices.

    - **Community Scripts:** A curated and searchable library of publicly
    available RouterOS scripts sourced from GitHub, providing ready-to-use
    solutions for common networking tasks.

    - **AI Script Generation:** An agentic AI endpoint that translates natural
    language prompts into functional and safe MikroTik RouterOS scripts.


    Developers use this API to build powerful, scalable, and intelligent network
    automation workflows for their fleet of MikroTik devices.
servers:
  - url: https://v1.api.altostrat.io
security:
  - BearerAuth:
      - script:view
      - script:create
      - script:update
      - script:delete
      - script:run
      - script:authorize
tags:
  - name: Scheduled Scripts
    description: >-
      Manage the lifecycle of scripts scheduled for execution on network
      devices.
  - name: Script Templates
    description: Create and manage reusable script templates for standardization.
  - name: Community Scripts
    description: Discover and utilize scripts from the public community repository.
  - name: AI Script Generation
    description: Generate MikroTik scripts from natural language prompts.
paths:
  /scripts/scheduled/{scheduledScriptId}/progress:
    get:
      tags:
        - Scheduled Scripts
      summary: Get Execution Progress
      description: >-
        Retrieves the real-time execution progress for a script that has been
        launched. It provides lists of sites where the script has completed,
        failed, or is still pending.
      operationId: getScheduledScriptProgress
      parameters:
        - name: scheduledScriptId
          in: path
          required: true
          description: The unique identifier for the scheduled script.
          schema:
            type: string
            format: uuid
            example: 018f5bda-4690-4432-8472-358b2734f19b
      responses:
        '200':
          description: The current progress of the script execution.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScriptProgress'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    ScriptProgress:
      type: object
      description: >-
        Represents the execution progress of a launched script across its target
        sites.
      properties:
        completed:
          type: array
          description: A list of site IDs where the script has completed successfully.
          items:
            type: string
            format: uuid
            example: site_1AbCdEfGhIjKlMnOpQrStUv
        failed:
          type: array
          description: A list of site IDs where the script execution has failed.
          items:
            type: string
            format: uuid
            example: site_2BcDeFgHiJkLmNoPqRsTuVw
        pending:
          type: array
          description: A list of site IDs where the script is still pending or in progress.
          items:
            type: string
            format: uuid
            example: site_3CdEfGhIjKlMnOpQrStUvWx
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          description: A broad category for the error (e.g., 'invalid_request_error').
          example: invalid_request_error
        code:
          type: string
          description: A short, unique string identifying the specific error.
          example: parameter_missing
        message:
          type: string
          description: A human-readable description of what went wrong.
          example: The 'name' parameter is required for this request.
        doc_url:
          type: string
          description: >-
            A direct link to the documentation page for this specific error
            code.
          example: https://docs.altostrat.io/errors/parameter_missing
  responses:
    Unauthorized:
      description: >-
        Unauthorized - The request requires authentication and a valid Bearer
        token was not provided.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: >-
        Forbidden - The authenticated user does not have the required
        permissions (scopes) to perform this action.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Not Found - The requested resource could not be found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        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}'.

````