Mabl Execution Runner API

openapi: 3.2.0
info:
  title: mabl Execution Runner API
  description: APIs for interacting with mabl services
  version: 0.599.3.1792436330
  x-readme-id: 62c896636916ce01d2ff4f5a
servers:
- url: /
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: ExecutionRunner
paths:
  /execution/runners:
    post:
      tags:
      - ExecutionRunner
      summary: Create new Execution Runner
      description: Created Execution Runner for tracking a unique runner
      operationId: createExecutionRunner
      requestBody:
        description: Agent detail
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateExecutionRunnerRequest'
        required: true
      responses:
        '201':
          description: Execution Runner
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionRunner'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        '403':
          description: Actor is not authorized to make this call
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        '409':
          description: Execution Runner with ID already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Create::ExecutionRunner
  /execution/runners/workspace/{workspace_id}:
    get:
      tags:
      - ExecutionRunner
      summary: Query Execution Runners
      description: Query Execution Runner, sorted last updated time descending
      operationId: queryExecutionRunners
      parameters:
      - name: workspace_id
        in: path
        description: workspace owning the runners
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: test_type
        in: query
        description: matching test type
        required: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/TestTypeEnum'
      - name: operating_system
        in: query
        description: matching OS
        required: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/ExecutionRuntimeOperatingSystem'
      - name: status
        in: query
        description: sought status
        required: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/ExecutionRunnerStatus'
      - name: capabilities
        in: query
        description: desired capabilities of the runtime
        required: true
        style: form
        explode: true
        schema:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/ExecutionRuntimeCapability'
      - name: limit
        in: query
        description: max entities to return, max/default of 100
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: cursor
        in: query
        description: The cursor to use for pagination
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Execution Runner
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionRunnerQueryResult'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        '403':
          description: Actor is not authorized to make this call
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::ExecutionRunner
  /execution/runners/host/{host_id}:
    get:
      tags:
      - ExecutionRunner
      summary: Query Execution Runners
      description: Query Execution Runner, sorted last updated time descending
      operationId: queryExecutionRunnersByHost
      parameters:
      - name: host_id
        in: path
        description: Host runners are running on
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: operating_system
        in: query
        description: optional matching OS
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/ExecutionRuntimeOperatingSystem'
      - name: status
        in: query
        description: sought status
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/ExecutionRunnerStatus'
      - name: limit
        in: query
        description: max entities to return, max/default of 100
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: cursor
        in: query
        description: The cursor to use for pagination
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Execution Runner
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionRunnerQueryResult'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        '403':
          description: Actor is not authorized to make this call
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::ExecutionRunner
  /execution/runners/{id}:
    get:
      tags:
      - ExecutionRunner
      summary: Fetch Execution Runner
      operationId: getExecutionRunner
      parameters:
      - name: id
        in: path
        description: runner ID (NOT the ref_id)
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Execution Runner
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionRunner'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        '403':
          description: Actor is not authorized to make this call
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        '404':
          description: No such Execution Runner
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::ExecutionRunner
    delete:
      tags:
      - ExecutionRunner
      summary: Remove Execution Runner
      operationId: removeExecutionRunner
      parameters:
      - name: id
        in: path
        description: runner ID (NOT the ref_id)
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: Execution Runner
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        '403':
          description: Actor is not authorized to make this call
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Delete::ExecutionRunner
    patch:
      tags:
      - ExecutionRunner
      summary: Update existing Execution Runner
      description: Created Execution Runner for tracking a unique runner
      operationId: updateExecutionRunner
      parameters:
      - name: id
        in: path
        description: runner ID (NOT the ref_id)
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: If-Match
        in: header
        description: If-Match header according to http/1.1 spec section 14.24 - use to ensure atomic updates, pass "version" from etag
        required: false
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: Updated agent detail
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchExecutionRunnerRequest'
        required: true
      responses:
        '200':
          description: Execution Runner
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionRunner'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        '403':
          description: Actor is not authorized to make this call
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        '404':
          description: No such Execution Runner
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        '409':
          description: Conflict with If-Match header
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Edit::ExecutionRunner
components:
  schemas:
    MobileDeviceType:
      type: string
      description: Type of platform used to create mobile device
      enum:
      - virtual
      - physical
    ExecutionRuntimeOperatingSystem:
      type: string
      description: Operation system used in the runtime
      enum:
      - android
      - ios
      - windows
      - linux
      - osx
    ExecutionRunnerQueryResult:
      type: object
      allOf:
      - $ref: '#/components/schemas/PaginatedResponse'
      - type: object
        properties:
          items:
            type: array
            description: Results
            readOnly: true
            items:
              $ref: '#/components/schemas/ExecutionRunner'
    GuardrailApprovalKind:
      type: string
      description: Who decides a guardrail approval. SELF is decided by the person the agent acts for; WORKSPACE, for an agent acting for an API key, by a workspace owner or editor.
      enum:
      - SELF
      - WORKSPACE
    GuardrailRefusal:
      type: object
      properties:
        id:
          type: string
          description: The id of the guardrail policy that decided the refusal.
        reason:
          type: string
          description: Why the policy refuses the request, written for the person the agent acts for.
        decision_id:
          type: string
          description: The id of this decision in the guardrail decision log.
        action:
          type: string
          description: The action the request was evaluated as, written Verb::Resource (for example Delete::Test), as declared by the operation's x-mabl-action extension.
        policy_source:
          type: string
          description: 'Who set the deciding policy: workspace for a rule the workspace''s owners wrote, account for a rule set for the workspace''s account, mabl_agent_type for the agent type''s ceiling, and mabl_default for mabl''s own defaults.'
        approval:
          description: The approval for this request; present when error_code is approval_required and the approval could be recorded. Without it the request cannot be approved.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalRef'
      description: The guardrail policy that refused an agent request.
    ExecutionRunnerStatus:
      type: string
      description: Non-directed states for runner lifecycle
      enum:
      - ready
      - resetting
      - running
      - stopping
      - starting
      - terminated
    GuardrailApprovalState:
      type: string
      description: Where a guardrail approval stands. PENDING awaits a decision and expires undecided after 24 hours; APPROVED lets the agent repeat the request, as often as it does, for 20 minutes; DENIED refuses the same request for 20 minutes after the decision, after which asking again opens a new approval; CANCELLED means a person withdrew it while pending or revoked it while approved. EXPIRED and CANCELLED are final.
      enum:
      - PENDING
      - APPROVED
      - DENIED
      - EXPIRED
      - CANCELLED
    ExecutionRuntimeType:
      type: string
      description: Type of container used for execution. Note that VM Instances -> virtual machine, GCF, GKE, GCR -> container
      enum:
      - container
      - virtual_machine
    GuardrailApprovalRef:
      type: object
      properties:
        id:
          type: string
          description: The approval's id.
        state:
          description: Where the approval stands.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalState'
        kind:
          description: Who decides the approval.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalKind'
        request_expires_time:
          type: integer
          description: When the approval expires if nobody decides it, in epoch milliseconds.
          format: int64
        url:
          type: string
          description: The mabl app page where a person reviews the approval.
      description: 'An approval a guardrail policy asks for. While it is PENDING, stop: give the person the url, tell them the request is waiting for approval, and do not repeat the request or poll in a loop. Once a person tells you it is APPROVED, repeat the identical request with the header X-Mabl-Approval set to id. DENIED means a person said no, so do not work around it.'
    PaginatedResponse:
      required:
      - count
      type: object
      properties:
        count:
          type: integer
          description: Number of items returned in this response, maybe 0 if count == limit on last call
          format: int32
        limit:
          type: integer
          description: Limit applied to this query
          format: int32
        cursor:
          type: string
          description: Cursor that can be used to fetch the next page, count <= limit
      description: Common paginated response result holder
    ExecutionRunner:
      required:
      - created_by_id
      - created_time
      - id
      - last_updated_by_id
      - last_updated_time
      - workspace_id
      type: object
      description: Runner that executes tests
      allOf:
      - $ref: '#/components/schemas/CreateExecutionRunnerRequest'
      - $ref: '#/components/schemas/PatchExecutionRunnerRequest'
      - type: object
        properties:
          id:
            type: string
            description: API generated globally unique ID
          etag:
            type: string
            description: API version etag
          created_time:
            type: integer
            description: Creation time, epoch millis
            format: int64
          created_by_id:
            type: string
            description: Creation principal ID
          last_updated_time:
            type: integer
            description: Last updated time, epoch millis
            format: int64
          last_updated_by_id:
            type: string
            description: Last updating principal ID
          deleted_time:
            type: integer
            description: Deletion time, epoch millis
            format: int64
          deleted_by_id:
            type: string
            description: Deletion principal ID
      x-implements-interface:
      - ActivityTrackingBaseEntity
      - HasWorkspaceId
    TestTypeEnum:
      type: string
      description: Type of test
      enum:
      - api
      - browser
      - performance
      - mobile
      - desktop
      x-mabl-scope: public
    ErrorResponseGeneric:
      type: object
      properties:
        id:
          type: string
          x-mabl-scope: public
        code:
          maximum: 599
          minimum: 100
          type: integer
          format: int32
          x-mabl-scope: public
        message:
          type: string
          x-mabl-scope: public
        error_code:
          type: string
          description: Machine-readable reason for the error, present only when the API names one. Values are guardrail_blocked (a guardrail policy refused an agent request), approval_required (a guardrail policy requires a person to approve the request first).
        guardrail:
          description: The guardrail policy that refused the request; present only when error_code is guardrail_blocked or approval_required.
          allOf:
          - $ref: '#/components/schemas/GuardrailRefusal'
    ExecutionRuntimeCapability:
      type: string
      description: Capability provided by this runtime
      enum:
      - training
      - test_run
    CreateExecutionRunnerRequest:
      required:
      - capabilities
      - display_name
      - execution_runtime_operating_system
      - execution_runtime_type
      - ref_id
      - status
      - workspace_id
      type: object
      description: Create Execution Runner
      allOf:
      - $ref: '#/components/schemas/PatchExecutionRunnerRequest'
      - type: object
        properties:
          ref_id:
            type: string
            description: Globally unique runner reference ID (e.g. GCE VM instance number as "gce-<number>", GKE pod ID "gke-<number>", EC2 instance ID as "ec2-<ID>")
          workspace_id:
            type: string
            description: Runner owner - may be user owned, or mabl owned
          display_name:
            type: string
            description: Presentation name for this runner
          test_type:
            $ref: '#/components/schemas/TestTypeEnum'
          mobile_device_type:
            $ref: '#/components/schemas/MobileDeviceType'
          execution_host_id:
            type: string
            description: The id of the execution host this is running on
          execution_runtime_purpose:
            $ref: '#/components/schemas/ExecutionRuntimeCapability'
          capabilities:
            minItems: 1
            type: array
            items:
              $ref: '#/components/schemas/ExecutionRuntimeCapability'
          execution_runtime_type:
            $ref: '#/components/schemas/ExecutionRuntimeType'
          execution_runtime_operating_system:
            $ref: '#/components/schemas/ExecutionRuntimeOperatingSystem'
          capability_browser:
            type: string
            description: optional, browsers available to runner, for browser type runners
    PatchExecutionRunnerRequest:
      type: object
      properties:
        ipv4_address:
          type: string
          description: Currently associated IP address (typically RFC 1918)
        execution_runtime_version:
          type: string
          description: SHA256 hash first 7 characters of the runner binary (NOT necessarily the OS/base image)
        mobile_training_session_id:
          type: string
          description: The currently associated mobile training session ID
        status:
          $ref: '#/components/schemas/ExecutionRunnerStatus'
        test_run_id:
          type: string
          description: Currently associated test run ID
        zone:
          type: string
          description: The zone where the VM resides
      description: Patch select Execution Runner properties
  responses:
    ErrorResponse:
      description: Unknown error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header