Update Credential From Model
curl --request PATCH \
--url https://cloud.onyx.app/api/manage/credential/{credential_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"credential_json": {},
"admin_public": true,
"name": "<string>",
"curator_public": false,
"groups": [
123
]
}
'import requests
url = "https://cloud.onyx.app/api/manage/credential/{credential_id}"
payload = {
"credential_json": {},
"admin_public": True,
"name": "<string>",
"curator_public": False,
"groups": [123]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
credential_json: {},
admin_public: true,
name: '<string>',
curator_public: false,
groups: [123]
})
};
fetch('https://cloud.onyx.app/api/manage/credential/{credential_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/credential/{credential_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'credential_json' => [
],
'admin_public' => true,
'name' => '<string>',
'curator_public' => false,
'groups' => [
123
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cloud.onyx.app/api/manage/credential/{credential_id}"
payload := strings.NewReader("{\n \"credential_json\": {},\n \"admin_public\": true,\n \"name\": \"<string>\",\n \"curator_public\": false,\n \"groups\": [\n 123\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://cloud.onyx.app/api/manage/credential/{credential_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"credential_json\": {},\n \"admin_public\": true,\n \"name\": \"<string>\",\n \"curator_public\": false,\n \"groups\": [\n 123\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.onyx.app/api/manage/credential/{credential_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"credential_json\": {},\n \"admin_public\": true,\n \"name\": \"<string>\",\n \"curator_public\": false,\n \"groups\": [\n 123\n ]\n}"
response = http.request(request)
puts response.read_body{
"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>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Credentials
Update Credential From Model
PATCH
/
manage
/
credential
/
{credential_id}
Update Credential From Model
curl --request PATCH \
--url https://cloud.onyx.app/api/manage/credential/{credential_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"credential_json": {},
"admin_public": true,
"name": "<string>",
"curator_public": false,
"groups": [
123
]
}
'import requests
url = "https://cloud.onyx.app/api/manage/credential/{credential_id}"
payload = {
"credential_json": {},
"admin_public": True,
"name": "<string>",
"curator_public": False,
"groups": [123]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
credential_json: {},
admin_public: true,
name: '<string>',
curator_public: false,
groups: [123]
})
};
fetch('https://cloud.onyx.app/api/manage/credential/{credential_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/credential/{credential_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'credential_json' => [
],
'admin_public' => true,
'name' => '<string>',
'curator_public' => false,
'groups' => [
123
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cloud.onyx.app/api/manage/credential/{credential_id}"
payload := strings.NewReader("{\n \"credential_json\": {},\n \"admin_public\": true,\n \"name\": \"<string>\",\n \"curator_public\": false,\n \"groups\": [\n 123\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://cloud.onyx.app/api/manage/credential/{credential_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"credential_json\": {},\n \"admin_public\": true,\n \"name\": \"<string>\",\n \"curator_public\": false,\n \"groups\": [\n 123\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.onyx.app/api/manage/credential/{credential_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"credential_json\": {},\n \"admin_public\": true,\n \"name\": \"<string>\",\n \"curator_public\": false,\n \"groups\": [\n 123\n ]\n}"
response = http.request(request)
puts response.read_body{
"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>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Authorization header with Bearer token
Path Parameters
Body
application/json
Available options:
ingestion_api, slack, web, google_drive, gmail, requesttracker, github, gitbook, gitlab, guru, bookstack, outline, confluence, jira, slab, productboard, file, coda, notion, zulip, linear, hubspot, document360, gong, google_sites, zendesk, loopio, dropbox, sharepoint, teams, salesforce, discourse, axero, clickup, mediawiki, wikipedia, asana, s3, r2, google_cloud_storage, oci_storage, xenforo, not_applicable, discord, freshdesk, fireflies, egnyte, airtable, highspot, drupal_wiki, imap, bitbucket, testrail, mock_connector, user_file Response
Successful Response
- CredentialSnapshot
- StatusResponse[int]
Available options:
ingestion_api, slack, web, google_drive, gmail, requesttracker, github, gitbook, gitlab, guru, bookstack, outline, confluence, jira, slab, productboard, file, coda, notion, zulip, linear, hubspot, document360, gong, google_sites, zendesk, loopio, dropbox, sharepoint, teams, salesforce, discourse, axero, clickup, mediawiki, wikipedia, asana, s3, r2, google_cloud_storage, oci_storage, xenforo, not_applicable, discord, freshdesk, fireflies, egnyte, airtable, highspot, drupal_wiki, imap, bitbucket, testrail, mock_connector, user_file Was this page helpful?
⌘I