SLA
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.
Create an SLA without Any Rules
Create an SLA without any associated rules.
API Call: POST/client/{clientId}/sla
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/sla
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | Endpoint URL Structure |
CLIENTID | Client ID number. | Finding Your Client ID |
Required Privileges
The privilege(s) required to create an SLA without any rules is/are:
-
API Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y |
cURL
cURL Sample create_sla_norules Snippet
Replace angle bracket parameters with your own values.
cURL Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y | |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
Response Parameters
Sample Response
{
"id": <ID>,
"filename": "<FILENAME>",
"status": "<STATUS>"
}
Name | Description | Type | Additional Information |
---|---|---|---|
ID | Export ID number. | integer
|
|
FILENAME | Export file name. | string
|
|
STATUS | Job status. | string
|
HTTP Status Codes
Code | Description |
---|---|
200 | Successfully fetched the export status. |
200 Sample Response
{
"id": 3,
"filename": "host.csv",
"status": "COMPLETE"
}
Code | Description |
---|---|
400 | User error |
401 | Unauthorized |
Fetch All SLAs for a Client
Fetch all SLAs for a client.
API Call: GET/client/{clientId}/sla/fetch
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/sla/fetch
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | Endpoint URL Structure |
CLIENTID | Client ID number. | Finding Your Client ID |
Required Privileges
The privileges required to fetch all SLAs for a client are:
-
API Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
cURL
cURL Sample fetch_clientsla Snippet
Replace angle bracket parameters with your own values.
cURL Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
Response Parameters
Sample Response
HTTP Status Codes
Code | Description |
---|---|
200 | Successfully fetched the export file |
400 | Bad Request |
401 | Unauthorized |
404 | Unable to find the export id |
500 | Error occurred when connecting to the file service |
Fetch a Specified SLA
Fetch a specific SLA.
API Call: GET/client/{clientId}/sla/fetch/{playbookUuid}
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/sla/fetch/{playbookUuid}
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | Endpoint URL Structure |
CLIENTID | Client ID number. | Finding Your Client ID |
PLAYBOOKUUID | Playbook UUID ID number. |
Required Privileges
The privileges required to fetch a specific SLA are:
-
API Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | |
CLIENTID | Client ID number. | Finding Your Client ID |
APIKEY | Your API key. | Generating an API Token |
cURL
cURL Sample delete_exportfile Snippet
Replace angle bracket parameters with your own values.
cURL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | integer
|
CLIENTID | Client ID number. | Finding Your Client ID |
EXPORTID | Export ID number. | integer
|
APIKEY | Your API key. | Generating an API Token |
HTTP Status Codes
Code | Description |
---|---|
204 | Delete request was processed without errors |
400 | Bad Request |
401 | Unauthorized |
404 | Error occurred when connecting to the file service |
Update an SLA
Update an SLA.
API Call: PUT/client/{clientId}/sla/{playbookUuid}
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/sla/{playbookUuid}
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | Endpoint URL Structure |
CLIENTID | Client ID number. | Finding Your Client ID |
PLAYBOOKUUID | Playbook UUID number. |
Required Privileges
The privilege(s) required to update an SLA is/are:
-
API Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y |
cURL
cURL Sample create_sla_norules Snippet
Replace angle bracket parameters with your own values.
cURL Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
Response Parameters
Sample Response
Name | Description | Type | Additional Information |
---|---|---|---|
ID | Export ID number. | integer
|
|
FILENAME | Export file name. | string
|
|
STATUS | Job status. | string
|
HTTP Status Codes
Code | Description |
---|---|
200 | Successfully fetched the export status. |
200 Sample Response
{
"id": 3,
"filename": "host.csv",
"status": "COMPLETE"
}
Code | Description |
---|---|
400 | User error |
401 | Unauthorized |
Delete an SLA
Delete an SLA.
API Call: DELETE/client/{clientId}/sla/{playbookUuid}
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/sla/{playbookUuid}
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | Endpoint URL Structure |
CLIENTID | Client ID number. | Finding Your Client ID |
PLAYBOOKUUID | Playbook UUID number. |
Required Privileges
The privilege(s) required to delete an SLA is/are:
-
API Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y |
cURL
cURL Sample create_sla_norules Snippet
Replace angle bracket parameters with your own values.
cURL Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y | |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
Response Parameters
Sample Response
{
"id": <ID>,
"filename": "<FILENAME>",
"status": "<STATUS>"
}
Name | Description | Type | Additional Information |
---|---|---|---|
ID | Export ID number. | integer
|
|
FILENAME | Export file name. | string
|
|
STATUS | Job status. | string
|
HTTP Status Codes
Code | Description |
---|---|
200 | Successfully fetched the export status. |
200 Sample Response
{
"id": 3,
"filename": "host.csv",
"status": "COMPLETE"
}
Code | Description |
---|---|
400 | User error |
401 | Unauthorized |
Fetch SLA Details
Fetch SLA details.
API Call: GET/client/{clientId}/sla/{playbookUuid}
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/sla/{playbookUuid}
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | Endpoint URL Structure |
CLIENTID | Client ID number. | Finding Your Client ID |
PLAYBOOKUUID | Playbook UUID number. |
Required Privileges
The privilege(s) required to fetch SLA details is/are:
-
API Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
cURL
cURL Sample create_sla_norules Snippet
Replace angle bracket parameters with your own values.
cURL Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y | |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
Response Parameters
Sample Response
Name | Description | Type | Additional Information |
---|---|---|---|
ID | Export ID number. | integer
|
|
FILENAME | Export file name. | string
|
|
STATUS | Job status. | string
|
HTTP Status Codes
Code | Description |
---|---|
200 | Successfully fetched the export status. |
200 Sample Response
{
"id": 3,
"filename": "host.csv",
"status": "COMPLETE"
}
Code | Description |
---|---|
400 | User error |
401 | Unauthorized |
Create an SLA without Any Rules
Create an SLA without any associated rules.
API Call: POST/client/{clientId}/sla
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/sla
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | Endpoint URL Structure |
CLIENTID | Client ID number. | Finding Your Client ID |
Required Privileges
The privilege(s) required to create an SLA without any rules is/are:
-
API Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y |
cURL
cURL Sample create_sla_norules Snippet
Replace angle bracket parameters with your own values.
cURL Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y | |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
Response Parameters
Sample Response
{
"id": <ID>,
"filename": "<FILENAME>",
"status": "<STATUS>"
}
Name | Description | Type | Additional Information |
---|---|---|---|
ID | Export ID number. | integer
|
|
FILENAME | Export file name. | string
|
|
STATUS | Job status. | string
|
HTTP Status Codes
Code | Description |
---|---|
200 | Successfully fetched the export status. |
200 Sample Response
{
"id": 3,
"filename": "host.csv",
"status": "COMPLETE"
}
Code | Description |
---|---|
400 | User error |
401 | Unauthorized |
Create an SLA without Any Rules
Create an SLA without any associated rules.
API Call: POST/client/{clientId}/sla
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/sla
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | Endpoint URL Structure |
CLIENTID | Client ID number. | Finding Your Client ID |
Required Privileges
The privilege(s) required to create an SLA without any rules is/are:
-
API Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y |
cURL
cURL Sample create_sla_norules Snippet
Replace angle bracket parameters with your own values.
cURL Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y | |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
Response Parameters
Sample Response
{
"id": <ID>,
"filename": "<FILENAME>",
"status": "<STATUS>"
}
Name | Description | Type | Additional Information |
---|---|---|---|
ID | Export ID number. | integer
|
|
FILENAME | Export file name. | string
|
|
STATUS | Job status. | string
|
HTTP Status Codes
Code | Description |
---|---|
200 | Successfully fetched the export status. |
200 Sample Response
{
"id": 3,
"filename": "host.csv",
"status": "COMPLETE"
}
Code | Description |
---|---|
400 | User error |
401 | Unauthorized |
Create an SLA without Any Rules
Create an SLA without any associated rules.
API Call: POST/client/{clientId}/sla
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/sla
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | Endpoint URL Structure |
CLIENTID | Client ID number. | Finding Your Client ID |
Required Privileges
The privilege(s) required to create an SLA without any rules is/are:
-
API Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y |
cURL
cURL Sample create_sla_norules Snippet
Replace angle bracket parameters with your own values.
cURL Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y | |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
Response Parameters
Sample Response
{
"id": <ID>,
"filename": "<FILENAME>",
"status": "<STATUS>"
}
Name | Description | Type | Additional Information |
---|---|---|---|
ID | Export ID number. | integer
|
|
FILENAME | Export file name. | string
|
|
STATUS | Job status. | string
|
HTTP Status Codes
Code | Description |
---|---|
200 | Successfully fetched the export status. |
200 Sample Response
{
"id": 3,
"filename": "host.csv",
"status": "COMPLETE"
}
Code | Description |
---|---|
400 | User error |
401 | Unauthorized |
Create an SLA without Any Rules
Create an SLA without any associated rules.
API Call: POST/client/{clientId}/sla
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/sla
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | Endpoint URL Structure |
CLIENTID | Client ID number. | Finding Your Client ID |
Required Privileges
The privilege(s) required to create an SLA without any rules is/are:
-
API Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y |
cURL
cURL Sample create_sla_norules Snippet
Replace angle bracket parameters with your own values.
cURL Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y | |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
Response Parameters
Sample Response
{
"id": <ID>,
"filename": "<FILENAME>",
"status": "<STATUS>"
}
Name | Description | Type | Additional Information |
---|---|---|---|
ID | Export ID number. | integer
|
|
FILENAME | Export file name. | string
|
|
STATUS | Job status. | string
|
HTTP Status Codes
Code | Description |
---|---|
200 | Successfully fetched the export status. |
200 Sample Response
{
"id": 3,
"filename": "host.csv",
"status": "COMPLETE"
}
Code | Description |
---|---|
400 | User error |
401 | Unauthorized |
Create an SLA without Any Rules
Create an SLA without any associated rules.
API Call: POST/client/{clientId}/sla
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/sla
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | Endpoint URL Structure |
CLIENTID | Client ID number. | Finding Your Client ID |
Required Privileges
The privilege(s) required to create an SLA without any rules is/are:
-
API Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y |
cURL
cURL Sample create_sla_norules Snippet
Replace angle bracket parameters with your own values.
cURL Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y | |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
Response Parameters
Sample Response
{
"id": <ID>,
"filename": "<FILENAME>",
"status": "<STATUS>"
}
Name | Description | Type | Additional Information |
---|---|---|---|
ID | Export ID number. | integer
|
|
FILENAME | Export file name. | string
|
|
STATUS | Job status. | string
|
HTTP Status Codes
Code | Description |
---|---|
200 | Successfully fetched the export status. |
200 Sample Response
{
"id": 3,
"filename": "host.csv",
"status": "COMPLETE"
}
Code | Description |
---|---|
400 | User error |
401 | Unauthorized |
Create an SLA without Any Rules
Create an SLA without any associated rules.
API Call: POST/client/{clientId}/sla
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/sla
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | Endpoint URL Structure |
CLIENTID | Client ID number. | Finding Your Client ID |
Required Privileges
The privilege(s) required to create an SLA without any rules is/are:
-
API Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y |
cURL
cURL Sample create_sla_norules Snippet
Replace angle bracket parameters with your own values.
cURL Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y | |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
Response Parameters
Sample Response
{
"id": <ID>,
"filename": "<FILENAME>",
"status": "<STATUS>"
}
Name | Description | Type | Additional Information |
---|---|---|---|
ID | Export ID number. | integer
|
|
FILENAME | Export file name. | string
|
|
STATUS | Job status. | string
|
HTTP Status Codes
Code | Description |
---|---|
200 | Successfully fetched the export status. |
200 Sample Response
{
"id": 3,
"filename": "host.csv",
"status": "COMPLETE"
}
Code | Description |
---|---|
400 | User error |
401 | Unauthorized |
Create an SLA without Any Rules
Create an SLA without any associated rules.
API Call: POST/client/{clientId}/sla
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/sla
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | Endpoint URL Structure |
CLIENTID | Client ID number. | Finding Your Client ID |
Required Privileges
The privilege(s) required to create an SLA without any rules is/are:
-
API Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y |
cURL
cURL Sample create_sla_norules Snippet
Replace angle bracket parameters with your own values.
cURL Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y | |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
Response Parameters
Sample Response
{
"id": <ID>,
"filename": "<FILENAME>",
"status": "<STATUS>"
}
Name | Description | Type | Additional Information |
---|---|---|---|
ID | Export ID number. | integer
|
|
FILENAME | Export file name. | string
|
|
STATUS | Job status. | string
|
HTTP Status Codes
Code | Description |
---|---|
200 | Successfully fetched the export status. |
200 Sample Response
{
"id": 3,
"filename": "host.csv",
"status": "COMPLETE"
}
Code | Description |
---|---|
400 | User error |
401 | Unauthorized |
Create an SLA without Any Rules
Create an SLA without any associated rules.
API Call: POST/client/{clientId}/sla
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/sla
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | Endpoint URL Structure |
CLIENTID | Client ID number. | Finding Your Client ID |
Required Privileges
The privilege(s) required to create an SLA without any rules is/are:
-
API Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y |
cURL
cURL Sample create_sla_norules Snippet
Replace angle bracket parameters with your own values.
cURL Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
CLIENTID | Client ID number. | integer
|
Y | Finding Your Client ID |
EXPORTID | Export Job ID number. | integer
|
Y | |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
Response Parameters
Sample Response
{
"id": <ID>,
"filename": "<FILENAME>",
"status": "<STATUS>"
}
Name | Description | Type | Additional Information |
---|---|---|---|
ID | Export ID number. | integer
|
|
FILENAME | Export file name. | string
|
|
STATUS | Job status. | string
|
HTTP Status Codes
Code | Description |
---|---|
200 | Successfully fetched the export status. |
200 Sample Response
{
"id": 3,
"filename": "host.csv",
"status": "COMPLETE"
}
Code | Description |
---|---|
400 | User error |
401 | Unauthorized |