SourceBackfill operation
sources/backfillRequest Body
application/jsonRequiredcreatedAtobject
fromDateobject
idstring
ingestTypestring
prefixstring
settingsarray<integer>
sourceIDstring
sourceNamestring
sourceTypestring
statusstring
toDateobject
updatedAtobject
userstring
workspaceIDstring
Success
A generic source create endpoint that can be used for any source type. Webhooks will auto generate the webhook URL as needed. If the source requires other special settings or setup a separate endpoint should be used.
A generic source create endpoint that can be used for any source type. Webhooks will auto generate the webhook URL as needed. If the source requires other special settings or setup a separate endpoint should be used.
sources/createRequest Body
application/jsonRequiredcreatedAtobject
createdBystring
deleteAtobject
displayNamestring
idstring
ingestTypestring
isActiveboolean
logoURLstring
mitreTacticExclusionsarray<string>
namestring
settingsarray<integer>
typestring
updatedAtobject
workspaceIDstring
Success
SourceDelete flags a source for irreversible deletion. The source and its logs are removed by the background source-delete executor once delete_at is due. If the source ingests from an object-storage bucket, an orphaned-source tombstone is recorded so stale notifications for that bucket can be traced back to outstanding infrastructure.
SourceDelete flags a source for irreversible deletion. The source and its logs are removed by the background source-delete executor once delete_at is due. If the source ingests from an object-storage bucket, an orphaned-source tombstone is recorded so stale notifications for that bucket can be traced back to outstanding infrastructure.
sources/deleteQuery Parameters
idstring
Success
SourceCancelDelete calls off a source's pending deletion, keeping the source and its logs. It only applies during the grace period: once the deletion is due the executor may already have dropped logs, and a cancel then would leave a half-deleted source looking healthy, so this reports an error instead. Also removes the orphaned-source tombstone that SourceDelete recorded, since the source is once again live and its bucket is not orphaned.
SourceCancelDelete calls off a source's pending deletion, keeping the source and its logs. It only applies during the grace period: once the deletion is due the executor may already have dropped logs, and a cancel then would leave a half-deleted source looking healthy, so this reports an error instead. Also removes the orphaned-source tombstone that SourceDelete recorded, since the source is once again live and its bucket is not orphaned.
sources/delete/cancelSuccess
SourceDisable disables a source along with its health check subscriptions and associated transforms.
SourceDisable disables a source along with its health check subscriptions and associated transforms.
sources/disableQuery Parameters
idstring
Success
SourceGenerateWebhookToken generates a new bearer token for a webhook source and returns the updated source.
SourceGenerateWebhookToken generates a new bearer token for a webhook source and returns the updated source.
sources/generate-webhook-tokenSuccess
SourceList lists the sources configured in the current workspace, optionally filtered by source type. Set includeLogos to attach each source's logo URL. Logo bytes are not loaded.
SourceList lists the sources configured in the current workspace, optionally filtered by source type. Set includeLogos to attach each source's logo URL. Logo bytes are not loaded.
sources/listSuccess
SourceLogoDelete removes the image stored for a source.
SourceLogoDelete removes the image stored for a source.
sources/logo/deleteSuccess
SourceLogoUpload stores an image for a source and returns the URL that serves it.
SourceLogoUpload stores an image for a source and returns the URL that serves it.
sources/logo/uploadSuccess
SourceOrphanedNotifications lists active orphaned-source notifications for the workspace: buckets still sending object-storage notifications with no matching source config.
SourceOrphanedNotifications lists active orphaned-source notifications for the workspace: buckets still sending object-storage notifications with no matching source config.
sources/orphaned-notificationsSuccess
SourceOrphanedNotificationDismiss operation
sources/orphaned-notifications/dismissSuccess
SourceTest verifies a source configuration by connecting to the provider and returns the result with sample records when available.
SourceTest verifies a source configuration by connecting to the provider and returns the result with sample records when available.
sources/testRequest Body
application/jsonRequiredcreatedAtobject
createdBystring
deleteAtobject
displayNamestring
idstring
ingestTypestring
isActiveboolean
logoURLstring
mitreTacticExclusionsarray<string>
namestring
settingsarray<integer>
typestring
updatedAtobject
workspaceIDstring
Success
SourceToggle enables or disables a source and returns the updated source.
SourceToggle enables or disables a source and returns the updated source.
sources/toggleSuccess
UpdateSourceTransform operation
sources/transform/updateSuccess
SourceUpdate updates an existing source's configuration, preserving existing secrets when none are provided.
SourceUpdate updates an existing source's configuration, preserving existing secrets when none are provided.
sources/updateRequest Body
application/jsonRequiredcreatedAtobject
createdBystring
deleteAtobject
displayNamestring
idstring
ingestTypestring
isActiveboolean
logoURLstring
mitreTacticExclusionsarray<string>
namestring
settingsarray<integer>
typestring
updatedAtobject
workspaceIDstring
Success