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

# Read a runner

> Returns a runner's details, current work, and lifetime counters. Requires platform administrator access.



## OpenAPI

````yaml https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/fleets/runners/{runner_id}
openapi: 3.1.0
info:
  title: agentsfleet API
  description: API for managing workspaces, fleets, triggers, and runs.
  contact:
    name: agentsfleet
    url: https://agentsfleet.net
  license:
    name: MIT
    identifier: MIT
  version: 1.0.0
servers:
  - url: https://api.agentsfleet.net
    description: Production
security: []
paths:
  /v1/fleets/runners/{runner_id}:
    get:
      tags:
        - Fleet
      summary: Read a runner
      description: >-
        Returns a runner's details, current work, and lifetime counters.
        Requires platform administrator access.
      operationId: get_fleet_runner
      parameters:
        - name: runner_id
          in: path
          description: >-
            Runner identifier (version 7 universally unique identifier, or
            UUID).
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunnerDetail'
        '400':
          description: The request is invalid
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemBody'
        '401':
          description: Authentication is missing, invalid, or not accepted by this endpoint
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemBody'
        '403':
          description: You do not have permission for this action
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemBody'
        '404':
          description: The resource was not found or is not accessible to you
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemBody'
        '429':
          description: A request or capacity limit has been reached
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemBody'
        '500':
          description: An internal server error occurred
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemBody'
        '503':
          description: A required service is unavailable
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemBody'
      security:
        - BearerAuth: []
components:
  schemas:
    RunnerDetail:
      allOf:
        - $ref: '#/components/schemas/RunnerItem'
          description: The fields shared with the runner list, flattened on the wire.
        - type: object
          required:
            - active_lease_count
            - active_fleet_count
            - leases_acquired
            - leases_succeeded
            - leases_failed
            - leases_expired
          properties:
            active_fleet_count:
              type: integer
              format: int64
              description: Fleets represented by live leases.
            active_lease_count:
              type: integer
              format: int64
              description: Live leases currently held.
            leases_acquired:
              type: integer
              format: int64
              description: Lifetime acquired count.
            leases_expired:
              type: integer
              format: int64
              description: Lifetime expired count.
            leases_failed:
              type: integer
              format: int64
              description: Lifetime failed count.
            leases_succeeded:
              type: integer
              format: int64
              description: Lifetime successful count.
            selftest:
              oneOf:
                - $ref: '#/components/schemas/SelftestReport'
                  description: Latest complete self-test report.
                - type: 'null'
            selftest_completed_at:
              type:
                - string
                - 'null'
              format: date-time
              description: Latest self-test completion instant.
            selftest_requested_at:
              type:
                - string
                - 'null'
              format: date-time
              description: Outstanding self-test request instant.
      description: One runner with its live and lifetime counters.
    ProblemBody:
      type: object
      description: The body every refusal carries, under `application/problem+json`.
      required:
        - docs_uri
        - title
        - detail
        - error_code
        - request_id
      properties:
        action_id:
          type:
            - string
            - 'null'
          description: 'On that 409 only: the action the gate held.'
        current_state:
          type:
            - string
            - 'null'
          description: 'On a 409 only: the state that forbade the transition.'
        detail:
          type: string
          description: One sentence on what was refused and why.
        docs_uri:
          type: string
          description: Where the error code is documented.
        error_code:
          type: string
          description: The registry code, stable across releases.
        etag:
          type:
            - string
            - 'null'
          description: >-
            On a 412 only: the resource's current entity tag, to refetch and
            retry.
        gate_id:
          type:
            - string
            - 'null'
          description: 'On an answered approval gate''s 409 only: the gate that was answered.'
        outcome:
          type:
            - string
            - 'null'
          description: 'On that 409 only: the answer that stands.'
        request_id:
          type: string
          description: The request this refusal answers, for support.
        resolved_at:
          type:
            - string
            - 'null'
          format: date-time
          description: 'On that 409 only: when the standing answer was given.'
        resolved_by:
          type:
            - string
            - 'null'
          description: 'On that 409 only: who gave it.'
        title:
          type: string
          description: A short name for the refusal, safe to show a person.
        user_message:
          type:
            - string
            - 'null'
          description: A curated sentence for end users, where the code has one.
    RunnerItem:
      type: object
      description: One runner in the newest-first operator list.
      required:
        - id
        - host_id
        - sandbox_tier
        - status
        - liveness
        - labels
        - last_seen_at
        - created_at
        - assigned_policy
        - degraded
      properties:
        achievable:
          oneOf:
            - $ref: '#/components/schemas/CapabilityReport'
              description: Capability report most recently supplied by the host.
            - type: 'null'
        assigned_policy:
          $ref: '#/components/schemas/AssignedPolicy'
          description: Policy currently assigned to the host.
        created_at:
          type: string
          format: date-time
          description: Enrolment instant.
        degraded:
          type: boolean
          description: Whether the assignment exceeds the reported capability.
        degraded_reason:
          type:
            - string
            - 'null'
          description: Stored explanation for a degraded verdict.
        host_id:
          type: string
          description: Stable host identity supplied at enrolment.
        id:
          type: string
          description: Canonical runner identifier.
        labels:
          type: array
          items:
            type: string
          description: Placement labels.
        last_seen_at:
          type: string
          format: date-time
          description: Last heartbeat instant.
        liveness:
          $ref: '#/components/schemas/RunnerLiveness'
          description: Runtime state derived from heartbeat and leases.
        sandbox_tier:
          type: string
          description: Assigned isolation tier spelling.
        status:
          $ref: '#/components/schemas/AdminState'
          description: Operator-controlled admission state.
      additionalProperties: false
    SelftestReport:
      type: object
      description: |-
        One probe run and the verdict it reached.

        The tier and policy travel with the verdict. Compare them against the
        runner's current values to tell a stale result from a live one.
      required:
        - checks
        - all_ok
        - sandbox_tier
        - network_policy
      properties:
        all_ok:
          type: boolean
          description: Whether every check passed.
        checks:
          type: array
          items:
            $ref: '#/components/schemas/SelftestCheck'
          description: Every check the probe ran.
        network_policy:
          type: string
          description: Outgoing network access policy in effect during the self-test.
        sandbox_tier:
          type: string
          description: The tier in force when the probe ran.
      additionalProperties: false
    CapabilityReport:
      type: object
      description: |
        What this host can actually enforce.
      required:
        - landlock
        - seccomp
        - cgroup_controllers
        - bubblewrap
        - egress_enforcement
      properties:
        bubblewrap:
          type: boolean
          description: The sandbox launcher is available.
        build_id:
          type:
            - string
            - 'null'
          description: >-
            Source digest compiled into the reporting runner; absent for an
            unbound build.
        cgroup_controllers:
          type: array
          items:
            type: string
          description: Controllers present in the delegated cgroup's subtree control.
        egress_enforcement:
          type: boolean
          description: >-
            Whether the operating system can restrict outgoing network access to
            allowed hosts.
        landlock:
          type: boolean
          description: Filesystem isolation is available.
        seccomp:
          type: boolean
          description: System-call filtering is available.
      additionalProperties: false
    AssignedPolicy:
      type: object
      description: >-
        Sandbox isolation, outgoing network access, and concurrency settings
        assigned to this

        runner.
      required:
        - sandbox_tier
        - network_policy
        - registry_allowlist
        - worker_count
        - extra_binds
      properties:
        extra_binds:
          type: array
          items:
            $ref: '#/components/schemas/ExtraBind'
          description: Extra host paths bound into every lease's sandbox.
        network_policy:
          $ref: '#/components/schemas/RunnerNetworkPolicy'
          description: Outgoing network access policy to apply.
        registry_allowlist:
          type: array
          items:
            type: string
          description: >-
            Default package registries added to each assignment's allowed
            network hosts. An empty

            list uses the runner's defaults.
        sandbox_tier:
          $ref: '#/components/schemas/SandboxTier'
          description: Isolation strength to apply.
        worker_count:
          type: integer
          format: int32
          description: Concurrent workers the runner may start. Clamped on both sides.
          minimum: 0
    RunnerLiveness:
      type: string
      description: |-
        Derived runtime liveness, computed by the fleet read and NEVER stored —
        storing it would drift from the values it is derived from.
      enum:
        - registered
        - busy
        - online
        - offline
    AdminState:
      type: string
      description: >-
        Administrator-selected runner state. Only `Active` permits runner API
        requests.
      enum:
        - active
        - cordoned
        - draining
        - drained
        - revoked
    SelftestCheck:
      type: object
      description: >-
        One self-test check's verdict.


        `detail` is prose even when `ok`: every passing check carries a line,
        and a

        whitespace-free cause reads to an operator as a leaked internal
        identifier.
      required:
        - name
        - ok
        - detail
      properties:
        detail:
          type: string
          description: Why, in prose.
        name:
          type: string
          description: What was checked.
        ok:
          type: boolean
          description: Whether it passed.
      additionalProperties: false
    ExtraBind:
      type: object
      description: >-
        One host path bound into every lease's sandbox, in addition to the
        baseline.


        An operator may ADD a path a host needs; never remove or re-mode one the

        sandbox depends on.
      required:
        - path
        - mode
        - note
      properties:
        mode:
          $ref: '#/components/schemas/BindMode'
          description: Whether the bind is writable.
        note:
          type: string
          description: Operator note explaining why the bind exists.
        path:
          type: string
          description: Host path to bind.
    RunnerNetworkPolicy:
      type: string
      description: Outgoing network access policy assigned to a runner.
      enum:
        - allow_all
        - deny_all_egress
        - allow_list_egress
    SandboxTier:
      type: string
      description: The isolation strength assigned to a runner.
      enum:
        - landlock_full
        - container_nested
        - dev_none
    BindMode:
      type: string
      description: Whether an operator-added bind is writable.
      enum:
        - read_only
        - read_write
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Send a dashboard session token, an account API key (`agt_t`), or a
        command-line credential (`afc_`) as a Bearer token. Each endpoint lists
        accepted credential types.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.