Sign in

v2

latestOpenAPI 3.1.02026-08-0858116535.1 KB
Websets

Cancel a running Webset

Cancels all operations being performed on a Webset.

Any enrichment or search will be stopped and the Webset will be marked as idle.

post/v0/websets/{id}/cancel

Path parameters

idstring required

The id or externalId of the Webset

Response

Webset canceled

idstring required

The unique identifier for the webset

object'webset' required
status'idle' | 'pending' | 'running' | 'paused' required

The status of the webset

externalIdstring nullable required

The external identifier for the webset

titlestring nullable required

The title of the webset

metadataobject

Set of key-value pairs you want to associate with this object.

dashboardUrlstring uri required

The URL to view the webset in the Exa dashboard

createdAtstring date-time required

The date and time the webset was created

updatedAtstring date-time required

The date and time the webset was updated