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

# List paused resources

> Lists the workflows and vault credentials that are paused in the workspace, including a pause set by an error code with the `pause_workflow` or `pause_credential` [action](/concepts/maintenance-agent#error-code-actions) and a workflow held by a closed [run window](/concepts/run-window).

Each key is the internal pause key: `dispatcher:pause:workflow:<workspace_id>:<workflow_id>` for a workflow and `dispatcher:pause:credential:<workspace_id>:<permissioned_user_id>:<domain>` for a credential. Use the IDs inside the key with [`POST /runs/unpause`](/run-api/unpause-runs). For a pause set by an error code, `paused_by_user_id` is `error_code` and `reason` names the code.



## OpenAPI

````yaml run-api/run-api.yaml get /runs/paused
openapi: 3.1.0
info:
  title: CloudCruise Run API
  version: 0.1.0
  description: >-
    Endpoints for managing workflow executions, user interactions, and
    retrieving execution results.
servers:
  - url: https://api.cloudcruise.com
    description: CloudCruise Platform Production API Server
security:
  - AuthScheme: []
paths:
  /runs/paused:
    get:
      summary: List paused resources
      description: >-
        Lists the workflows and vault credentials that are paused in the
        workspace, including a pause set by an error code with the
        `pause_workflow` or `pause_credential`
        [action](/concepts/maintenance-agent#error-code-actions) and a workflow
        held by a closed [run window](/concepts/run-window).


        Each key is the internal pause key:
        `dispatcher:pause:workflow:<workspace_id>:<workflow_id>` for a workflow
        and
        `dispatcher:pause:credential:<workspace_id>:<permissioned_user_id>:<domain>`
        for a credential. Use the IDs inside the key with [`POST
        /runs/unpause`](/run-api/unpause-runs). For a pause set by an error
        code, `paused_by_user_id` is `error_code` and `reason` names the code.
      operationId: get_paused_resources
      responses:
        '200':
          description: The paused workflows and credentials
          content:
            application/json:
              schema:
                type: object
                properties:
                  pausedWorkflows:
                    type: object
                    description: Paused workflows, keyed by pause key
                    additionalProperties:
                      $ref: '#/components/schemas/PauseData'
                  pausedCredentials:
                    type: object
                    description: Paused vault credentials, keyed by pause key
                    additionalProperties:
                      $ref: '#/components/schemas/PauseData'
              example:
                pausedWorkflows:
                  dispatcher:pause:workflow:<workspace_id>:11223344-5566-7788-9900-112233445566:
                    paused_at: 1763000000000
                    paused_by_user_id: error_code
                    reason: Paused by error code PORTAL_LOCKED
                    source: manual
                pausedCredentials: {}
components:
  schemas:
    PauseData:
      type: object
      properties:
        paused_at:
          type: integer
          description: When the pause started, in milliseconds since the epoch
        paused_by_user_id:
          type: string
          description: >-
            The user or API key that paused it, or `error_code` for a pause set
            by an error code
        reason:
          type: string
          description: Why it is paused
        source:
          type: string
          enum:
            - manual
            - run_window
          description: >-
            `run_window` is a hold from a closed run window; everything else is
            `manual`
        expire_existing_sessions:
          type: boolean
          description: >-
            Credentials only. Whether the credential's saved browser data is
            cleared when it is unpaused
        resumes_at:
          type: integer
          nullable: true
          description: When a run-window hold ends, in milliseconds since the epoch
        time_zone:
          type: string
          description: The run window's time zone
  securitySchemes:
    AuthScheme:
      type: apiKey
      name: cc-key
      in: header
      description: >-
        API key-based authentication. Provide your CloudCruise API key in the
        cc-key header.

````

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