{
  "opencollection": "1.0.0",
  "info": {
    "name": "Prefect Cloud Account Billing Work Pools API",
    "version": "0.8.4"
  },
  "items": [
    {
      "info": {
        "name": "Work Pools",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Preview Work Pool Configuration",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/configuration/preview",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Preview Work Pool Configuration"
        },
        {
          "info": {
            "name": "Create Work Pool",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new work pool. If a work pool with the same\nname already exists, an error will be raised.\n\nRequired workspace scopes: `write_work_pools`"
        },
        {
          "info": {
            "name": "Read Work Pool",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:name",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "The work pool name"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Read a work pool by name\n\nRequired workspace scopes: `see_work_pools`"
        },
        {
          "info": {
            "name": "Update Work Pool",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:name",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "The work pool name"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a work pool\n\nRequired workspace scopes: `write_work_pools`"
        },
        {
          "info": {
            "name": "Delete Work Pool",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:name",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "The work pool name"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete a work pool\n\nRequired workspace scopes: `manage_work_pools`"
        },
        {
          "info": {
            "name": "Read Work Pools",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/filter",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Read multiple work pools\n\nRequired workspace scopes: `see_work_pools`"
        },
        {
          "info": {
            "name": "Paginate Work Pools",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/paginate",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Paginated query for work pools.\n\nRequired workspace scopes: `see_work_pools`"
        },
        {
          "info": {
            "name": "Count Work Pools",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/count",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Count work pools\n\nRequired workspace scopes: `see_work_pools`"
        },
        {
          "info": {
            "name": "Get Scheduled Flow Runs",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:name/get_scheduled_flow_runs",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "The work pool name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Load scheduled runs for a worker\n\nRequired workspace scopes: `see_work_queues`"
        },
        {
          "info": {
            "name": "Read Work Pool Access",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:name/access",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "The work pool name"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Read access controls for a work_pool.\n\nRequired workspace scopes: `see_work_pools`"
        },
        {
          "info": {
            "name": "Set Work Pool Access",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:name/access",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "The work pool name"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Set access controls for a work_pool.\nThe given access controls will replace any existing access controls.\n\nRequired workspace scopes: `manage_work_pools`"
        },
        {
          "info": {
            "name": "Read Actors Work Pool Access",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/my-access",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Read access controls for a set of work pools and return the resolved\naccess levels for the current actor.\n\nRequired workspace scopes: `see_work_pools`"
        },
        {
          "info": {
            "name": "Create Work Queue",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/queues",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "work_pool_name",
                "value": "",
                "type": "path",
                "description": "The work pool name"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new work pool queue. If a work pool queue with the same\nname already exists, an error will be raised.\n\nRequired workspace scopes: `write_work_queues`"
        },
        {
          "info": {
            "name": "Read Work Queue",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/queues/:name",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "work_pool_name",
                "value": "",
                "type": "path",
                "description": "The work pool name"
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "The work pool queue name"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Read a work pool queue\n\nRequired workspace scopes: `see_work_queues`"
        },
        {
          "info": {
            "name": "Update Work Queue",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/queues/:name",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "work_pool_name",
                "value": "",
                "type": "path",
                "description": "The work pool name"
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "The work pool queue name"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a work pool queue\n\nRequired workspace scopes: `write_work_queues`"
        },
        {
          "info": {
            "name": "Delete Work Queue",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/queues/:name",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "work_pool_name",
                "value": "",
                "type": "path",
                "description": "The work pool name"
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "The work pool queue name"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete a work pool queue\n\nRequired workspace scopes: `manage_work_queues`"
        },
        {
          "info": {
            "name": "Read Work Queues",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/queues/filter",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "work_pool_name",
                "value": "",
                "type": "path",
                "description": "The work pool name"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Read all work pool queues\n\nRequired workspace scopes: `see_work_queues`"
        },
        {
          "info": {
            "name": "Paginate Work Queues",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/queues/paginate",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "work_pool_name",
                "value": "",
                "type": "path",
                "description": "The work pool name"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Pagination query for work pool queues\n\nRequired workspace scopes: `see_work_queues`"
        },
        {
          "info": {
            "name": "Worker Heartbeat",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/workers/heartbeat",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "work_pool_name",
                "value": "",
                "type": "path",
                "description": "The work pool name"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\nRequired workspace scopes: `write_workers`"
        },
        {
          "info": {
            "name": "Read Workers",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/workers/filter",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "work_pool_name",
                "value": "",
                "type": "path",
                "description": "The work pool name"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Read all worker processes\n\nRequired workspace scopes: `see_workers`"
        },
        {
          "info": {
            "name": "Paginate Workers",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/workers/paginate",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "work_pool_name",
                "value": "",
                "type": "path",
                "description": "The work pool name"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Read all worker processes\n\nRequired workspace scopes: `see_workers`"
        },
        {
          "info": {
            "name": "Read Worker",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/workers/:worker_id",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "work_pool_name",
                "value": "",
                "type": "path",
                "description": "The work pool name"
              },
              {
                "name": "worker_id",
                "value": "",
                "type": "path",
                "description": "The worker process id"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Read a single worker process\n\nRequired workspace scopes: `see_workers`"
        },
        {
          "info": {
            "name": "Delete Worker",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:work_pool_name/workers/:name",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "work_pool_name",
                "value": "",
                "type": "path",
                "description": "The work pool name"
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "The work pool's worker name"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete a work pool's worker\n\nRequired workspace scopes: `manage_workers`"
        },
        {
          "info": {
            "name": "Read Work Pool Concurrency Status",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/work_pools/:name/concurrency_status",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "The work pool name"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Get the concurrency status of a work pool, including per-queue breakdown\nand flow run details for each slot holder.\n\nRequired workspace scopes: `see_work_queues`,`see_work_pools`"
        },
        {
          "info": {
            "name": "Count Flow Runs By Work Pool",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/ui/work_pools/count-flow-runs",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Get flow run counts grouped by work pool id.\n\nReturns a mapping of work_pool_id to the number of flow runs matching the\noptional filter. Work pools with no matching runs are included with a count\nof zero.\n\nRequired workspace scopes: `see_flows`"
        }
      ]
    }
  ],
  "bundled": true
}