Mabl Environment API

openapi: 3.2.0
info:
  title: mabl Environment API
  description: APIs for interacting with mabl services
  version: 0.599.3.1792436330
  x-readme-id: 62c896636916ce01d2ff4f5a
servers:
- url: /
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Environment
paths:
  /environments:
    get:
      tags:
      - Environment
      summary: Get environments by workspace
      description: Get all environments in a workspace
      operationId: queryEnvironments
      parameters:
      - name: workspace_id
        in: query
        description: ID of workspace in which to query environments
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Pagination limit
        required: false
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          format: int32
      - name: cursor
        in: query
        description: Pagination cursor
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Environements in a given workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentQueryResult'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::Environment
      x-mabl-scope: public
    post:
      tags:
      - Environment
      summary: Create environment
      description: Create a new environment
      operationId: createEnvironment
      requestBody:
        description: Environment to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Environment'
        required: true
      responses:
        '201':
          description: Environment created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Create::Environment
      x-mabl-scope: public
  /environments/{id}:
    get:
      tags:
      - Environment
      summary: Get Environment by ID
      description: Get environment information by ID
      operationId: getEnvironment
      parameters:
      - name: id
        in: path
        description: Environment ID
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: decrypt
        in: query
        description: If true, decrypts all encrypted content before returning the result
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: Environment with given ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Environment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::Environment
      x-mabl-scope: public
    delete:
      tags:
      - Environment
      summary: Remove environment
      description: Remove an environment
      operationId: removeEnvironment
      parameters:
      - name: id
        in: path
        description: Environment ID
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Environment removed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Environment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Delete::Environment
      x-mabl-scope: public
    patch:
      tags:
      - Environment
      summary: Update environment
      description: Update an existing environment. **Note** - when you use the update environment endpoint to update environment variables, you completely replace any existing variables.
      operationId: updateEnvironment
      parameters:
      - name: id
        in: path
        description: Environment 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
        required: false
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: Update to apply
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Environment'
        required: true
      responses:
        '200':
          description: Environment updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Environment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Edit::Environment
      x-mabl-scope: public
components:
  responses:
    ErrorResponse401:
      description: User not authenticated
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse400:
      description: Invalid or missing parameter
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse403:
      description: User not authorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse:
      description: Unknown error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
  schemas:
    EnvironmentQueryResult:
      type: object
      properties:
        environments:
          type: array
          description: All environments that match query
          readOnly: true
          items:
            $ref: '#/components/schemas/Environment'
          x-mabl-scope: public
        cursor:
          type: string
          description: Pagination cursor
          readOnly: true
          x-mabl-scope: public
    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.
    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
    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.'
    Environment:
      type: object
      properties:
        id:
          type: string
          description: Environment ID
          x-mabl-scope: public
        preview:
          type: boolean
          description: True if a short-lived ephemeral environment
        created_time:
          type: integer
          description: Time environment created
          format: int64
          x-mabl-scope: public
        created_by_id:
          type: string
          description: ID of user who created environment
          x-mabl-scope: public
        last_updated_time:
          type: integer
          description: Time environment last updated
          format: int64
          x-mabl-scope: public
        last_updated_by_id:
          type: string
          description: ID of user who last updated environment
          x-mabl-scope: public
        organization_id:
          type: string
          description: ID of organization (now workspace) associated with environment
        workspace_id:
          type: string
          description: ID of workspace associated with environment
          x-mabl-scope: public
        name:
          type: string
          description: Environment display name
          x-mabl-scope: public
        description:
          type: string
          description: Environment description
          x-mabl-scope: public
        encrypted_variables:
          type: string
          description: Serialized and encrypted environment variables
          readOnly: true
        variables:
          type: object
          additionalProperties:
            type: string
          description: Environment variables
          x-mabl-scope: public
        link_agent_label:
          type: string
          description: DEPRECATED - use link_agent_labels
          deprecated: true
          x-mabl-scope: public
        link_agent_labels:
          type: array
          description: If specified, and if use_link_agent is true, test traffic will be routed through Link agents with any of these labels
          items:
            type: string
          x-mabl-scope: public
        use_link_agent:
          type: boolean
          description: If true, uses a Link Agent with specified link_agent_label for this environment
          x-mabl-scope: public
        link_bypass_mabl_proxy:
          type: boolean
          description: If true, and if use_link_agent is true, test traffic will be routed directly via the Link Agent, bypassing the mabl HTTP proxy
          x-mabl-scope: public
        use_source_control_tag:
          type: boolean
          description: If true, enables use of source_control_tag_target
        source_control_tag_target:
          type: string
          description: All tests run in this environment will use this source control tag
        page_load_wait:
          type: string
          description: Time to wait after page loads, if supported by the runtime.
          enum:
          - FAST
          - NORMAL
          - SLOW
          - SLOWER
          default: NORMAL
          x-force-uppercase: true
          x-mabl-scope: public
      x-implements-interface:
      - ActivityTrackingBaseEntity
      - HasOrganizationId
      - HasName
    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'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header