Mabl Link Server API

openapi: 3.2.0
info:
  title: mabl Link Server API
  description: APIs for interacting with mabl services
  version: 0.599.3.1792436330
  x-readme-id: 62c896636916ce01d2ff4f5a
servers:
- url: /
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: LinkServer
paths:
  /link/servers/select:
    get:
      tags:
      - LinkServer
      summary: Query Link Servers
      description: Selects a single Link Server to use for a given workspace and label
      operationId: selectLinkServer
      parameters:
      - name: workspace_id
        in: query
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: label
        in: query
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: The Link Server to use
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkServer'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: No Link Server could be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::LinkServer
  /link/servers/select-multiple:
    get:
      tags:
      - LinkServer
      summary: Query Link Servers
      description: Selects one or more Link Servers to use for the given workspace and labels
      operationId: selectLinkServers
      parameters:
      - name: workspace_id
        in: query
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: labels
        in: query
        description: Comma-delimited set of link labels to query
        required: true
        style: form
        explode: false
        schema:
          minItems: 1
          type: array
          items:
            type: string
      responses:
        '200':
          description: The Link Servers to use
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultipleLinkServerSelectResult'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::LinkServer
  /cron/link/servers/cleanup:
    get:
      tags:
      - LinkServer
      summary: Clean up dead and unused Link Servers
      operationId: cleanupLinkServers
      responses:
        '204':
          description: Cleanup successful
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Delete::LinkServer
  /link/servers/{id}:
    get:
      tags:
      - LinkServer
      summary: Retrieves the Link Server with the given ID
      operationId: getLinkServer
      parameters:
      - name: id
        in: path
        description: The ID of the server to start
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Link Server with the given ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkServer'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Link Server not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::LinkServer
  /link/servers/{id}/startup:
    post:
      tags:
      - LinkServer
      summary: Transitions a Link Server to running state; server should only start on 200…
      operationId: onLinkServerStartup
      parameters:
      - name: id
        in: path
        description: The ID of the server to start
        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: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Start Link Server with the given parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkServerStartupParameters'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Link Server not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        '409':
          description: Link Server already started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        '410':
          description: Link Server took too long to start
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        '412':
          description: Given ETag is not current
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Edit::LinkServer
  /link/servers/{id}/heartbeat:
    delete:
      tags:
      - LinkServer
      summary: Terminates/removes a Link Server
      operationId: removeLinkServer
      parameters:
      - name: id
        in: path
        description: The ID of the server to remove
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: The Link Server that was deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkServer'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Link Server not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Edit::LinkServer
    patch:
      tags:
      - LinkServer
      summary: Indicates that a Link Server has sent a heartbeat
      operationId: linkServerHeartbeat
      parameters:
      - name: id
        in: path
        description: The ID of the server sending the heartbeat
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: Link Server update to piggyback on this heartbeat
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkServer'
        required: false
      responses:
        '204':
          description: Heartbeat acknowledged
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Link Server not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        '412':
          description: If-Match precondition not satisfied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Edit::LinkServer
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:
    MultipleLinkServerSelectResult:
      required:
      - link_servers
      type: object
      properties:
        link_servers:
          type: array
          description: All Link Servers that were selected
          readOnly: true
          items:
            $ref: '#/components/schemas/LinkServer'
    LinkServerStartupParameters:
      required:
      - client_fingerprint
      - client_public_key
      - fqdn
      - label
      - server_certificate
      - size
      - workspace_id
      type: object
      properties:
        workspace_id:
          type: string
          description: The workspace ID associated with this Link Server
          readOnly: true
        label:
          type: string
          description: The link label
          readOnly: true
        server_certificate:
          type: string
          description: The serialized certificate for Link Servers to use
          readOnly: true
        client_fingerprint:
          type: string
          description: The fingerprint of the client certificate
          readOnly: true
        client_public_key:
          type: string
          description: The public key of the client
          readOnly: true
        fqdn:
          type: string
          description: The fully qualified domain name of this Link Server
          readOnly: true
        size:
          $ref: '#/components/schemas/LinkServerSize'
      description: Parameters required to start up a Link Server
    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.'
    LinkServerSize:
      type: string
      description: The size of the Link Server, which determines its resource allocation
      enum:
      - small
      - large
    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'
    LinkServer:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        created_time:
          type: integer
          description: Time at which the Link Server was created
          format: int64
          readOnly: true
        last_heartbeat_time:
          type: integer
          description: Time at which the Link Server last sent a heartbeat
          format: int64
          readOnly: true
        label:
          pattern: '[a-z0-9\-]{1,24}'
          type: string
          description: The label associated with this Link Server
          readOnly: true
        version:
          type: string
          description: The version of the Link Server software that this instance is running
        status:
          type: string
          description: The current status of this Link Server
          enum:
          - starting
          - running
        tunnel_client_connections:
          type: integer
          description: The number of active tunnel client connections to this Link Server
          format: int32
        forwarding_client_connections:
          type: integer
          description: The number of active forwarding client connections to this Link Server
          format: int32
        tunnel_host:
          type: string
          description: The public Link Server host (hostname or IP address)
        tunnel_port:
          type: integer
          description: The public Link Server port
          format: int32
        forwarding_host:
          type: string
          description: The forwarding host (hostname or IP address)
        forwarding_port:
          type: integer
          description: The forwarding port
          format: int32
        workspace_id:
          type: string
          description: The workspace ID associated with this Link Server
          readOnly: true
        container_id:
          type: string
          description: ID of the container where this Link Server is running
        size:
          $ref: '#/components/schemas/LinkServerSize'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header