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

Required Privileges

The privilege(s) required to create an SLA without any rules is/are:

-

API Parameters

cURL

cURL Sample create_sla_norules Snippet

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"
}

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

Required Privileges

The privileges required to fetch all SLAs for a client are:

-

API Parameters

cURL

cURL Sample fetch_clientsla Snippet

Replace angle bracket parameters with your own values.

cURL Parameters

Response Parameters

Sample Response

HTTP Status Codes

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

Required Privileges

The privileges required to fetch a specific SLA are:

-

API Parameters

cURL

cURL Sample delete_exportfile Snippet

Replace angle bracket parameters with your own values.

cURL Parameters

HTTP Status Codes

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

Required Privileges

The privilege(s) required to update an SLA is/are:

-

API Parameters

cURL

cURL Sample create_sla_norules Snippet

Replace angle bracket parameters with your own values.

cURL Parameters

Response Parameters

Sample Response

HTTP Status Codes

200 Sample Response

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

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

Required Privileges

The privilege(s) required to delete an SLA is/are:

-

API Parameters

cURL

cURL Sample create_sla_norules Snippet

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"
}

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

Required Privileges

The privilege(s) required to fetch SLA details is/are:

-

API Parameters

cURL

cURL Sample create_sla_norules Snippet

Replace angle bracket parameters with your own values.

cURL Parameters

Response Parameters

Sample Response

HTTP Status Codes

200 Sample Response

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

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

Required Privileges

The privilege(s) required to create an SLA without any rules is/are:

-

API Parameters

cURL

cURL Sample create_sla_norules Snippet

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"
}

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

Required Privileges

The privilege(s) required to create an SLA without any rules is/are:

-

API Parameters

cURL

cURL Sample create_sla_norules Snippet

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"
}

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

Required Privileges

The privilege(s) required to create an SLA without any rules is/are:

-

API Parameters

cURL

cURL Sample create_sla_norules Snippet

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"
}

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

Required Privileges

The privilege(s) required to create an SLA without any rules is/are:

-

API Parameters

cURL

cURL Sample create_sla_norules Snippet

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"
}

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

Required Privileges

The privilege(s) required to create an SLA without any rules is/are:

-

API Parameters

cURL

cURL Sample create_sla_norules Snippet

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"
}

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

Required Privileges

The privilege(s) required to create an SLA without any rules is/are:

-

API Parameters

cURL

cURL Sample create_sla_norules Snippet

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"
}

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

Required Privileges

The privilege(s) required to create an SLA without any rules is/are:

-

API Parameters

cURL

cURL Sample create_sla_norules Snippet

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"
}

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

Required Privileges

The privilege(s) required to create an SLA without any rules is/are:

-

API Parameters

cURL

cURL Sample create_sla_norules Snippet

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"
}