source/stop

Stop delivery of source data.

An HTTPS PUT request sent to:

https://api.datasift.com/v1.6/source/stop

A successful call to this endpoint returns: 200 OK plus a JSON object.

Parameters

Parameter Description
id
required

Source ID. A string.

Example values: e25d533cf287ec44fe66e8362f61961f

Examples

The following is an example of a call to /source/stop with a source ID:

curl -X PUT https://api.datasift.com/v1.6/source/stop \
  -d 'id=fd2e72e3a7ae40c2a6e86e96381d8165' \
  -H 'Authorization: datasift-user:your-datasift-api-key'

Output

Success (HTTP Code: 200 OK)

The response will be JSON output similar to the one you see when you call /source/get. but the value of the status key will be set to stopped:

{
    "name": "",
    "source_type_id": "facebook_page",
    "status": "stopped",
    "parameters": [],
    "identities": [
        {
            "identity_id": "0047a9e7f4bb4931b65e7e9bd299ddd1",
            "source_id": "fd2e72e3a7ae40c2a6e86e96381d8165",
            "status": "valid",
            "parameters": {
                "value": "363056350669209|09af1ce9c5d8d23147ec4eeb9a33aac2"
            },
            "expires_at": 1388556000
        }
    ],
    "resources": [
        {
            "resource_id": "d6590d550db94266af6f53884dd65ca4",
            "source_id": "fd2e72e3a7ae40c2a6e86e96381d8165",
            "status": "valid",
            "parameters": {
                "url": "http://www.facebook.com/therollingstones",
                "title": "The Rolling Stones",
                "id": 8305888286
            }
        }
    ],
    "id": "fa2e72e3a7ae40c2a6e86e96381d8165"
}

Output Fields

Property: Description:
name The name of a source. Each source has one name element. For additional information, see /source/create.
status The status of a source. Each source has one status element. For additional information, see /source/create.
parameters Source- or resource-specific parameters. Each source and each resource have one parameters element. For additional information, see /source/create.
resources The list of all resources defined for the currect source. For additional information, see /source/create.
created_at The source creation date and time.
id The source ID.
source_type The source type.
auth The list of source-specific authentication credentials.

Errors

If things go wrong the Managed Sources API responds with the following error:

Failure (HTTP Code: 404 Not Found)

Raised when the specified source does not exist.

{
    "error": "Source not found"
}

Conflict (HTTP Code: 409 Conflict)

Raised when a stop request is received for a source which is not in a stoppable state.

{
    "error": "Unable to stop source instance '{id}' not in a stoppable state"
}

Notes

  1. All calls to the API must be properly authenticated with a DataSift username and API key.
  2. All calls to the API must be versioned. The current version is v1.6.

Revision history

v1.6

The endpoint now returns HTTP status code 409 when a stop request is received for a Managed Source that is not in a stoppable state. In previous versions the endpoint returned HTTP status code 400.

Resource information

Rate limit cost: 5

Requires authentication: Yes

Response formats: JSON, JSONP