Skip to main content
GET
/
manage
/
admin
/
cc-pair
/
{cc_pair_id}
Get Cc Pair Full Info
curl --request GET \
  --url https://cloud.onyx.app/api/manage/admin/cc-pair/{cc_pair_id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://cloud.onyx.app/api/manage/admin/cc-pair/{cc_pair_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://cloud.onyx.app/api/manage/admin/cc-pair/{cc_pair_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://cloud.onyx.app/api/manage/admin/cc-pair/{cc_pair_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://cloud.onyx.app/api/manage/admin/cc-pair/{cc_pair_id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://cloud.onyx.app/api/manage/admin/cc-pair/{cc_pair_id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://cloud.onyx.app/api/manage/admin/cc-pair/{cc_pair_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "name": "<string>",
  "in_repeated_error_state": true,
  "num_docs_indexed": 123,
  "connector": {
    "name": "<string>",
    "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,
    "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
    ],
    "user_email": "<string>"
  },
  "number_of_index_attempts": 123,
  "latest_deletion_attempt": {
    "connector_id": 123,
    "credential_id": 123
  },
  "is_editable_for_current_user": true,
  "deletion_failure_message": "<string>",
  "indexing": true,
  "creator": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "creator_email": "<string>",
  "last_indexed": "2023-11-07T05:31:56Z",
  "last_pruned": "2023-11-07T05:31:56Z",
  "last_full_permission_sync": "2023-11-07T05:31:56Z",
  "overall_indexing_speed": 123,
  "latest_checkpoint_description": "<string>",
  "permission_syncing": true,
  "last_permission_sync_attempt_finished": "2023-11-07T05:31:56Z",
  "last_permission_sync_attempt_error_message": "<string>"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

Authorization header with Bearer token

Path Parameters

cc_pair_id
integer
required

Response

Successful Response

id
integer
required
name
string
required
status
enum<string>
required
Available options:
SCHEDULED,
INITIAL_INDEXING,
ACTIVE,
PAUSED,
DELETING,
INVALID
in_repeated_error_state
boolean
required
num_docs_indexed
integer
required
connector
ConnectorSnapshot · object
required
credential
CredentialSnapshot · object
required
number_of_index_attempts
integer
required
last_index_attempt_status
enum<string> | null
required
Available options:
not_started,
in_progress,
success,
canceled,
failed,
completed_with_errors
latest_deletion_attempt
DeletionAttemptSnapshot · object | null
required
access_type
enum<string>
required
Available options:
public,
private,
sync
is_editable_for_current_user
boolean
required
deletion_failure_message
string | null
required
indexing
boolean
required
creator
string<uuid> | null
required
creator_email
string | null
required
last_indexed
string<date-time> | null
required
last_pruned
string<date-time> | null
required
last_full_permission_sync
string<date-time> | null
required
overall_indexing_speed
number | null
required
latest_checkpoint_description
string | null
required
last_permission_sync_attempt_status
enum<string> | null
required

Status enum for permission sync attempts

Available options:
not_started,
in_progress,
success,
canceled,
failed,
completed_with_errors
permission_syncing
boolean
required
last_permission_sync_attempt_finished
string<date-time> | null
required
last_permission_sync_attempt_error_message
string | null
required