> ## 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.

# Acquire or refresh bounded checkpoint transfers

> A restore request without object identities acquires a native reader pin and ordered manifest descriptors. Bounded refresh verifies acknowledged uploads or signs current scoped transfers.



## OpenAPI

````yaml https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/runners/me/leases/{lease_id}/tasks/checkpoints/{checkpoint_id}/authorizations
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/runners/me/leases/{lease_id}/tasks/checkpoints/{checkpoint_id}/authorizations:
    post:
      tags:
        - Runners
      summary: Acquire or refresh bounded checkpoint transfers
      description: >-
        A restore request without object identities acquires a native reader pin
        and ordered manifest descriptors. Bounded refresh verifies acknowledged
        uploads or signs current scoped transfers.
      operationId: runner_checkpoint_authorize
      parameters:
        - name: lease_id
          in: path
          description: Native lease UUIDv7.
          required: true
          schema:
            type: string
        - name: checkpoint_id
          in: path
          description: Native checkpoint UUIDv7.
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckpointAuthorizationInput'
        required: true
      responses:
        '200':
          description: Native checkpoint result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckpointAuthorizations'
        '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'
        '409':
          description: The request conflicts with the resource's current state
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemBody'
        '413':
          description: The request body exceeds this endpoint's size limit
          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:
        - RunnerBearerAuth: []
components:
  schemas:
    CheckpointAuthorizationInput:
      type: object
      description: Acquire a restore pin, or refresh exact registered transfer material.
      required:
        - fencing_token
        - task
        - purpose
      properties:
        fencing_token:
          type: integer
          format: int64
          description: Existing lease fence.
          minimum: 0
        object_ids:
          type: array
          items:
            type: string
          description: Native object identities, never arbitrary bucket paths.
        pin_id:
          type:
            - string
            - 'null'
          description: Omitted only to bootstrap a restore pin and ordered pages.
        purpose:
          $ref: '#/components/schemas/CheckpointTransferPurpose'
          description: Read or upload authority, each checked natively.
        task:
          $ref: '#/components/schemas/DecisionTaskVersion'
          description: Current task version.
      additionalProperties: false
    CheckpointAuthorizations:
      type: object
      description: Restore bootstrap or bounded refresh, always including the native pin.
      required:
        - plan
        - objects
      properties:
        objects:
          type: array
          items:
            $ref: '#/components/schemas/CheckpointObject'
          description: Requested scoped transfers; empty at restore bootstrap.
        plan:
          $ref: '#/components/schemas/CheckpointPlan'
          description: Bounded complete recovery descriptor.
    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.
    CheckpointTransferPurpose:
      type: string
      description: Supervisor-only read purpose.
      enum:
        - upload
        - restore
    DecisionTaskVersion:
      type: object
      description: Task identity and generation supplied from the native lease context.
      required:
        - task_id
        - generation
      properties:
        generation:
          type: integer
          format: int64
          description: >-
            Expected current task generation, without resetting cumulative
            usage.
          minimum: 0
        task_id:
          type: string
          description: >-
            The current lease's objective; not another task selected by model
            text.
      additionalProperties: false
    CheckpointObject:
      type: object
      description: >-
        Registration projection; temporary keys remain outside model/sandbox
        state.
      required:
        - object_id
        - repository
        - plaintext
        - status
      properties:
        ciphertext_length:
          type:
            - integer
            - 'null'
          format: int64
          description: Frozen ciphertext length when already known.
          minimum: 0
        ciphertext_sha256:
          type:
            - string
            - 'null'
          description: Frozen ciphertext digest when already known.
        data_key:
          type:
            - string
            - 'null'
          description: Temporary data key, returned only to this native owner/reader.
        nonce:
          type:
            - string
            - 'null'
          description: Exact fixed nonce, base64 encoded.
        object_id:
          type: string
          description: Native random object identity.
        plaintext:
          $ref: '#/components/schemas/CheckpointPlaintext'
          description: Plaintext descriptor.
        repository:
          type: string
          description: Canonical scope for authenticated encryption.
        status:
          $ref: '#/components/schemas/CheckpointObjectStatus'
          description: Current ownership disposition.
        transfer:
          oneOf:
            - $ref: '#/components/schemas/CheckpointTransfer'
              description: Exact scoped URL when requested.
            - type: 'null'
    CheckpointPlan:
      type: object
      description: Native recovery descriptor, bounded independently of manifest size.
      required:
        - checkpoint_id
        - generation
        - mode
        - repository
        - format_version
        - toolbox_digest
        - page_ids
        - base_page_ids
        - covered_input_sequence
        - effect_watermark
        - expires_at
        - pin
        - replayed
      properties:
        base_commit_oid:
          type:
            - string
            - 'null'
          description: Exact base commit, independent of a later published branch head.
        base_id:
          type:
            - string
            - 'null'
          description: Retained base identity when present.
        base_manifest_root:
          type:
            - string
            - 'null'
          description: Ordered retained-base root, checked before overlaying local changes.
        base_page_ids:
          type: array
          items:
            type: string
          description: >-
            Verified retained base pages, read through the same scoped page
            resource.
        checkpoint_id:
          type: string
          description: Native task-bound plan.
        covered_input_sequence:
          type: integer
          format: int64
          description: Inputs actually incorporated in this state.
          minimum: 0
        effect_watermark:
          type: integer
          format: int64
          description: Confirmed outcomes incorporated in this state.
          minimum: 0
        expires_at:
          type: string
          format: date-time
          description: Deadline established once when the plan is created.
        format_version:
          type: integer
          format: int32
          description: Required restore format.
          minimum: 0
        generation:
          type: integer
          format: int64
          description: Checkpoint ordering, distinct from the task generation.
          minimum: 0
        history_digest:
          type:
            - string
            - 'null'
          description: History state bound to the same file generation.
        manifest_root:
          type:
            - string
            - 'null'
          description: Absent until native verification commits.
        mode:
          $ref: '#/components/schemas/CheckpointMode'
          description: Base or incremental state.
        page_ids:
          type: array
          items:
            type: string
          description: Complete ordered pages; never an unbounded inline manifest.
        pin:
          $ref: '#/components/schemas/CheckpointPin'
          description: Current writer/reader pin.
        replayed:
          type: boolean
          description: Immutable plan replay.
        repository:
          type: string
          description: Repository identity selected by native task authority.
        toolbox_digest:
          type: string
          description: Host-local toolbox compatibility.
    CheckpointPlaintext:
      type: object
      description: >-
        Trusted capture's plaintext descriptor; no storage key is
        caller-selected.
      required:
        - sha256
        - size
        - kind
      properties:
        kind:
          type: string
          description: Declared file, Git or history bytes.
        sha256:
          type: string
          description: Private plaintext SHA-256, verified again after decryption.
        size:
          type: integer
          format: int64
          description: Bounded plaintext chunk length.
          minimum: 0
      additionalProperties: false
    CheckpointObjectStatus:
      type: string
      description: Native registration disposition.
      enum:
        - missing
        - reused
        - busy
    CheckpointTransfer:
      type: object
      description: Exact scoped transfer material, redacted from debug output.
      required:
        - url
        - headers
        - expires_at
      properties:
        expires_at:
          type: string
          format: date-time
          description: Deadline shared with native pin custody.
        headers:
          type: object
          description: Exact signed headers; create-only uploads cannot omit them.
          additionalProperties:
            type: string
          propertyNames:
            type: string
        url:
          type: string
          description: Short-lived supervisor-only URL.
    CheckpointMode:
      type: string
      description: A verified base is retained separately from task recovery pointers.
      enum:
        - retain_base
        - incremental
    CheckpointPin:
      type: object
      description: >-
        One capture or restore operation, renewed without extending its
        deadline.
      required:
        - id
        - resource_version
        - operation_deadline
        - expires_at
      properties:
        expires_at:
          type: string
          format: date-time
          description: Current liveness deadline.
        id:
          type: string
          description: Native pin identity.
        operation_deadline:
          type: string
          format: date-time
          description: Hard operation deadline.
        resource_version:
          type: integer
          format: int64
          description: Compare-and-swap version for renewal.
          minimum: 0
  securitySchemes:
    RunnerBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: agt_r
      description: >-
        Runner token beginning with agt_r, returned once by POST
        /v1/admin/runners

````

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