Skip to main content
POST
/
api
/
v1
/
storage
/
sandboxes
/
{sandbox_id}
/
sources
/
{source_id}
/
pull
Pull Data Source
curl --request POST \
  --url https://api.copass.id/api/v1/storage/sandboxes/{sandbox_id}/sources/{source_id}/pull \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "since": "<string>",
  "vault_only": false
}
'
{
  "job_id": "<string>",
  "job_type": "data_source_pull",
  "status": "queued"
}

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

sandbox_id
string
required
source_id
string
required

Body

application/json
since
string | null

ISO 8601 datetime — incremental cursor, adapter-defined semantics

vault_only
boolean
default:false

If true, pulled rows are written directly to the Copass-ID vault under data/{extraction_id}/raw.json and no ontology_ingestion jobs are dispatched. Use this to stage raw data for later ingestion without running extraction.

Response

Successful Response

job_id
string
required
job_type
string
default:data_source_pull
status
string
default:queued