Flatfile

Flatfile subpackage_runbooks API

The subpackage_runbooks API from Flatfile — 2 operation(s) for subpackage_runbooks.

GitHub OpenAPI

Operations 5

GET /runbooks List runbooks #
POST /runbooks Create a runbook #
GET /runbooks/{runbookId} Get a runbook #
PATCH /runbooks/{runbookId} Update a runbook #
DELETE /runbooks/{runbookId} Delete a runbook #

Documentation

📖
Documentation
https://flatfile.com/docs/
📖
APIReference
https://reference.flatfile.com/
📖
GettingStarted
https://flatfile.com/docs/quickstart

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/flatfile/refs/heads/main/openapi/flatfile-subpackage-runbooks-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/flatfile-subpackage-runbooks-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

flatfile-subpackage-runbooks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Reference subpackage_accounts Subpackage Runbooks API
  version: 1.0.0
servers:
- url: https://api.x.flatfile.com/v1
tags:
- name: subpackage_runbooks
paths:
  /runbooks:
    get:
      operationId: list
      summary: List runbooks
      description: Returns a list of runbooks
      tags:
      - subpackage_runbooks
      parameters:
      - name: appId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons_AppId'
      - name: environmentId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons_EnvironmentId'
      - name: spaceId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons_SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_runbooks_RunbooksResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
    post:
      operationId: create
      summary: Create a runbook
      description: Creates a new runbook
      tags:
      - subpackage_runbooks
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_runbooks_RunbookResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_runbooks_CreateRunbookRequest'
  /runbooks/{runbookId}:
    get:
      operationId: get
      summary: Get a runbook
      description: Returns a runbook
      tags:
      - subpackage_runbooks
      parameters:
      - name: runbookId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_RunbookId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_runbooks_RunbookResponse'
    patch:
      operationId: update
      summary: Update a runbook
      description: Updates a runbook
      tags:
      - subpackage_runbooks
      parameters:
      - name: runbookId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_RunbookId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_runbooks_RunbookResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_runbooks_UpdateRunbookRequest'
    delete:
      operationId: delete
      summary: Delete a runbook
      description: Deletes a runbook
      tags:
      - subpackage_runbooks
      parameters:
      - name: runbookId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_RunbookId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
components:
  schemas:
    type_runbooks_Runbook:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons_RunbookId'
          description: The ID of the Runbook.
        accountId:
          $ref: '#/components/schemas/type_commons_AccountId'
        appId:
          $ref: '#/components/schemas/type_commons_AppId'
        environmentId:
          $ref: '#/components/schemas/type_commons_EnvironmentId'
        spaceId:
          $ref: '#/components/schemas/type_commons_SpaceId'
        name:
          type: string
          description: The name of the Runbook.
        config:
          $ref: '#/components/schemas/type_runbooks_RunbookConfig'
          description: The configuration of the Runbook.
        status:
          $ref: '#/components/schemas/type_runbooks_RunbookStatus'
          description: The status of the Runbook.
        type:
          $ref: '#/components/schemas/type_runbooks_RunbookType'
          description: The type of the Runbook.
        createdBy:
          type: string
          description: The entity which created the Runbook.
        createdAt:
          type: string
          format: date-time
          description: Date the sheet was created
        updatedAt:
          type: string
          format: date-time
          description: Date the sheet was last updated
      required:
      - id
      - accountId
      - appId
      - environmentId
      - spaceId
      - name
      - config
      - status
      - type
      - createdBy
      - createdAt
      - updatedAt
      description: Runbook
      title: Runbook
    type_commons_Errors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/type_commons_Error'
      required:
      - errors
      title: Errors
    type_commons_SpaceId:
      type: string
      description: Space ID
      title: SpaceId
    type_runbooks_SheetTransformConfig:
      type: object
      properties:
        sourceSheetIds:
          type: array
          items:
            type: string
          description: The ids of the sourceSheets to transform
        destinationSheetIds:
          type: array
          items:
            type: string
          description: The id of the destinationSheet to transform
      required:
      - sourceSheetIds
      - destinationSheetIds
      title: SheetTransformConfig
    type_runbooks_CreateRunbookRequest:
      type: object
      properties:
        accountId:
          $ref: '#/components/schemas/type_commons_AccountId'
        appId:
          $ref: '#/components/schemas/type_commons_AppId'
        environmentId:
          $ref: '#/components/schemas/type_commons_EnvironmentId'
        spaceId:
          $ref: '#/components/schemas/type_commons_SpaceId'
        name:
          type: string
          description: The name of the Runbook.
        config:
          $ref: '#/components/schemas/type_runbooks_RunbookConfig'
          description: The configuration of the Runbook.
        status:
          $ref: '#/components/schemas/type_runbooks_RunbookStatus'
          description: The status of the Runbook.
        type:
          $ref: '#/components/schemas/type_runbooks_RunbookType'
          description: The type of the Runbook.
      required:
      - accountId
      - appId
      - environmentId
      - spaceId
      - name
      - config
      - status
      - type
      title: CreateRunbookRequest
    type_commons_Error:
      type: object
      properties:
        key:
          type: string
        message:
          type: string
      required:
      - message
      title: Error
    type_commons_AccountId:
      type: string
      description: Account ID
      title: AccountId
    type_runbooks_RunbookConfig:
      oneOf:
      - $ref: '#/components/schemas/type_runbooks_SheetTransformConfig'
      title: RunbookConfig
    type_commons_AppId:
      type: string
      description: App ID
      title: AppId
    type_commons_Success:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_commons_SuccessData'
      description: Informs whether or not a request was successful
      title: Success
    type_runbooks_RunbookStatus:
      type: string
      enum:
      - CREATED
      - RECORDING
      - EXECUTING
      - WAITING
      - COMPLETED
      - FAILED
      - CANCELED
      title: RunbookStatus
    type_runbooks_UpdateRunbookRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the Runbook.
        status:
          $ref: '#/components/schemas/type_runbooks_RunbookStatus'
          description: The status of the Runbook.
        config:
          $ref: '#/components/schemas/type_runbooks_RunbookConfig'
          description: The configuration of the Runbook.
      title: UpdateRunbookRequest
    type_runbooks_RunbookType:
      type: string
      enum:
      - SHEET_TOOL
      - PREPROCESSING
      title: RunbookType
    type_commons_RunbookId:
      type: string
      description: Runbook ID
      title: RunbookId
    type_runbooks_RunbooksResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_runbooks_Runbook'
      required:
      - data
      title: RunbooksResponse
    type_runbooks_RunbookResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_runbooks_Runbook'
      required:
      - data
      title: RunbookResponse
    type_commons_SuccessData:
      type: object
      properties:
        success:
          type: boolean
      required:
      - success
      title: SuccessData
    type_commons_EnvironmentId:
      type: string
      description: Environment ID
      title: EnvironmentId
  securitySchemes:
    default:
      type: http
      scheme: bearer