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

# Get Connector Indexing Status



## OpenAPI

````yaml POST /manage/admin/connector/indexing-status
openapi: 3.1.0
info:
  title: Onyx API
  description: Onyx API for AI-powered enterprise search and chat
  version: Development
servers:
  - url: https://cloud.onyx.app/api
security: []
paths:
  /manage/admin/connector/indexing-status:
    post:
      tags:
        - public
      summary: Get Connector Indexing Status
      operationId: get_connector_indexing_status
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IndexingStatusRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ConnectorIndexingStatusLiteResponse'
                title: >-
                  Response Get Connector Indexing Status Manage Admin Connector
                  Indexing Status Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerAuth: []
components:
  schemas:
    IndexingStatusRequest:
      properties:
        secondary_index:
          type: boolean
          title: Secondary Index
          default: false
        source:
          anyOf:
            - $ref: '#/components/schemas/DocumentSource'
            - type: 'null'
        access_type_filters:
          items:
            $ref: '#/components/schemas/AccessType'
          type: array
          title: Access Type Filters
        last_status_filters:
          items:
            $ref: '#/components/schemas/IndexingStatus'
          type: array
          title: Last Status Filters
        docs_count_operator:
          anyOf:
            - $ref: '#/components/schemas/DocsCountOperator'
            - type: 'null'
        docs_count_value:
          anyOf:
            - type: integer
            - type: 'null'
          title: Docs Count Value
        name_filter:
          anyOf:
            - type: string
            - type: 'null'
          title: Name Filter
        source_to_page:
          additionalProperties:
            type: integer
          propertyNames:
            $ref: '#/components/schemas/DocumentSource'
          type: object
          title: Source To Page
        get_all_connectors:
          type: boolean
          title: Get All Connectors
          default: false
      type: object
      title: IndexingStatusRequest
    ConnectorIndexingStatusLiteResponse:
      properties:
        source:
          $ref: '#/components/schemas/DocumentSource'
        summary:
          $ref: '#/components/schemas/SourceSummary'
        current_page:
          type: integer
          title: Current Page
        total_pages:
          type: integer
          title: Total Pages
        indexing_statuses:
          items:
            anyOf:
              - $ref: '#/components/schemas/ConnectorIndexingStatusLite'
              - $ref: '#/components/schemas/FederatedConnectorStatus'
          type: array
          title: Indexing Statuses
      type: object
      required:
        - source
        - summary
        - current_page
        - total_pages
        - indexing_statuses
      title: ConnectorIndexingStatusLiteResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DocumentSource:
      type: string
      enum:
        - ingestion_api
        - slack
        - web
        - google_drive
        - gmail
        - requesttracker
        - github
        - gitbook
        - gitlab
        - guru
        - bookstack
        - outline
        - confluence
        - jira
        - slab
        - productboard
        - file
        - coda
        - notion
        - zulip
        - linear
        - hubspot
        - document360
        - gong
        - google_sites
        - zendesk
        - loopio
        - dropbox
        - sharepoint
        - teams
        - salesforce
        - discourse
        - axero
        - clickup
        - mediawiki
        - wikipedia
        - asana
        - s3
        - r2
        - google_cloud_storage
        - oci_storage
        - xenforo
        - not_applicable
        - discord
        - freshdesk
        - fireflies
        - egnyte
        - airtable
        - highspot
        - drupal_wiki
        - imap
        - bitbucket
        - testrail
        - mock_connector
        - user_file
      title: DocumentSource
    AccessType:
      type: string
      enum:
        - public
        - private
        - sync
      title: AccessType
    IndexingStatus:
      type: string
      enum:
        - not_started
        - in_progress
        - success
        - canceled
        - failed
        - completed_with_errors
      title: IndexingStatus
    DocsCountOperator:
      type: string
      enum:
        - '>'
        - <
        - '='
      title: DocsCountOperator
    SourceSummary:
      properties:
        total_connectors:
          type: integer
          title: Total Connectors
        active_connectors:
          type: integer
          title: Active Connectors
        public_connectors:
          type: integer
          title: Public Connectors
        total_docs_indexed:
          type: integer
          title: Total Docs Indexed
      type: object
      required:
        - total_connectors
        - active_connectors
        - public_connectors
        - total_docs_indexed
      title: SourceSummary
    ConnectorIndexingStatusLite:
      properties:
        cc_pair_id:
          type: integer
          title: Cc Pair Id
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        source:
          $ref: '#/components/schemas/DocumentSource'
        access_type:
          $ref: '#/components/schemas/AccessType'
        cc_pair_status:
          $ref: '#/components/schemas/ConnectorCredentialPairStatus'
        in_progress:
          type: boolean
          title: In Progress
        in_repeated_error_state:
          type: boolean
          title: In Repeated Error State
        last_finished_status:
          anyOf:
            - $ref: '#/components/schemas/IndexingStatus'
            - type: 'null'
        last_status:
          anyOf:
            - $ref: '#/components/schemas/IndexingStatus'
            - type: 'null'
        last_success:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Success
        is_editable:
          type: boolean
          title: Is Editable
        docs_indexed:
          type: integer
          title: Docs Indexed
        latest_index_attempt_docs_indexed:
          anyOf:
            - type: integer
            - type: 'null'
          title: Latest Index Attempt Docs Indexed
      type: object
      required:
        - cc_pair_id
        - name
        - source
        - access_type
        - cc_pair_status
        - in_progress
        - in_repeated_error_state
        - last_finished_status
        - last_status
        - last_success
        - is_editable
        - docs_indexed
        - latest_index_attempt_docs_indexed
      title: ConnectorIndexingStatusLite
    FederatedConnectorStatus:
      properties:
        id:
          type: integer
          title: Id
        source:
          $ref: '#/components/schemas/FederatedConnectorSource'
        name:
          type: string
          title: Name
      type: object
      required:
        - id
        - source
        - name
      title: FederatedConnectorStatus
    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
    ConnectorCredentialPairStatus:
      type: string
      enum:
        - SCHEDULED
        - INITIAL_INDEXING
        - ACTIVE
        - PAUSED
        - DELETING
        - INVALID
      title: ConnectorCredentialPairStatus
    FederatedConnectorSource:
      type: string
      enum:
        - federated_slack
      title: FederatedConnectorSource
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Authorization header with Bearer token

````