Skip to main content
POST
CSharp (SDK)

Authorizations

Authorization
string
header
required

Send Authorization: Bearer , using an MKA1 API key for automation or an OAuth API access token for a signed-in application. Use a dynamic security callback to refresh OAuth access tokens. Browser session-only operations still require their declared cookie.

Headers

X-On-Behalf-Of
string

Optional external end-user identifier forwarded by the API gateway.

Path Parameters

connector_id
string
required

The connector id.

Body

application/json

Every field is optional; absent fields are unchanged. The location and chunking are fixed at creation. A rule change starts a sync at once while auto_sync is on. The call also moves the connector to the calling API key when that key belongs to the connector's principal.

name
string
Required string length: 1 - 255
credentials
object

Replaces the stored credential, in the shape of the connector's type; takes effect at the next sync.

include_patterns
string[]

A glob relative to the connector's prefix: * within one folder, ** across folders, ? one character, [abc] a set; backslash escapes. Every other character is literal.

Minimum string length: 1
exclude_patterns
string[]

A glob relative to the connector's prefix: * within one folder, ** across folders, ? one character, [abc] a set; backslash escapes. Every other character is literal.

Minimum string length: 1
auto_sync
boolean
sync_interval_minutes
integer

Minutes between syncs while auto_sync is on, from 15 to 10080. The default is the operator's, 60 unless changed.

Required range: 15 <= x <= 10080

Response

200 - application/json

OK

id
string
required

The connector id, prefixed vsc_.

object
any
required
type
enum<string>
required

The kind of location. s3 is a bucket on AWS S3 or S3-compatible storage. sharepoint is a document library of a SharePoint Online site.

Available options:
s3,
sharepoint
name
string
required
location
object
required

Where the connector reads from, in the shape of its type. Fixed at creation.

credentials_configured
any
required

Credentials are write-only; this says a credential is stored.

api_key_id
string
required

The id of the API key the connector's syncs run as: the key's id, never its secret. It changes only when an update call is made with another key of the same principal.

include_patterns
string[]
required
exclude_patterns
string[]
required
chunking_strategy
object
required

The chunking every mirrored file gets. Null means the gateway's automatic strategy. Fixed at creation.

auto_sync
boolean
required
sync_interval_minutes
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
next_sync_at
integer | null
required

Null while auto_sync is off or no store is linked.

Required range: -9007199254740991 <= x <= 9007199254740991
status
enum<string>
required

syncing while a run is in progress, removing while a delete or unsync is in progress, error when the last run failed, else idle.

Available options:
idle,
syncing,
removing,
error
last_error
string | null
required
last_run
object | null
required
vector_store_ids
string[]
required
created_at
integer
required

When the connector was created (Unix seconds).

Required range: -9007199254740991 <= x <= 9007199254740991
updated_at
integer
required

When the connector was last changed (Unix seconds).

Required range: -9007199254740991 <= x <= 9007199254740991