Skip to main content
PUT
/
manage
/
admin
/
credential
/
private-key
/
{credential_id}
Update Credential Private Key
curl --request PUT \
  --url https://cloud.onyx.app/api/manage/admin/credential/private-key/{credential_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'name=<string>' \
  --form 'credential_json=<string>' \
  --form uploaded_file='@example-file' \
  --form 'field_key=<string>' \
  --form 'type_definition_key=<string>'
{
  "credential_json": {},
  "admin_public": true,
  "source": "ingestion_api",
  "name": "<string>",
  "curator_public": false,
  "groups": [
    123
  ],
  "is_user_file": false
}

Authorizations

​
Authorization
string
header
required

Authorization header with Bearer token

Path Parameters

​
credential_id
integer
required

Body

multipart/form-data
​
name
string
required
​
credential_json
string
required
​
uploaded_file
file
required
​
field_key
string
required
​
type_definition_key
string
required

Response

Successful Response

​
credential_json
Credential Json · object
required
​
admin_public
boolean
required
​
source
enum<string>
required
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
​
name
string | null
​
curator_public
boolean
default:false
​
groups
integer[]
​
is_user_file
boolean
default:false