Skip to main content
POST
/
api
/
v1
/
storage
/
sandboxes
/
{sandbox_id}
/
sources
/
{source_id}
/
purge
Purge Source Context
curl --request POST \
  --url https://api.copass.id/api/v1/storage/sandboxes/{sandbox_id}/sources/{source_id}/purge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "delete_source": false
}
'
{
  "success": true,
  "delete_source_applied": false,
  "events_deleted": 0,
  "extractions_deleted": 0,
  "canonical_index_rows_deleted": 0,
  "entity_vectors_deleted": 0,
  "triggers_deleted": 0,
  "webhooks_deleted": 0,
  "event_seen_deleted": 0,
  "project_links_deleted": 0,
  "strategy_artifacts_deleted": 0,
  "pull_artifacts_deleted": 0,
  "user_strategies_deleted": 0,
  "vault_objects_deleted": 0
}

Documentation Index

Fetch the complete documentation index at: https://docs.copass.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization
string | null
X-Encryption-Token
string | null
X-Encryption-Key
string | null

Path Parameters

source_id
string
required
sandbox_id
string
required

Body

application/json

Body for POST /sources/{id}/purge.

delete_source
boolean
default:false

When true, delete the data source registration after purging knowledge (same row removal as DELETE /sources/{id}).

Response

Successful Response

success
boolean
default:true
delete_source_applied
boolean
default:false
events_deleted
integer
default:0
extractions_deleted
integer
default:0
canonical_index_rows_deleted
integer
default:0
entity_vectors_deleted
integer
default:0
triggers_deleted
integer
default:0
webhooks_deleted
integer
default:0
event_seen_deleted
integer
default:0
strategy_artifacts_deleted
integer
default:0
pull_artifacts_deleted
integer
default:0
user_strategies_deleted
integer
default:0
vault_objects_deleted
integer
default:0