Playbook
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.
Get Supported Playbook Inputs
Get supported playbook inputs.
API Call: GET/client/{clientId}/playbook/supported-inputs
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/playbook/supported-inputs
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 get supported playbook inputs 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 export_status 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
|
HTTP Status Codes
| Code | Description |
|---|---|
| 200 | Successfully fetched the export status. |
200 Sample Response
| Code | Description |
|---|---|
| 400 | Bad Request |
| 401 | Unauthorized |
| 404 | Unable to find the export ID |
Get Supported Playbook Action Types
Get supported playbook action types.
API Call: GET/client/{clientId}/playbook/supported-actions
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/playbook/supported-actions
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 get supported playbook action types 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 ID number. | integer
|
Y | |
| FILENAME | Export file name. | string
|
Y |
cURL
cURL Sample download_exportfile 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
Download file.
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 |
Get Supported Playbook Frequencies
Get supported playbook frequencies.
API Call: GET/client/{clientId}/playbook/supported-frequencies
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/playbook/supported-frequencies
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 get supported playbook frequencies 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 |
| 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 |
Get Supported Playbook Outputs
Get supported playbook outputs.
API Call: GET/client/{clientId}/playbook/supported-outputs
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/playbook/supported-outputs
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 get supported playbook outputs 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 |
| 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 |
Get the Subject Supported Actions
Get the subject supported actions.
API Call: GET/client/{clientId}/playbook/subject-supported-actions
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/playbook/subject-supported-actions
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 get the subject supported actions 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 |
| 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 |
Fetch All Playbooks for a Client
Fetch all playbooks for a client.
API Call: GET/client/{clientId}/playbook/fetch
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/playbook/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 playbooks for a client 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 |
| 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 |
Fetch a Specific Playbook
Fetch a specific playbook for a client.
API Call: GET/client/{clientId}/playbook/fetch/{playbookUuid}
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/playbook/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 number. |
Required Privileges
The privileges required to fetch a specific playbook 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 |
| 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 |
Fetch All Playbook Rules for a Playbook
Fetch all playbook rules for a playbook.
API Call: GET/client/{clientId}/playbook/fetch/{playbookUuid}/rules
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/playbook/fetch/{playbookUuid}/rules
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 privileges required to fetch all playbook rules for a playbook 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 |
| 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 |