Get CC Pair Full Info
This page uses Nexus's generated request and response schema. Requests still require the correct account, workspace, and resource permissions.
/manage/admin/cc-pair/{cc_pair_id}curl --request GET 'https://school.narb.cc/api/manage/admin/cc-pair/{cc_pair_id}' \
--header 'Authorization: Bearer YOUR_TOKEN'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 |
|---|---|---|---|
cc_pair_id | path | Yes | integer |
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.
Responses#
200#
Successful Response
{
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"status": {
"$ref": "#/components/schemas/ConnectorCredentialPairStatus"
},
"in_repeated_error_state": {
"type": "boolean",
"title": "In Repeated Error State"
},
"num_docs_indexed": {
"type": "integer",
"title": "Num Docs Indexed"
},
"connector": {
"$ref": "#/components/schemas/ConnectorSnapshot"
},
"credential": {
"$ref": "#/components/schemas/CredentialSnapshot"
},
"number_of_index_attempts": {
"type": "integer",
"title": "Number Of Index Attempts"
},
"last_index_attempt_status": {
"anyOf": [
{
"$ref": "#/components/schemas/IndexingStatus"
},
{
"type": "null"
}
]
},
"latest_deletion_attempt": {
"anyOf": [
{
"$ref": "#/components/schemas/DeletionAttemptSnapshot"
},
{
"type": "null"
}
]
},
"access_type": {
"$ref": "#/components/schemas/AccessType"
},
"is_editable_for_current_user": {
"type": "boolean",
"title": "Is Editable For Current User"
},
"permissions": {
"additionalProperties": {
"type": "boolean"
},
"type": "object",
"title": "Permissions"
},
"deletion_failure_message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Deletion Failure Message"
},
"indexing": {
"type": "boolean",
"title": "Indexing"
},
"creator": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Creator"
},
"creator_email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Creator Email"
},
"last_indexed": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Last Indexed"
},
"last_pruned": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Last Pruned"
},
"last_full_permission_sync": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Last Full Permission Sync"
},
"overall_indexing_speed": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Overall Indexing Speed"
},
"latest_checkpoint_description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Latest Checkpoint Description"
},
"last_permission_sync_attempt_status": {
"anyOf": [
{
"$ref": "#/components/schemas/PermissionSyncStatus"
},
{
"type": "null"
}
]
},
"permission_syncing": {
"type": "boolean",
"title": "Permission Syncing"
},
"last_permission_sync_attempt_finished": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Last Permission Sync Attempt Finished"
},
"last_permission_sync_attempt_error_message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Last Permission Sync Attempt Error Message"
},
"supports_targeted_reindex": {
"type": "boolean",
"title": "Supports Targeted Reindex"
},
"groups": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Groups"
},
"auto_sync_options": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Auto Sync Options"
},
"processing_mode": {
"$ref": "#/components/schemas/ProcessingMode"
}
},
"type": "object",
"required": [
"id",
"name",
"status",
"in_repeated_error_state",
"num_docs_indexed",
"connector",
"credential",
"number_of_index_attempts",
"last_index_attempt_status",
"latest_deletion_attempt",
"access_type",
"is_editable_for_current_user",
"permissions",
"deletion_failure_message",
"indexing",
"creator",
"creator_email",
"last_indexed",
"last_pruned",
"last_full_permission_sync",
"overall_indexing_speed",
"latest_checkpoint_description",
"last_permission_sync_attempt_status",
"permission_syncing",
"last_permission_sync_attempt_finished",
"last_permission_sync_attempt_error_message",
"supports_targeted_reindex",
"groups",
"auto_sync_options",
"processing_mode"
],
"title": "CCPairFullInfo"
}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.