Pause an existing Historics query.
An HTTP PUT request sent to:
A successful call to this endpoint returns: 204 No Content. No JSON-encoded data will be sent to you.
The id of a Historics query. This is the id returned by the call you made to /historics/prepare.
Example values: 6cc90a14f570c4acdd22
Your reason for pausing the Historics query.
Example values: May not require this data any more
- Pause a Historics query and supply a reason:
curl -X PUT 'https://api.datasift.com/v1.3/historics/pause' -d 'reason=Changed the CSDL' -d 'id=6cc90a14f570c4acdd22' -H 'Authorization: datasift-user:your-datasift-api-key'
- Take a look at the endpoint dependencies.
- Use the /historics/resume endpoint to resume a paused Historics job.
- Use the /historics/stop endpoint to permanently stop a job.
- Be sure to read our introduction to the Historics API to get started with these endpoints.
- All calls to the API must be properly authenticated with a DataSift username and API key.
- For efficiency, Historics jobs are chunked and the individual chunks are run separately. If you attempt to pause a Historics job, any chunks that have not yet started will be paused immediately. However, chunks that have started execution will run to completion.
- All calls to the API must be versioned. The current version is v1.3.
Rate limit cost: 5
Requires authentication: Yes
Response formats: JSON, JSONP