ArthurAI Data Plane Associations V1 API

openapi: 3.1.0
info:
  title: Arthur GenAI Engine Agent Discovery Data Plane Associations V1 API
  version: 2.1.688
tags:
- name: Data Plane Associations V1
paths:
  /api/v1/workspaces/{workspace_id}/data_plane_associations:
    post:
      tags:
      - Data Plane Associations V1
      summary: Post Data Plane Association.
      description: Requires workspace_create_data_plane_association permission.
      operationId: post_data_plane_association
      security:
      - OAuth2AuthorizationCode:
        - workspace_create_data_plane_association
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostDataPlaneAssociation'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPlaneAssociation'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Data Plane Associations V1
      summary: List Data Plane Associations For Workspace.
      description: Requires workspace_list_data_plane_associations permission.
      operationId: get_workspace_data_plane_associations
      security:
      - OAuth2AuthorizationCode:
        - workspace_list_data_plane_associations
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      - name: sort
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/DataPlaneAssociationSort'
          description: Override the field used for sorting the returned list. Optional.
          default: created_at
        description: Override the field used for sorting the returned list. Optional.
      - name: order
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/SortOrder'
          description: Override the sort order used. Optional.
          default: desc
        description: Override the sort order used. Optional.
      - name: include_projects
        in: query
        required: false
        schema:
          type: boolean
          description: Include project details in the response. Defaults to false.
          default: false
          title: Include Projects
        description: Include project details in the response. Defaults to false.
      - name: include_data_planes
        in: query
        required: false
        schema:
          type: boolean
          description: Include data plane details in the response. Defaults to false.
          default: false
          title: Include Data Planes
        description: Include data plane details in the response. Defaults to false.
      - name: gen_ai_enabled
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Filter to only return engines enabled with the GenAI capability
          title: Gen Ai Enabled
        description: Filter to only return engines enabled with the GenAI capability
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: The page to return starting from 1 up to total_pages.
          default: 1
          title: Page
        description: The page to return starting from 1 up to total_pages.
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: The number of records per page. The max is 1000.
          default: 20
          title: Page Size
        description: The number of records per page. The max is 1000.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList_DataPlaneAssociation_'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/projects/{project_id}/data_plane_associations:
    get:
      tags:
      - Data Plane Associations V1
      summary: List Data Plane Associations For Project.
      description: Requires project_list_data_plane_associations.
      operationId: get_project_data_plane_associations
      security:
      - OAuth2AuthorizationCode:
        - project_list_data_plane_associations
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Project Id
      - name: sort
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/DataPlaneAssociationSort'
          description: Override the field used for sorting the returned list. Optional.
          default: created_at
        description: Override the field used for sorting the returned list. Optional.
      - name: order
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/SortOrder'
          description: Override the sort order used. Optional.
          default: desc
        description: Override the sort order used. Optional.
      - name: gen_ai_enabled
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Filter to only return engines enabled with the GenAI capability
          title: Gen Ai Enabled
        description: Filter to only return engines enabled with the GenAI capability
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: The page to return starting from 1 up to total_pages.
          default: 1
          title: Page
        description: The page to return starting from 1 up to total_pages.
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: The number of records per page. The max is 1000.
          default: 20
          title: Page Size
        description: The number of records per page. The max is 1000.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList_DataPlaneAssociation_'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/data_planes/{data_plane_id}/associations:
    get:
      tags:
      - Data Plane Associations V1
      summary: List Projects Associated With The Data Plane
      description: Requires data_plane_list_associations permission.
      operationId: get_data_plane_project_associations
      security:
      - OAuth2AuthorizationCode:
        - data_plane_list_associations
      parameters:
      - name: data_plane_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Data Plane Id
      - name: sort
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/DataPlaneAssociationSort'
          description: Override the field used for sorting the returned list. Optional.
          default: created_at
        description: Override the field used for sorting the returned list. Optional.
      - name: order
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/SortOrder'
          description: Override the sort order used. Optional.
          default: desc
        description: Override the sort order used. Optional.
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: The page to return starting from 1 up to total_pages.
          default: 1
          title: Page
        description: The page to return starting from 1 up to total_pages.
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: The number of records per page. The max is 1000.
          default: 20
          title: Page Size
        description: The number of records per page. The max is 1000.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList_DataPlaneAssociation_'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/data_plane_associations/{data_plane_association_id}:
    delete:
      tags:
      - Data Plane Associations V1
      summary: Delete Data Plane Association By Id
      description: Deletes a single data plane association. Requires data_plane_association_delete permission.
      operationId: delete_data_plane_association
      security:
      - OAuth2AuthorizationCode:
        - data_plane_association_delete
      parameters:
      - name: data_plane_association_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Data Plane Association Id
      responses:
        '204':
          description: No Content
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SortOrder:
      type: string
      enum:
      - asc
      - desc
      title: SortOrder
    Pagination:
      properties:
        page:
          type: integer
          title: Page
          description: The current page number. Page 1 is the first page.
          default: 1
        page_size:
          type: integer
          title: Page Size
          description: Number of records per page.
          default: 20
        total_pages:
          type: integer
          title: Total Pages
          description: Total number of pages.
        total_records:
          type: integer
          title: Total Records
          description: Total number of records across all pages.
      type: object
      required:
      - total_pages
      - total_records
      title: Pagination
    BadRequestError:
      properties:
        detail:
          type: string
          title: Detail
          default: Bad Request
      type: object
      title: BadRequestError
    InternalServerError:
      properties:
        detail:
          type: string
          title: Detail
          default: Internal server error
      type: object
      title: InternalServerError
    DataPlane:
      properties:
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Time of record creation.
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: Time of last record update.
        id:
          type: string
          format: uuid
          title: Id
          description: ID of the data plane.
        name:
          type: string
          title: Name
          description: Name of data plane.
        workspace_id:
          type: string
          format: uuid
          title: Workspace Id
          description: ID of the parent workspace.
        description:
          type: string
          title: Description
          description: Description of data plane.
        user_id:
          type: string
          format: uuid
          title: User Id
          description: ID of the data plane's underlying user.
        infrastructure:
          $ref: '#/components/schemas/Infrastructure'
          description: Infrastructure where the engine is running (e.g., AWS, GCP, Azure, Docker, Kubernetes).
        last_check_in_time:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Check In Time
          description: Last time the data plane was confirmed to be connected.
        capabilities:
          $ref: '#/components/schemas/DataPlaneCapabilities'
          description: Capabilities for this data plane.
      type: object
      required:
      - created_at
      - updated_at
      - id
      - name
      - workspace_id
      - description
      - user_id
      - infrastructure
      - last_check_in_time
      - capabilities
      title: DataPlane
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    NotFoundError:
      properties:
        detail:
          type: string
          title: Detail
          default: Resource not found
      type: object
      title: NotFoundError
    DataPlaneCapabilities:
      properties:
        gen_ai_enabled:
          type: boolean
          title: Gen Ai Enabled
          description: Field that records if the engine was installed with GenAI capabilities.
          default: false
      type: object
      title: DataPlaneCapabilities
    DataPlaneAssociationSort:
      type: string
      enum:
      - created_at
      - updated_at
      title: DataPlaneAssociationSort
    Infrastructure:
      type: string
      enum:
      - AWS
      - Azure
      - GCP
      - Docker
      - Kubernetes
      title: Infrastructure
    DataPlaneAssociation:
      properties:
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Time of record creation.
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: Time of last record update.
        id:
          type: string
          format: uuid
          title: Id
          description: ID of the data plane association.
        data_plane_id:
          type: string
          format: uuid
          title: Data Plane Id
          description: ID of the data plane.
        project_id:
          type: string
          format: uuid
          title: Project Id
          description: ID of the project.
        data_plane:
          anyOf:
          - $ref: '#/components/schemas/DataPlane'
          - type: 'null'
          description: Data plane associated with the project.
        project:
          anyOf:
          - $ref: '#/components/schemas/Project'
          - type: 'null'
          description: Project associated with the data plane.
      type: object
      required:
      - created_at
      - updated_at
      - id
      - data_plane_id
      - project_id
      title: DataPlaneAssociation
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PostDataPlaneAssociation:
      properties:
        data_plane_id:
          type: string
          format: uuid
          title: Data Plane Id
          description: ID of the data plane.
        project_id:
          type: string
          format: uuid
          title: Project Id
          description: ID of the project.
      type: object
      required:
      - data_plane_id
      - project_id
      title: PostDataPlaneAssociation
    Project:
      properties:
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Time of record creation.
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: Time of last record update.
        id:
          type: string
          format: uuid
          title: Id
          description: ID of the project.
        name:
          type: string
          title: Name
          description: Name of the project.
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: Description of the project.
        workspace_id:
          type: string
          format: uuid
          title: Workspace Id
          description: ID of the parent workspace.
        total_artifacts:
          type: integer
          title: Total Artifacts
          description: 'Count of artifacts in the project. Current supported artifacts are: models, including shield tasks and bench test suites.'
      type: object
      required:
      - created_at
      - updated_at
      - id
      - name
      - workspace_id
      - total_artifacts
      title: Project
    ResourceList_DataPlaneAssociation_:
      properties:
        records:
          items:
            $ref: '#/components/schemas/DataPlaneAssociation'
          type: array
          title: Records
          description: List of records.
        pagination:
          $ref: '#/components/schemas/Pagination'
          description: Pagination information.
      type: object
      required:
      - records
      - pagination
      title: ResourceList[DataPlaneAssociation]
  securitySchemes:
    API Key:
      type: http
      description: Bearer token authentication with an API key
      scheme: bearer