Note: You must contact Hive to have streams allocated to your project before you can use this feature.

This endpoint will stop a stream that is currently in process. This uses the stream id that is returned from the Submit a Stream endpoint, or the Get all Streams endpoints.

EXAMPLES


curl --request GET \
  --url https://api.thehive.ai/api/v2/stream/status?stream_id=<STREAM_ID> \
  --header 'authorization: token <API_KEY>'

RESULTS


{
    "stream_id": "2302d160-234b-11ed-847d-370749a0bad4",
    "url": "<STREAM URL> ",
    "callback_url": "https://webhook.site/4f706551-2bb1-48ba-ace9-6170545d13d5",
    "message": "Stream Processing Active",
    "units_processed": 56
}
{
    "stream_id": "2302d160-234b-11ed-847d-370749a0bad4",
    "url": "<STREAM URL>",
    "callback_url": "https://webhook.site/4f706551-2bb1-48ba-ace9-6170545d13d5",
    "message": "Stream Processing Completed",
    "units_processed": 1807
}
Query String Parameter
string

The ID of the stream you want to query.

HEADERS
string
required

Project API Token from hive customer dashboard. Prepend with 'token'