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

# List scenarios



## OpenAPI

````yaml /0.16/openapi.json get /api/v1/scenarios
openapi: 3.0.3
info:
  title: 2501 Public API
  version: v1
  description: >-
    The stable, versioned HTTP API for driving 2501 as code. See the API
    Overview for authentication, the org_id rule, cursor pagination, and the
    error envelope.
servers:
  - url: https://{command_center_host}
    variables:
      command_center_host:
        default: your-command-center-host
        description: Your Command Center host
security:
  - bearerAuth: []
paths:
  /api/v1/scenarios:
    get:
      tags:
        - Scenarios
      summary: List scenarios
      parameters:
        - schema:
            type: string
            default: '25'
          required: false
          name: limit
          in: query
        - schema:
            type: string
          required: false
          name: starting_after
          in: query
        - schema:
            type: string
          required: false
          name: ending_before
          in: query
        - schema:
            anyOf:
              - type: string
                enum:
                  - total_count
              - type: array
                items:
                  type: string
                  enum:
                    - total_count
          required: false
          name: include
          in: query
        - schema:
            type: string
          required: true
          name: org_id
          in: query
      responses:
        '200':
          description: A page of the organization's scenarios
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScenarioList'
        '400':
          description: >-
            Bad request - a field is missing, malformed, or not allowed
            (VALIDATION_FAILED, BAD_REQUEST, INVALID_CURSOR)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: >-
            No credentials, or a key that is invalid, revoked, or expired
            (UNAUTHORIZED)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            Authenticated but not allowed (FORBIDDEN, ORG_ACCESS_DENIED,
            STEP_UP_REFUSED, TWO_FACTOR_ENROLLMENT_REQUIRED,
            LICENSE_CAP_REACHED, LICENSE_EXPIRED)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    ScenarioList:
      type: object
      properties:
        object:
          type: string
          enum:
            - list
        data:
          type: array
          items:
            $ref: '#/components/schemas/Scenario'
        has_more:
          type: boolean
        total_count:
          type: integer
          description: Present only when include=total_count is set
      required:
        - object
        - data
        - has_more
    Error:
      type: object
      properties:
        code:
          type: string
          example: VALIDATION_FAILED
        message:
          type: string
          example: Validation failed
        request_id:
          type: string
          example: req_3702b7e7-...
        field:
          type: string
          description: Set when one input is at fault
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
            required:
              - field
              - message
          description: Set when several inputs are at fault
        details:
          type: object
          additionalProperties:
            nullable: true
      required:
        - code
        - message
        - request_id
    Scenario:
      type: object
      properties:
        id:
          type: string
          example: scn_af30b030-...
        title:
          type: string
          example: nginx down
        description:
          type: string
        tags:
          type: array
          items:
            type: string
        ticket_title:
          type: string
        ticket_body:
          type: string
        vars:
          type: object
          additionalProperties:
            type: string
        prepare:
          type: array
          items:
            type: object
            additionalProperties:
              nullable: true
          description: >-
            Ordered shell commands, each `{ run, on? }`, in the shape `POST
            /api/v1/scenarios` accepts.
        restore:
          type: array
          items:
            type: object
            additionalProperties:
              nullable: true
          description: >-
            Ordered shell commands, each `{ run, on? }`, in the shape `POST
            /api/v1/scenarios` accepts.
        validation:
          type: array
          items:
            anyOf:
              - type: object
                properties:
                  label:
                    type: string
                    minLength: 1
                  required:
                    type: boolean
                  validator:
                    type: string
                    enum:
                      - pattern_match
                  pattern:
                    type: string
                    minLength: 1
                  where:
                    type: string
                    enum:
                      - task_summary
                      - task_description
                      - executed_commands
                      - write_file
                      - update_file
                      - use_mcp_tool
                      - tool_calls
                      - agent_messages
                      - operational_rules
                      - task_plan
                      - job_resolution
                      - job_plan
                      - gateway_messages
                      - gateway_summary
                  negate:
                    type: boolean
                required:
                  - label
                  - validator
                  - pattern
                  - where
                additionalProperties: false
              - type: object
                properties:
                  label:
                    type: string
                    minLength: 1
                  required:
                    type: boolean
                  validator:
                    type: string
                    enum:
                      - task_count
                  min:
                    type: integer
                    minimum: 0
                  max:
                    type: integer
                    minimum: 0
                required:
                  - label
                  - validator
                additionalProperties: false
              - type: object
                properties:
                  label:
                    type: string
                    minLength: 1
                  required:
                    type: boolean
                  validator:
                    type: string
                    enum:
                      - job_resolution_status
                  statuses:
                    type: array
                    items:
                      type: string
                      enum:
                        - success
                        - partial
                        - no_action
                        - agentic_failure
                        - hard_failure
                    minItems: 1
                required:
                  - label
                  - validator
                  - statuses
                additionalProperties: false
              - type: object
                properties:
                  label:
                    type: string
                    minLength: 1
                  required:
                    type: boolean
                  validator:
                    type: string
                    enum:
                      - host_state
                  run:
                    type: string
                    minLength: 1
                  'on':
                    type: string
                    minLength: 1
                  exit_code:
                    type: integer
                required:
                  - label
                  - validator
                  - run
                additionalProperties: false
              - type: object
                properties:
                  name:
                    type: string
                    minLength: 1
                  run:
                    type: string
                    minLength: 1
                  'on':
                    type: string
                    minLength: 1
                  exit_code:
                    type: integer
                required:
                  - run
                additionalProperties: false
        status:
          type: string
          enum:
            - draft
            - published
            - disabled
        hosts:
          type: array
          items:
            type: string
          example:
            - web-01
        agents:
          type: array
          items:
            type: string
          example:
            - agent-linux-1
        agent_hosts:
          type: object
          additionalProperties:
            type: string
          description: Agent name to the host it is attached to
        agent_info:
          type: object
          additionalProperties:
            type: object
            properties:
              host:
                type: string
                nullable: true
              specialty:
                type: string
                nullable: true
            required:
              - host
              - specialty
        org_id:
          type: string
          example: org_460b541c-...
        tenant_id:
          type: string
          example: ten_115bea44-...
        created_at:
          type: string
          format: date-time
          example: '2026-08-26T10:00:26.380Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-08-26T10:00:26.380Z'
      required:
        - id
        - title
        - description
        - tags
        - ticket_title
        - ticket_body
        - vars
        - prepare
        - restore
        - validation
        - status
        - hosts
        - agents
        - agent_hosts
        - agent_info
        - org_id
        - tenant_id
        - created_at
        - updated_at
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key minted in Command Center (Settings -> API Keys), sent as
        `Authorization: Bearer 2501_ak_...`. A Command Center session cookie is
        also accepted.

````

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