Validate Provider Credential
curl --request POST \
--url https://api.cyberdesk.io/v1/provider-credentials/{slot}/validate \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cyberdesk.io/v1/provider-credentials/{slot}/validate"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cyberdesk.io/v1/provider-credentials/{slot}/validate', 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://api.cyberdesk.io/v1/provider-credentials/{slot}/validate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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://api.cyberdesk.io/v1/provider-credentials/{slot}/validate"
req, _ := http.NewRequest("POST", 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.post("https://api.cyberdesk.io/v1/provider-credentials/{slot}/validate")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cyberdesk.io/v1/provider-credentials/{slot}/validate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"slot": "anthropic",
"ok": true,
"checks": [
{
"check": "<string>",
"label": "<string>",
"ok": true,
"model": "<string>",
"location": "<string>",
"error": "<string>",
"is_auth_error": false
}
],
"credential": {
"slot": "anthropic",
"display_name": "<string>",
"source": "cyberdesk",
"covered_providers": [
"<string>"
],
"status": "active",
"auth_type": "api_key",
"display_metadata": {
"key_last4": "<string>",
"project_id": "<string>",
"client_email": "<string>",
"aws_region": "<string>",
"access_key_id_last4": "<string>"
},
"last_error": "<string>",
"activated_at": "2023-11-07T05:31:56Z",
"last_validated_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}provider-credentials
Validate Provider Credential
Make a minimal live call with the stored credential and update its status.
POST
/
v1
/
provider-credentials
/
{slot}
/
validate
Validate Provider Credential
curl --request POST \
--url https://api.cyberdesk.io/v1/provider-credentials/{slot}/validate \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cyberdesk.io/v1/provider-credentials/{slot}/validate"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cyberdesk.io/v1/provider-credentials/{slot}/validate', 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://api.cyberdesk.io/v1/provider-credentials/{slot}/validate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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://api.cyberdesk.io/v1/provider-credentials/{slot}/validate"
req, _ := http.NewRequest("POST", 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.post("https://api.cyberdesk.io/v1/provider-credentials/{slot}/validate")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cyberdesk.io/v1/provider-credentials/{slot}/validate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"slot": "anthropic",
"ok": true,
"checks": [
{
"check": "<string>",
"label": "<string>",
"ok": true,
"model": "<string>",
"location": "<string>",
"error": "<string>",
"is_auth_error": false
}
],
"credential": {
"slot": "anthropic",
"display_name": "<string>",
"source": "cyberdesk",
"covered_providers": [
"<string>"
],
"status": "active",
"auth_type": "api_key",
"display_metadata": {
"key_last4": "<string>",
"project_id": "<string>",
"client_email": "<string>",
"aws_region": "<string>",
"access_key_id_last4": "<string>"
},
"last_error": "<string>",
"activated_at": "2023-11-07T05:31:56Z",
"last_validated_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Unique key for idempotent requests. If provided, the server ensures the request is processed at most once. Retries with the same key return the original response. SDKs auto-generate this for write requests.
Example:
"550e8400-e29b-41d4-a716-446655440000"
Path Parameters
Available options:
anthropic, openai, google, aws_bedrock Response
Successful Response
Available options:
anthropic, openai, google, aws_bedrock Show child attributes
Show child attributes
State of one BYOK slot. Never includes secret material.
Show child attributes
Show child attributes
Was this page helpful?