RunReveal

SourceBackfill operation

POST
/sources/backfill

Request Body

application/jsonRequired

createdAtobject

fromDateobject

idstring

ingestTypestring

prefixstring

settingsarray<integer>

sourceIDstring

sourceNamestring

sourceTypestring

statusstring

toDateobject

updatedAtobject

userstring

workspaceIDstring

curl -X POST "https://api.runreveal.com/sources/backfill" \
  -H "Content-Type: application/json" \
  -d '{
    "createdAt": {},
    "fromDate": {},
    "id": "string",
    "ingestType": "string",
    "prefix": "string",
    "settings": [
      0
    ],
    "sourceID": "string",
    "sourceName": "string",
    "sourceType": "string",
    "status": "string",
    "toDate": {},
    "updatedAt": {},
    "user": "string",
    "workspaceID": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "createdAt": {},
    "fromDate": {},
    "id": "string",
    "ingestType": "string",
    "prefix": "string",
    "settings": [
      0
    ],
    "sourceID": "string",
    "sourceName": "string",
    "sourceType": "string",
    "status": "string",
    "toDate": {},
    "updatedAt": {},
    "user": "string",
    "workspaceID": "string"
  },
  "success": true
}

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.

POST
/sources/create

Request Body

application/jsonRequired

createdAtobject

createdBystring

deleteAtobject

displayNamestring

idstring

ingestTypestring

isActiveboolean

logoURLstring

mitreTacticExclusionsarray<string>

namestring

settingsarray<integer>

typestring

updatedAtobject

workspaceIDstring

curl -X POST "https://api.runreveal.com/sources/create" \
  -H "Content-Type: application/json" \
  -d '{
    "createdAt": {},
    "createdBy": "string",
    "deleteAt": {},
    "displayName": "string",
    "id": "string",
    "ingestType": "string",
    "isActive": true,
    "logoURL": "string",
    "mitreTacticExclusions": [
      "string"
    ],
    "name": "string",
    "settings": [
      0
    ],
    "type": "string",
    "updatedAt": {},
    "workspaceID": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "createdAt": {},
    "createdBy": "string",
    "deleteAt": {},
    "displayName": "string",
    "id": "string",
    "ingestType": "string",
    "isActive": true,
    "logoURL": "string",
    "mitreTacticExclusions": [
      "string"
    ],
    "name": "string",
    "settings": [
      0
    ],
    "type": "string",
    "updatedAt": {},
    "workspaceID": "string"
  },
  "success": true
}

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.

DELETE
/sources/delete
curl -X DELETE "https://api.runreveal.com/sources/delete?id=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "deleteAt": {}
  },
  "success": true
}

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.

POST
/sources/delete/cancel

Request Body

application/jsonRequired

idstring

curl -X POST "https://api.runreveal.com/sources/delete/cancel" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {},
  "success": true
}

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.

DELETE
/sources/disable
curl -X DELETE "https://api.runreveal.com/sources/disable?id=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {},
  "success": true
}

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.

POST
/sources/generate-webhook-token

Request Body

application/jsonRequired

sourceIDstring

curl -X POST "https://api.runreveal.com/sources/generate-webhook-token" \
  -H "Content-Type: application/json" \
  -d '{
    "sourceID": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "source": {
      "createdAt": {},
      "createdBy": "string",
      "deleteAt": {},
      "displayName": "string",
      "id": "string",
      "ingestType": "string",
      "isActive": true,
      "logoURL": "string",
      "mitreTacticExclusions": [
        "string"
      ],
      "name": "string",
      "settings": [
        0
      ],
      "type": "string",
      "updatedAt": {},
      "workspaceID": "string"
    }
  },
  "success": true
}

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.

GET
/sources/list

Query Parameters

Typesarray<string>

includeLogosboolean

curl -X GET "https://api.runreveal.com/sources/list?Types=string&includeLogos=true"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    {
      "createdAt": {},
      "createdBy": "string",
      "deleteAt": {},
      "displayName": "string",
      "id": "string",
      "ingestType": "string",
      "isActive": true,
      "logoURL": "string",
      "mitreTacticExclusions": [
        "string"
      ],
      "name": "string",
      "settings": [
        0
      ],
      "type": "string",
      "updatedAt": {},
      "workspaceID": "string"
    }
  ],
  "success": true
}

SourceLogoDelete removes the image stored for a source.

SourceLogoDelete removes the image stored for a source.

POST
/sources/logo/delete

Request Body

application/jsonRequired

sourceIDstring

curl -X POST "https://api.runreveal.com/sources/logo/delete" \
  -H "Content-Type: application/json" \
  -d '{
    "sourceID": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "logoURL": "string"
  },
  "success": true
}

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.

POST
/sources/logo/upload

Request Body

application/jsonRequired

logostring

sourceIDstring

curl -X POST "https://api.runreveal.com/sources/logo/upload" \
  -H "Content-Type: application/json" \
  -d '{
    "logo": "string",
    "sourceID": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "logoURL": "string"
  },
  "success": true
}

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.

GET
/sources/orphaned-notifications
curl -X GET "https://api.runreveal.com/sources/orphaned-notifications"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    {
      "bucketName": "string",
      "deletedAt": {},
      "id": "string",
      "ingestType": "string",
      "lastSeenAt": {},
      "sourceName": "string"
    }
  ],
  "success": true
}

SourceOrphanedNotificationDismiss operation

POST
/sources/orphaned-notifications/dismiss

Request Body

application/jsonRequired

idstring

curl -X POST "https://api.runreveal.com/sources/orphaned-notifications/dismiss" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {},
  "success": true
}

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.

POST
/sources/test

Request Body

application/jsonRequired

createdAtobject

createdBystring

deleteAtobject

displayNamestring

idstring

ingestTypestring

isActiveboolean

logoURLstring

mitreTacticExclusionsarray<string>

namestring

settingsarray<integer>

typestring

updatedAtobject

workspaceIDstring

curl -X POST "https://api.runreveal.com/sources/test" \
  -H "Content-Type: application/json" \
  -d '{
    "createdAt": {},
    "createdBy": "string",
    "deleteAt": {},
    "displayName": "string",
    "id": "string",
    "ingestType": "string",
    "isActive": true,
    "logoURL": "string",
    "mitreTacticExclusions": [
      "string"
    ],
    "name": "string",
    "settings": [
      0
    ],
    "type": "string",
    "updatedAt": {},
    "workspaceID": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "error": "string",
    "sampleData": [
      "string"
    ],
    "sampleFormat": "string",
    "success": true
  },
  "success": true
}

SourceToggle enables or disables a source and returns the updated source.

SourceToggle enables or disables a source and returns the updated source.

POST
/sources/toggle

Request Body

application/jsonRequired

enabledboolean

idstring

curl -X POST "https://api.runreveal.com/sources/toggle" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "id": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "createdAt": {},
    "createdBy": "string",
    "deleteAt": {},
    "displayName": "string",
    "id": "string",
    "ingestType": "string",
    "isActive": true,
    "logoURL": "string",
    "mitreTacticExclusions": [
      "string"
    ],
    "name": "string",
    "settings": [
      0
    ],
    "type": "string",
    "updatedAt": {},
    "workspaceID": "string"
  },
  "success": true
}

UpdateSourceTransform operation

POST
/sources/transform/update

Request Body

application/jsonRequired

sourceIDstring

transformIDstring

curl -X POST "https://api.runreveal.com/sources/transform/update" \
  -H "Content-Type: application/json" \
  -d '{
    "sourceID": "string",
    "transformID": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {},
  "success": true
}

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.

PUT
/sources/update

Request Body

application/jsonRequired

createdAtobject

createdBystring

deleteAtobject

displayNamestring

idstring

ingestTypestring

isActiveboolean

logoURLstring

mitreTacticExclusionsarray<string>

namestring

settingsarray<integer>

typestring

updatedAtobject

workspaceIDstring

curl -X PUT "https://api.runreveal.com/sources/update" \
  -H "Content-Type: application/json" \
  -d '{
    "createdAt": {},
    "createdBy": "string",
    "deleteAt": {},
    "displayName": "string",
    "id": "string",
    "ingestType": "string",
    "isActive": true,
    "logoURL": "string",
    "mitreTacticExclusions": [
      "string"
    ],
    "name": "string",
    "settings": [
      0
    ],
    "type": "string",
    "updatedAt": {},
    "workspaceID": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "createdAt": {},
    "createdBy": "string",
    "deleteAt": {},
    "displayName": "string",
    "id": "string",
    "ingestType": "string",
    "isActive": true,
    "logoURL": "string",
    "mitreTacticExclusions": [
      "string"
    ],
    "name": "string",
    "settings": [
      0
    ],
    "type": "string",
    "updatedAt": {},
    "workspaceID": "string"
  },
  "success": true
}