API reference

Get Connector Indexing Status

Before you begin

This page uses Nexus's generated request and response schema. Requests still require the correct account, workspace, and resource permissions.

POST/manage/admin/connector/indexing-status

Workspace

Example request body

curl --request POST 'https://school.narb.cc/api/manage/admin/connector/indexing-status' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{}'

This builds a request example. Fill in required query values, then replace path placeholders and YOUR_TOKEN in your own environment. Use a token for a user with access to this workspace. Responses and permissions depend on your account and deployment. Never paste a private token into documentation.

Download the Nexus OpenAPI schema ↗
Import the schema into your API client. It describes the backend source; enabled routes depend on your workspace.

Authentication and scope#

Send requests to the workspace that owns the resource. Authentication does not by itself grant a school membership, class assignment, or administrator permission. School endpoints apply their role and class checks on the server.

Use a credential issued for that workspace with only the permissions your integration needs. Keep it on your server. Do not place credentials in a public website or a shared skill.

Parameters#

Name	Location	Required	Type
`tenant_id`	query	No	string or null

The tenant_id parameter is part of the engine schema. It does not authorize a caller to another school. Use the workspace and permissions assigned to your account.

Request body#

Content type: application/json.

Field	Type	Required	Details
`secondary_index`	boolean	No	Default: `false`.
`source`	string or null	No	See Request schema.
`access_type_filters`	array of string	No	See Request schema.
`last_status_filters`	array of string	No	See Request schema.
`docs_count_operator`	string or null	No	See Request schema.
`docs_count_value`	integer or null	No	See Request schema.
`name_filter`	string or null	No	See Request schema.
`source_to_page`	object	No	See Request schema.
`get_all_connectors`	boolean	No	Default: `false`.

Request schema#

The schema includes field limits and required values. Referenced types are included in the downloadable OpenAPI file. Replace example identifiers with IDs from your workspace.

{
  "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"
}

Responses#

200#

Successful Response

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ConnectorIndexingStatusLiteResponse"
  },
  "title": "Response Get Connector Indexing Status Manage Admin Connector Indexing Status Post"
}

422#

Validation Error

{
  "properties": {
    "detail": {
      "items": {
        "$ref": "#/components/schemas/ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

Access and error handling#

A signed-out or expired session needs authentication. A denied request can mean the account lacks permission, class membership, an approved model, or an available allowance. Do not retry a write blindly after a network failure; first check whether it was recorded.

Treat validation errors as a request problem. Use the returned field details to correct the request. Resource identifiers do not confer access.

Schema version#

Generated from Nexus backend source fe1c3a07c793029d3d87191a68f89e481afd6bc8. Check your deployed version before integrating. Schema coverage is not a live acceptance test.