Skip to navigation

Update content source

View as Markdown

Changes the fields you send and returns the full updated document.

Send only the fields you want to change, plus version with the num from your last read and a change_description. This is a JSON merge-patch: a field you leave out keeps its stored value, and every list or map you send replaces the stored one whole. The id goes in the URL; if you also send id in the body it must match.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Path parameters

idstringRequired

The id of the content source, as returned when it was created or listed.

Request

This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
namestringOptional>=1 character
Display name of the content source. Required.
connector_selectionobjectOptional
The connector used to ingest the content and the connection method with its options. Required.
scopeobjectOptional

Which containers in the source (for example knowledge bases, spaces, sites, drives, folders or categories) are ingested: all, only selected ones, or all except selected ones.

filter_conditionsobjectOptional
Optional filters that include or exclude specific content from ingestion. All conditions must match.
url_overrideobjectOptional
Optional templates that rewrite the links to articles and attachments shown to users, for example to point to a custom portal.
audienceobjectOptional

Users who have access to this content: all users, selected users, or no users. Defaults to no users on create.

Response

The updated content source, at its new version
idstringOptionalRead-only
Unique identifier of the content source, assigned by the server. Cannot be changed.
namestringOptional>=1 character
Display name of the content source. Required.
systemenumOptional

External system the content is ingested from, such as Box, Confluence, Google Drive, Jira, Outlook, SharePoint & OneDrive, Slack, ServiceNow, Unily, Zendesk or GitHub. Cannot be changed after creation.

connector_selectionobjectOptional
The connector used to ingest the content and the connection method with its options. Required.
scopeobjectOptional

Which containers in the source (for example knowledge bases, spaces, sites, drives, folders or categories) are ingested: all, only selected ones, or all except selected ones.

filter_conditionsobjectOptional
Optional filters that include or exclude specific content from ingestion. All conditions must match.
url_overrideobjectOptional
Optional templates that rewrite the links to articles and attachments shown to users, for example to point to a custom portal.
audienceobjectOptional

Users who have access to this content: all users, selected users, or no users. Defaults to no users on create.

versionobjectOptional
Document version. On update, send back the num from your last read.
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error