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>'
import requests

url = "https://cloud.onyx.app/api/manage/admin/connector/status"

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/connector/status', 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/connector/status",
  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/connector/status"

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

url = URI("https://cloud.onyx.app/api/manage/admin/connector/status")

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
[
  {
    "cc_pair_id": 123,
    "name": "<string>",
    "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>"
    },
    "groups": [
      123
    ]
  }
]
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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