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

# List resource operations

> List resource operations through the Towbar REST API.

Required permissions: resource.read. Personal keys are capped by their owner’s current team role.

See [request conventions](/docs/api/overview) and [automation workflows](/docs/api/workflows). MCP clients use the task-oriented [tool catalogue](/docs/api/mcp-tools).


## OpenAPI

````yaml api-reference/openapi.json GET /resources/{resourceId}/operations
openapi: 3.1.0
info:
  title: Towbar API
  version: 2.0.0
  description: >-
    Manage your Towbar control plane with a bearer API key. Keys inherit current
    workspace permissions.
servers:
  - url: https://api.example.com/v1/api
security: []
paths:
  /resources/{resourceId}/operations:
    get:
      tags:
        - Resources / Runtime & logs
      summary: List resource operations
      description: >-
        Required permissions: resource.read. Personal keys are capped by the
        current member role; team keys use explicit grants.
      operationId: get_resources_by_id_operations
      parameters:
        - name: resourceId
          in: path
          required: true
          schema:
            $schema: https://json-schema.org/draft/2020-12/schema
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
      responses:
        '200':
          description: JSON object containing operations.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Response_338'
                  - type: object
                    properties:
                      localization:
                        $schema: https://json-schema.org/draft/2020-12/schema
                        type: object
                        properties:
                          dateFormat:
                            type: string
                            enum:
                              - day-short-month-year
                              - short-month-day-year
                              - year-month-day
                              - day-month-year
                              - month-day-year
                          timeFormat:
                            type: string
                            enum:
                              - 24-hour
                              - 12-hour
                              - 24-hour-seconds
                              - 12-hour-seconds
                          timeZone:
                            type: string
                          timestamps:
                            type: object
                            propertyNames:
                              type: string
                            additionalProperties:
                              type: object
                              properties:
                                date:
                                  type: string
                                time:
                                  type:
                                    - string
                                    - 'null'
                                dateTime:
                                  type:
                                    - string
                                    - 'null'
                                timeZone:
                                  type: string
                                zoneLabel:
                                  type: string
                                epochMilliseconds:
                                  type: number
                                inputDateTime:
                                  type:
                                    - string
                                    - 'null'
                              required:
                                - date
                                - time
                                - dateTime
                                - timeZone
                                - zoneLabel
                                - epochMilliseconds
                                - inputDateTime
                              additionalProperties: false
                        required:
                          - dateFormat
                          - timeFormat
                          - timeZone
                          - timestamps
                        additionalProperties: false
                    required:
                      - localization
        '400':
          $ref: '#/components/responses/ApiError'
        '401':
          $ref: '#/components/responses/ApiError'
        '403':
          $ref: '#/components/responses/ApiError'
        '404':
          $ref: '#/components/responses/ApiError'
        '409':
          $ref: '#/components/responses/ApiError'
        '413':
          $ref: '#/components/responses/ApiError'
        '422':
          $ref: '#/components/responses/ApiError'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ApiError'
      security:
        - bearerAuth: []
components:
  schemas:
    Response_338:
      type: object
      properties:
        operations:
          type: array
          items:
            $ref: '#/components/schemas/Response_209'
      required:
        - operations
    Response_209:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
        deletedAt:
          anyOf:
            - type: 'null'
            - type: string
              format: date-time
        errorCode:
          anyOf:
            - type: 'null'
            - type: string
        errorMessage:
          anyOf:
            - type: 'null'
            - type: string
        finishedAt:
          anyOf:
            - type: 'null'
            - type: string
              format: date-time
        id:
          type: string
        requestedBy:
          anyOf:
            - type: 'null'
            - type: string
        phase:
          anyOf:
            - type: 'null'
            - type: string
              const: queued
            - type: string
              const: cleaning_up
            - type: string
              const: succeeded
            - type: string
              const: failed
            - type: string
              const: cancelled
            - type: string
              const: preflight
            - type: string
              const: downloading_backup
            - type: string
              const: verifying_backup
            - type: string
              const: preparing_candidate
            - type: string
              const: restoring_candidate
            - type: string
              const: validating_candidate
            - type: string
              const: promoting
            - type: string
              const: verifying_promotion
            - type: string
              const: rolling_back
            - type: string
              const: retaining_previous
        cancelRequestedAt:
          anyOf:
            - type: 'null'
            - type: string
              format: date-time
        request:
          anyOf:
            - $ref: '#/components/schemas/Response_210'
            - $ref: '#/components/schemas/Response_212'
            - $ref: '#/components/schemas/Response_213'
            - $ref: '#/components/schemas/Response_214'
            - $ref: '#/components/schemas/Response_216'
            - $ref: '#/components/schemas/Response_217'
            - $ref: '#/components/schemas/Response_218'
        resourceId:
          anyOf:
            - type: 'null'
            - type: string
        result:
          anyOf:
            - type: 'null'
            - $ref: '#/components/schemas/Response_219'
            - $ref: '#/components/schemas/BackupOperationResult_220'
            - $ref: '#/components/schemas/Response_222'
            - $ref: '#/components/schemas/Response_223'
            - $ref: '#/components/schemas/Response_224'
            - $ref: '#/components/schemas/Response_228'
            - $ref: '#/components/schemas/Response_229'
        serverId:
          type: string
        sourceId:
          anyOf:
            - type: 'null'
            - type: string
        startedAt:
          anyOf:
            - type: 'null'
            - type: string
              format: date-time
        state:
          anyOf:
            - type: string
              const: running
            - type: string
              const: queued
            - type: string
              const: succeeded
            - type: string
              const: failed
            - type: string
              const: cancelled
        type:
          anyOf:
            - type: string
              const: backup
            - type: string
              const: restore
            - type: string
              const: start
            - type: string
              const: capture_logs
            - type: string
              const: run_job
            - type: string
              const: cleanup_orphans
            - type: string
              const: restart
            - type: string
              const: restore_cleanup
            - type: string
              const: stop
        updatedAt:
          type: string
          format: date-time
      required:
        - createdAt
        - deletedAt
        - errorCode
        - errorMessage
        - finishedAt
        - id
        - requestedBy
        - phase
        - cancelRequestedAt
        - request
        - resourceId
        - result
        - serverId
        - sourceId
        - startedAt
        - state
        - type
        - updatedAt
    Response_210:
      type: object
      properties:
        release:
          $ref: '#/components/schemas/ResourceReleaseSnapshot_211'
        type:
          type: string
          const: run_job
        job:
          $ref: '#/components/schemas/Response_140'
        scheduledAt:
          anyOf:
            - type: 'null'
            - type: string
      required:
        - release
        - type
        - job
        - scheduledAt
    Response_212:
      type: object
      properties:
        release:
          $ref: '#/components/schemas/ResourceReleaseSnapshot_211'
        type:
          type: string
          const: backup
      required:
        - release
        - type
    Response_213:
      type: object
      properties:
        release:
          $ref: '#/components/schemas/ResourceReleaseSnapshot_211'
        runtime:
          anyOf:
            - type: string
              const: ingress
            - type: string
              const: workload
        service:
          type: string
        tail:
          type: number
        type:
          type: string
          const: capture_logs
      required:
        - release
        - tail
        - type
    Response_214:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Response_215'
        type:
          type: string
          const: cleanup_orphans
      required:
        - items
        - type
    Response_216:
      type: object
      properties:
        backupId:
          type: string
        reason:
          type: string
        release:
          $ref: '#/components/schemas/ResourceReleaseSnapshot_211'
        type:
          type: string
          const: restore
      required:
        - backupId
        - reason
        - release
        - type
    Response_217:
      type: object
      properties:
        restoreId:
          type: string
        release:
          $ref: '#/components/schemas/ResourceReleaseSnapshot_211'
        type:
          type: string
          const: restore_cleanup
        volumes:
          type: array
          items:
            type: string
      required:
        - restoreId
        - release
        - type
        - volumes
    Response_218:
      type: object
      properties:
        release:
          $ref: '#/components/schemas/ResourceReleaseSnapshot_211'
        service:
          type: string
        type:
          anyOf:
            - type: string
              const: start
            - type: string
              const: restart
            - type: string
              const: stop
      required:
        - release
        - type
    Response_219:
      type: object
      properties:
        jobName:
          type: string
        exitCode:
          type: number
        timedOut:
          type: boolean
        logs:
          type: string
        truncated:
          type: boolean
      required:
        - jobName
        - exitCode
        - timedOut
        - logs
        - truncated
    BackupOperationResult_220:
      type: object
      properties:
        backupClass:
          type: string
          const: database
        backupId:
          type: string
        bucket:
          type: string
        checksum:
          type: string
        deletedBackupIds:
          type: array
          items:
            type: string
        destinations:
          type: array
          items:
            $ref: '#/components/schemas/BackupDestinationResult_221'
        encryption:
          type: string
        engine:
          anyOf:
            - type: string
              const: postgres
            - type: string
              const: mysql
            - type: string
              const: mariadb
            - type: string
              const: mongodb
            - type: string
              const: redis
            - type: string
              const: dragonfly
            - type: string
              const: keydb
            - type: string
              const: clickhouse
        engineMajorVersion:
          type: number
        format:
          anyOf:
            - type: string
              const: clickhouse-backup
            - type: string
              const: dragonfly-rdb
            - type: string
              const: keydb-rdb
            - type: string
              const: mariadb-sql
            - type: string
              const: mongodb-archive
            - type: string
              const: mysql-sql
            - type: string
              const: postgres-custom
            - type: string
              const: redis-rdb
        key:
          type: string
        metadataVersion:
          type: number
          const: 1
        objectVersionId:
          type: string
        region:
          type: string
        restoreFrom:
          anyOf:
            - type: string
              const: s3
            - type: string
              const: r2
            - type: string
              const: gcs
            - type: string
              const: azureBlob
        sizeBytes:
          type: number
        storageAccount:
          type: string
        verifiedAt:
          type: string
        warnings:
          type: array
          items:
            type: string
      required:
        - backupId
        - bucket
        - checksum
        - deletedBackupIds
        - encryption
        - key
        - sizeBytes
        - verifiedAt
        - warnings
    Response_222:
      type: object
      properties:
        cleaned:
          type: array
          items:
            $ref: '#/components/schemas/Response_215'
        skipped:
          type: array
          items:
            $ref: '#/components/schemas/Response_215'
      required:
        - cleaned
        - skipped
    Response_223:
      type: object
      properties:
        logs:
          type: string
        truncated:
          type: boolean
      required:
        - logs
        - truncated
    Response_224:
      type: object
      properties:
        activeVolumes:
          type: array
          items:
            $ref: '#/components/schemas/Response_225'
        candidateCleaned:
          type: boolean
        outcome:
          anyOf:
            - type: string
              const: promoted
            - type: string
              const: candidate_failed
            - type: string
              const: rolled_back
            - type: string
              const: rollback_failed
        previousVolumes:
          type: array
          items:
            $ref: '#/components/schemas/Response_226'
        restoredBackupId:
          type: string
        rollbackAvailableUntil:
          anyOf:
            - type: 'null'
            - type: string
        validation:
          anyOf:
            - type: 'null'
            - $ref: '#/components/schemas/Response_227'
        verifiedAt:
          anyOf:
            - type: 'null'
            - type: string
      required:
        - activeVolumes
        - candidateCleaned
        - outcome
        - previousVolumes
        - restoredBackupId
        - rollbackAvailableUntil
        - validation
        - verifiedAt
    Response_228:
      type: object
      properties:
        cleanedVolumes:
          type: array
          items:
            type: string
        restoreId:
          type: string
        skippedVolumes:
          type: array
          items:
            type: string
      required:
        - cleanedVolumes
        - restoreId
        - skippedVolumes
    Response_229:
      type: object
      properties:
        state:
          anyOf:
            - type: string
              const: running
            - type: string
              const: stopped
      required:
        - state
    ResourceReleaseSnapshot_211:
      type: object
      properties:
        containerName:
          type: string
        imageTag:
          type: string
        releaseId:
          type: string
      required:
        - containerName
        - imageTag
        - releaseId
    Response_140:
      type: object
      properties:
        name:
          type: string
        command:
          type: array
          items:
            type: string
        schedule:
          $ref: '#/components/schemas/Response_141'
        timeoutSeconds:
          type: number
        enabled:
          type: boolean
        description:
          type: string
      required:
        - name
        - command
        - schedule
        - timeoutSeconds
        - enabled
    Response_215:
      type: object
      properties:
        kind:
          anyOf:
            - type: string
              const: image
            - type: string
              const: container
            - type: string
              const: volume
        name:
          type: string
        reason:
          type: string
      required:
        - kind
        - name
        - reason
    BackupDestinationResult_221:
      type: object
      properties:
        bucket:
          type: string
        encryption:
          type: string
        key:
          type: string
        objectVersion:
          type: string
        provider:
          anyOf:
            - type: string
              const: s3
            - type: string
              const: r2
            - type: string
              const: gcs
            - type: string
              const: azureBlob
        region:
          type: string
        storageAccount:
          type: string
      required:
        - bucket
        - key
        - provider
    Response_225:
      type: object
      properties:
        logicalName:
          type: string
        volumeName:
          type: string
      required:
        - logicalName
        - volumeName
    Response_226:
      type: object
      properties:
        logicalName:
          type: string
        volumeName:
          type: string
      required:
        - logicalName
        - volumeName
    Response_227:
      type: object
      properties:
        databaseName:
          anyOf:
            - type: 'null'
            - type: string
        engine:
          anyOf:
            - type: string
              const: postgres
            - type: string
              const: mysql
            - type: string
              const: mariadb
            - type: string
              const: mongodb
            - type: string
              const: redis
            - type: string
              const: dragonfly
            - type: string
              const: keydb
            - type: string
              const: clickhouse
        engineMajorVersion:
          type: number
        healthVerified:
          type: boolean
        readable:
          type: boolean
      required:
        - databaseName
        - engine
        - engineMajorVersion
        - healthVerified
        - readable
    Response_141:
      type: object
      properties:
        cron:
          type: string
        timezone:
          type: string
          const: UTC
      required:
        - cron
        - timezone
  responses:
    ApiError:
      description: Request failed. The error object contains code, message, and requestId.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                required:
                  - code
                  - message
                  - requestId
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  requestId:
                    type: string
    RateLimited:
      description: Request failed. The error object contains code, message, and requestId.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                required:
                  - code
                  - message
                  - requestId
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  requestId:
                    type: string
      headers:
        Retry-After:
          description: Seconds before retrying
          schema:
            type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Towbar API key

````