Skip to Content
veriom

Pause audit stream

Stop delivery and keep the cursor; pausing a paused stream changes nothing.

POST
/v1/workspaces/{workspace_id}/audit-streams/{stream_id}/pause

Stop delivery and keep the cursor; pausing a paused stream changes nothing.

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid
stream_id*Stream Id
Formatuuid

Response Body

Successful Response

application/json
  1. response
consecutive_failures*Consecutive Failures
created_at*Created At
Formatdate-time
cursor_at*Cursor At

Time of the last event the endpoint accepted, or when the stream began.

Formatdate-time
delivered_count*Delivered Count

Events the endpoint accepted from live delivery.

failed_count*Failed Count

Batch deliveries that failed.

id*Id
Formatuuid
kind*Kind
Value in"webhook""siem"
last_delivered_at*|null
last_error*string|null
last_error_at*|null
last_error_status*|

HTTP status of the last failed delivery, when the endpoint answered.

last_replay_completed_at*|null
last_response_status*|

HTTP status of the latest delivery attempt, successful or not.

name*Name
next_attempt_at*Next Attempt At
Formatdate-time
paused_at*|null
paused_reason*|

failures or rejections when the stream paused itself, plan when the workspace's plan no longer includes streaming.

replay*|null
replayed_count*Replayed Count

Events the endpoint accepted from replays.

source*Source
Value in"audit_log""finding_lifecycle"
status*Status

retrying while the latest attempt failed and the stream is backing off.

Value in"active""retrying""paused"
test*
updated_at*Updated At
Formatdate-time
url*Url

The endpoint's host; the full URL is never shown again.

Example Request
curl -X POST 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/audit-streams/497f6eca-6276-4993-bfeb-53cbbbba6f08/pause'
Example Response
{  "consecutive_failures": 0,  "created_at": "2019-08-24T14:15:22Z",  "cursor_at": "2019-08-24T14:15:22Z",  "delivered_count": 0,  "failed_count": 0,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "kind": "webhook",  "last_delivered_at": "2019-08-24T14:15:22Z",  "last_error": "string",  "last_error_at": "2019-08-24T14:15:22Z",  "last_error_status": 0,  "last_replay_completed_at": "2019-08-24T14:15:22Z",  "last_response_status": 0,  "name": "string",  "next_attempt_at": "2019-08-24T14:15:22Z",  "paused_at": "2019-08-24T14:15:22Z",  "paused_reason": "manual",  "replay": {    "position": "2019-08-24T14:15:22Z",    "requested_at": "2019-08-24T14:15:22Z",    "since": "2019-08-24T14:15:22Z",    "until": "2019-08-24T14:15:22Z"  },  "replayed_count": 0,  "source": "audit_log",  "status": "active",  "test": {    "error": "string",    "pending": true,    "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",    "requested_at": "2019-08-24T14:15:22Z",    "response_status": 0,    "tested_at": "2019-08-24T14:15:22Z"  },  "updated_at": "2019-08-24T14:15:22Z",  "url": "string"}