Prefect Collections API

The Collections API from Prefect — 2 operation(s) for collections.

OpenAPI Specification

prefect-collections-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Prefect Cloud Account Billing Collections API
  description: Prefect Cloud REST API documentation.
  version: 0.8.4
tags:
- name: Collections
paths:
  /api/collections/views/{view}:
    get:
      tags:
      - Collections
      summary: Read View Content
      description: Reads the content of a view from the prefect-collection-registry.
      operationId: read_view_content_api_collections_views__view__get
      parameters:
      - name: view
        in: path
        required: true
        schema:
          enum:
          - aggregate-block-metadata
          - aggregate-collection-metadata
          - aggregate-flow-metadata
          - aggregate-worker-metadata
          - demo-flows
          type: string
          title: View
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Read View Content Api Collections Views  View  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/accounts/{account_id}/workspaces/{workspace_id}/collections/work_pool_types:
    get:
      tags:
      - Collections
      summary: Read Available Work Pool Types
      description: 'Reads the content of a view from the prefect-collection-registry.


        Required workspace scopes: `see_work_pools`'
      operationId: read_available_work_pool_types_api_accounts__account_id__workspaces__workspace_id__collections_work_pool_types_get
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Account Id
      - name: x-prefect-api-version
        in: header
        required: false
        schema:
          type: string
          title: X-Prefect-Api-Version
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Read Available Work Pool Types Api Accounts  Account Id  Workspaces  Workspace Id  Collections Work Pool Types Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError