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

# Read current Tool capacity

> Requires `read`. Returns current lifetime/resource bounds and capacity observations. Does not reserve capacity. Pausing retains the instance’s capacity slot and expiry.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/service-policy
openapi: 3.1.0
info:
  title: Firedrill API
  version: '2026-10-14'
  description: >-
    Authenticated simulation coordination, retained evidence and controlled
    Tools. Your customer-owned runner executes the target. This reference covers
    the documented JSON workflows; Tool-native HTTP routes and MCP methods are
    discovered from the selected Tool. Structural schemas do not replace
    canonical validation or capability checks.
servers:
  - url: https://api.firedrill.run
security:
  - FiredrillCredential: []
tags:
  - name: discovery
    description: Capabilities, authority and structural authoring schemas.
  - name: projects
    description: Projects and their logical environment.
  - name: simulations
    description: Preparation, queued batches and cancellation.
  - name: runs
    description: Individual recorded executions.
  - name: reports
    description: Retained observations, distributions and descriptive comparisons.
  - name: assessment
    description: Optional semantic assessment and authored scenario ranking.
  - name: evidence
    description: Authenticated captured files.
  - name: runner-protocol
    description: Advanced customer-runner coordination; native SDKs manage this protocol.
  - name: scenarios
    description: Immutable retained versions of repository-authored scenarios.
  - name: credentials
    description: Expiring scoped CI credentials.
  - name: authentication
    description: Human-approved sign-in boundaries.
  - name: tools
    description: Tool releases, data, instances and observations.
  - name: tool-connections
    description: Bounded target/manual grants, separate from control authority.
  - name: tool-lifecycle
    description: Epoch-fenced reusable Tool actions and exact-key recovery.
paths:
  /v1/service-policy:
    get:
      tags:
        - tools
      summary: Read current Tool capacity
      description: >-
        Requires `read`. Returns current lifetime/resource bounds and capacity
        observations. Does not reserve capacity. Pausing retains the instance’s
        capacity slot and expiry.
      operationId: tools_get_policy
      parameters:
        - name: projectId
          in: query
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 160
        - name: environmentId
          in: query
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 160
      responses:
        '200':
          description: The retained resource or operation response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServicePolicy'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '410':
          $ref: '#/components/responses/Gone'
        '413':
          $ref: '#/components/responses/PayloadTooLarge'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '422':
          $ref: '#/components/responses/InvalidInput'
        '429':
          $ref: '#/components/responses/Capacity'
        '500':
          $ref: '#/components/responses/Internal'
        '503':
          $ref: '#/components/responses/Unavailable'
components:
  schemas:
    ServicePolicy:
      type: object
      properties:
        limits:
          type: object
          properties:
            defaultTtlSeconds:
              type: number
            maxTtlSeconds:
              type: number
            maxActiveInstances:
              type: number
          required:
            - defaultTtlSeconds
            - maxTtlSeconds
            - maxActiveInstances
        resourceEnvelope:
          anyOf:
            - $ref: '#/components/schemas/ServiceResourceEnvelope'
      required:
        - limits
    ServiceResourceEnvelope:
      type: object
      properties:
        schemaVersion:
          type: string
          const: 2026-10-17-tool-resources.1
        basis:
          type: string
          const: enforced_configuration_not_measured_usage
        runtime:
          type: object
          properties:
            wasmLinearMemoryLimitBytes:
              type: number
            stackLimitBytes:
              type: number
            operationTimeLimitMs:
              type: number
            initializationTimeLimitMs:
              type: number
            hostCallsPerOperation:
              type: number
            inputLimitBytes:
              type: number
            outputLimitBytes:
              type: number
            artifactLimitBytes:
              type: number
            reinstantiationsPerMinute:
              type: number
            sessionTimeBudget:
              type: object
              properties:
                windowMs:
                  type: number
                admissionLimitMs:
                  type: number
                accounting:
                  type: string
                  const: elapsed_handler_time_not_os_cpu
                scope:
                  type: string
                  const: instance_process_lifetime
                inFlightMayExceedBudget:
                  type: boolean
                  const: true
              required:
                - windowMs
                - admissionLimitMs
                - accounting
                - scope
                - inFlightMayExceedBudget
          required:
            - wasmLinearMemoryLimitBytes
            - stackLimitBytes
            - operationTimeLimitMs
            - initializationTimeLimitMs
            - hostCallsPerOperation
            - inputLimitBytes
            - outputLimitBytes
            - artifactLimitBytes
            - reinstantiationsPerMinute
            - sessionTimeBudget
        build:
          type: object
          properties:
            maxConcurrent:
              type: number
            timeoutMs:
              type: number
            submittedSourceLimitBytes:
              type: number
            workerV8OldSpaceLimitBytes:
              type: number
            workerOutputLimitBytes:
              type: number
          required:
            - maxConcurrent
            - timeoutMs
            - submittedSourceLimitBytes
            - workerV8OldSpaceLimitBytes
            - workerOutputLimitBytes
        estimate:
          type: object
          properties:
            basis:
              type: string
              const: one_new_instance_configured_ceiling
            instanceSlots:
              type: number
            defaultLifetimeSeconds:
              type: number
            wasmLinearMemoryCeilingBytes:
              type: number
            measuredCpuMs:
              type: 'null'
            measuredMemoryBytes:
              type: 'null'
            reserved:
              type: boolean
              const: false
          required:
            - basis
            - instanceSlots
            - defaultLifetimeSeconds
            - wasmLinearMemoryCeilingBytes
            - measuredCpuMs
            - measuredMemoryBytes
            - reserved
        limitations:
          type: array
          items:
            type: string
      required:
        - schemaVersion
        - basis
        - runtime
        - build
        - estimate
        - limitations
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            repair:
              type: string
            requestId:
              type: string
            details:
              anyOf:
                - type: 'null'
                - type: string
                - type: number
                - type: boolean
                  const: false
                - type: boolean
                  const: true
                - type: array
                  items:
                    $ref: '#/components/schemas/JsonValue'
                - type: object
                  properties: {}
                  required: []
                  additionalProperties:
                    $ref: '#/components/schemas/JsonValue'
            validation:
              anyOf:
                - $ref: '#/components/schemas/ValidationDiagnostics'
          required:
            - code
            - message
            - repair
            - requestId
      required:
        - error
    JsonValue:
      description: >-
        Any JSON value: null, boolean, finite number, string, array or object.
        The request transport must contain valid JSON; canonical validation
        rejects nonfinite numbers.
    ValidationDiagnostics:
      type: object
      properties:
        issues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
        totalIssues:
          type: number
        omittedIssues:
          type: number
      required:
        - issues
        - totalIssues
        - omittedIssues
    ValidationIssue:
      type: object
      properties:
        path:
          type: array
          items:
            anyOf:
              - type: string
              - type: number
        code:
          type: string
        message:
          type: string
        pathTruncated:
          anyOf:
            - type: boolean
              const: true
      required:
        - path
        - code
        - message
  responses:
    BadRequest:
      description: >-
        Malformed request or missing operation key. Repair the input before
        retrying.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: >-
        Missing, expired or revoked authority. Complete supported sign-in or use
        an authorized credential.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Forbidden:
      description: >-
        The current capability, actor, audience or ownership grant does not
        allow this operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: The exact resource is unavailable under the current authority and scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Conflict:
      description: >-
        Selected context, epoch, revision, lease or saved operation intent
        conflicts; inspect retained state.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Gone:
      description: >-
        Retained content is expired, deleted or unavailable under its retention
        fence. Metadata is not a replacement payload.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    PayloadTooLarge:
      description: >-
        Request, response or retained-resource size exceeds this operation’s
        enforced bound.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    UnsupportedMediaType:
      description: Send the documented JSON or exact artifact media type.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    InvalidInput:
      description: >-
        Input failed canonical validation. Inspect error.validation and repair
        the indicated fields.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Capacity:
      description: >-
        Bounded capacity or resource admission rejected the operation. Inspect
        retained work before retrying.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Internal:
      description: >-
        The service could not complete the request. Inspect retained state
        before exact-key recovery.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unavailable:
      description: >-
        A required service, provider or authority check is unavailable. Existing
        evidence remains separate from this failure.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    FiredrillCredential:
      type: http
      scheme: bearer
      description: >-
        Opaque Firedrill interactive or scoped machine credential. The CLI
        handles human-approved login; CI stores its scoped credential as
        FIREDRILL_TOKEN. Capabilities and project/environment ownership are
        rechecked at use.

````

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