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

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

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}/index-attempts', 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}/index-attempts",
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}/index-attempts"

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}/index-attempts")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

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

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
{
  "items": [
    {
      "id": 123,
      "from_beginning": true,
      "new_docs_indexed": 123,
      "total_docs_indexed": 123,
      "docs_removed_from_index": 123,
      "error_msg": "<string>",
      "error_count": 123,
      "full_exception_trace": "<string>",
      "time_started": "<string>",
      "time_updated": "<string>",
      "poll_range_start": "2023-11-07T05:31:56Z",
      "poll_range_end": "2023-11-07T05:31:56Z"
    }
  ],
  "total_items": 123
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

Authorization header with Bearer token

Path Parameters

cc_pair_id
integer
required

Query Parameters

page_num
integer
default:0
Required range: x >= 0
page_size
integer
default:10
Required range: 1 <= x <= 1000

Response

Successful Response

items
IndexAttemptSnapshot · object[]
required
total_items
integer
required