Workflow Batch

This documentation is currently outdated and in the process of being updated. This documentation is provided as a temporary reference to various API endpoints and output. This warning will be at the top of each outdated page. As the documentation is updated, this warning will be removed.

Checking the Status of an Export Job

Check the status of an export job.

API Call: GET/client/{clientId}/export/{exportId}/status

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/export/<EXPORTID>/status

URL Parameters

User Roles

The user roles that can check the status of an export job are:

• Manager
• Group Manager
• User

Python

Python Sample export_status Snippet

import requests

platform = 'https://platform<PLATFORM>.risksense.com'
api_key = '<APIKEY>'
client_id = <CLIENTID>
export_id = <EXPORTID>

header = {
    "x-api-key": api_key,
    "content-type": "application/json"
}

url = platform + "/api/v1/client/" + str(client_id) + "/export/" + str(export_id) + "/status"

response = requests.get(url, headers=header)

Replace angle bracket parameters with your own values.

Python Parameters

cURL

cURL Sample export_status Snippet

curl -X GET "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/export/<EXPORTID>/status"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"

Replace angle bracket parameters with your own values.

cURL Parameters

Response Parameters

Sample Response

{
  "id": <ID>,
  "filename": "<FILENAME>",
  "status": "<STATUS>"
}

HTTP Status Codes

200 Sample Response

{
  "id": 3,
  "filename": "host.csv",
  "status": "COMPLETE"
}

Downloading a File Created by an Export Job

Download a file created by an export job.

API Call: GET/client/{clientId}/export/{exportId}

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/export/<EXPORTID>

URL Parameters

User Roles

The user roles that can download a file created by an export job are:

• Manager
• Group Manager
• User

Python

Python Sample download_exportfile Snippet

import requests

platform = 'https://platform<PLATFORM>.risksense.com'
api_key = '<APIKEY>'
client_id = <CLIENTID>
export_id = <EXPORTID>

filename = "<FILENAME>"

header = {
    "x-api-key": api_key,
    "content-type": "application/json"
}

url = platform + "/api/v1/client/" + str(client_id) + "/export/" + str(export_id)

response = requests.get(url, headers=header)

open(filename, "wb").write(response.content)

Replace angle bracket parameters with your own values.

Python Parameters

cURL

cURL Sample download_exportfile Snippet

curl -X GET "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/export/<EXPORTID>"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"

Replace angle bracket parameters with your own values.

cURL Parameters

Response Parameters

Sample Response

Download file.

HTTP Status Codes

Deleting Files Related to Export

Delete export files.

API Call: DELETE/client/{clientId}/export/{exportId}

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/export/<EXPORTID>

URL Parameters

User Roles

The user roles that can delete a file related to an export job are:

• Manager
• Group Manager
• User

Python

Python Sample delete_exportfile Snippet

TBA

Replace angle bracket parameters with your own values.

Python Parameters

cURL

cURL Sample delete_exportfile Snippet

curl -X DELETE "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/export/<EXPORTID>"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"

Replace angle bracket parameters with your own values.

cURL Parameters

HTTP Status Codes