Skip to main content
GET
/
manage
/
admin
/
connector
/
status
Get Connector Status
curl --request GET \
  --url https://cloud.onyx.app/api/manage/admin/connector/status \
  --header 'Authorization: Bearer <token>'
[
  {
    "cc_pair_id": 123,
    "name": "<string>",
    "connector": {
      "name": "<string>",
      "source": "ingestion_api",
      "input_type": "load_state",
      "connector_specific_config": {},
      "id": 123,
      "credential_ids": [
        123
      ],
      "time_created": "2023-11-07T05:31:56Z",
      "time_updated": "2023-11-07T05:31:56Z",
      "refresh_freq": 123,
      "prune_freq": 123,
      "indexing_start": "2023-11-07T05:31:56Z"
    },
    "credential": {
      "credential_json": {},
      "admin_public": true,
      "source": "ingestion_api",
      "id": 123,
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "time_created": "2023-11-07T05:31:56Z",
      "time_updated": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "curator_public": false,
      "groups": [
        123
      ],
      "is_user_file": false,
      "user_email": "<string>"
    },
    "access_type": "public",
    "groups": [
      123
    ]
  }
]

Authorizations

Authorization
string
header
required

Authorization header with Bearer token

Response

Successful Response

cc_pair_id
integer
required
name
string | null
required
connector
ConnectorSnapshot · object
required
credential
CredentialSnapshot · object
required
access_type
enum<string>
required
Available options:
public,
private,
sync
groups
integer[]
required