Upload

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.

Listing Uploads in a Client

List uploads in a client.

API Call: GET/client/{clientId}/upload

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

URL Parameters

User Roles

The user roles that can list uploads in a client are:

• Group Manager with Upload Permissions
• Manager

Python

Python Sample list_upload Snippet

import json
import requests

platform = 'https://platform.risksense.com'
api_key = '<INSERT API KEY HERE>'
client_id = <INSERT CLIENT ID HERE>

assessment_id = <INSERT ASSESSMENT ID HERE>

page_size = 150
page_num = 0


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

params = {
    "assessmentId": assessment_id,
    "size": page_size,
    "page": page_num
}

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

response = requests.get(url, headers=header, params=json.dumps(params))

Make sure to replace the angle bracket parameters here with your own values.

Python Parameters

cURL

cURL Sample list_upload Snippet

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

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Response Parameters

Sample Response

{
  "page": {
    "size": <SIZE>,
    "totalElements": <TOTALELEMENTS>,
    "totalPages": <TOTALPAGES>,
    "number": <NUMBER>
  },
  "_embedded": {
    "uploads": [
      {
        "id": <ID>,
        "name": "<NAME>",
        "assessmentId": <ASSESSMENTID>,
        "networkId": <NETWORKID>,
        "state": "<STATE>",
        "connectorId": <CONNECTORID>,
        "created": "<CREATED>",
        "userId": <USERID>
  }
    ]
  },
  "_links": {
    "first": {
      "href": "http://platform.risksense.com/api/v1/client/<CLIENTID>/upload?page<NUMBER>&size=<SIZE>"
    },
    "self": {
      "href": "http://platform.risksense.com/api/v1/client/<CLIENTID>/upload?page=<NUMBER>&size=<SIZE>"
    },
    "next": {
      "href": "http://platform.risksense.com/api/v1/client/<CLIENTID>/upload?page=<NUMBERNEXT>&size=<SIZE>"
    },
    "last": {
      "href": "http://platform.risksense.com/api/v1/client/<CLIENTID>/upload?page=<NUMBERLAST>&size=<SIZE>"
    }
  }
}

HTTP Status Codes

200 Sample Response

  "_embedded": {
    "uploads": [
      {
        "id": 12
      }
    ]
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  }
}

400 Sample Response

{
  "status": 0,
  "path": "string",
  "errors": [
    {
      "field": "string",
      "code": "string"
    }
  ]
}

Creating a New Upload

API Call: POST/client/{clientId}/upload

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

URL Parameters

User Roles

The user roles that can create a new upload are:

• Group Manager with Upload Permissions
• Manager

Python

Python Sample create_upload Snippet

TBA

Make sure to replace the angle bracket parameters here with your own values.

Python Parameters

cURL

cURL Sample create_upload Snippet

curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/upload"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"
  -H  "Content-Type: application/json"
  -d "{  \"assessmentId\": <ASSESSMENTID>,  \"networkId\": <NETWORKID>,  \"name\": \"<NAME>\"}"

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Response Parameters

Sample Response

{
  "id": <ID>
}

HTTP Status Codes

201 Sample Response

{
  "id": 12
}

Viewing the State of an Upload

View upload state.

API Call: GET/client/{clientId}/upload/{uploadId}

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/upload/<UPLOADID>

URL Parameters

User Roles

The user roles that can view the state of an upload are:

• Group Manager with Upload Permissions
• Manager

Python

Python Sample view_uploadstate Snippet

TBA

Make sure to replace the angle bracket parameters here with your own values.

Python Parameters

cURL

cURL Sample view_uploadstate Snippet

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

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Response Parameters

Sample Response

{
  "id": <ID>,
  "name": "<NAME>",
  "assessmentId": <ASSESSMENTID>,
  "networkId": <NETWORKID>,
  "state": "<STATE>",
  "connectorId": <CONNECTORID>,
  "created": "<CREATED>",
  "userId": <USERID>
}

HTTP Status Codes

200 Sample Response

{
  "id": 12
}

200 Sample Response

{
  "status": 0,
  "path": "string",
  "errors": [
    {
      "field": "string",
      "code": "string"
    }
  ]
}

Updating an Upload

Update an upload.

This API call is only available before an upload starts processing.

API Call: PUT/client/{clientId}/upload/{uploadId}

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/upload/<UPLOADID>

URL Parameters

User Roles

The user roles that can update an upload are:

• Group Manager with Upload Permissions
• Manager

Python

Python Sample update_upload Snippet

TBA

Make sure to replace the angle bracket parameters here with your own values.

Python Parameters

cURL

cURL Sample update_upload Snippet

curl -X PUT "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/upload/<UPLOADID>"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"
  -H  "Content-Type: application/json"
  -d "{  \"assessmentID\": <ASSESSMENTID>,  \"networkId\": <NETWORKID>,  \"name\": \"<NAME>\"}"

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Response Parameters

Sample Response

{
  "id": <ID>
}

HTTP Status Codes

200 Sample Response

{
  "id": 12
}

400 Sample Response

{
  "status": 0,
  "path": "string",
  "errors": [
    {
      "field": "string",
      "code": "string"
    }
  ]
}

Deleting an Upload

Delete an upload.

This API call is only available while the upload is not processing (i.e., before the upload starts and after the files are done processing).

API Call: DELETE/client/{clientId}/upload/{uploadId}

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/upload/<UPLOADID>

URL Parameters

User Roles

The user roles that can update an upload are:

• Group Manager with Upload Permissions
• Manager

Python

Python Sample delete_upload Snippet

TBA

Make sure to replace the angle bracket parameters here with your own values.

Python Parameters

cURL

cURL Sample delete_upload Snippet

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

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

HTTP Status Codes

Listing Files in an Upload

List files in an upload.

API Call: GET/client/{clientId}/upload/{uploadId}/file

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/upload/<UPLOADID>/file

URL Parameters

User Roles

The user roles that can list files in an upload are:

• Group Manager with upload permissions
• Manager

Python

Python Sample list_filesUpload Snippet

TBA

Make sure to replace the angle bracket parameters here with your own values.

Python Parameters

cURL

cURL Sample list_filesUpload Snippet

curl -X GET "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/upload/<UPLOADID>/file?size=<SIZE>&page=<PAGE>"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Response Parameters

Sample Response

{
  "_embedded": {
    "files": [
      {
        "id": <ID>,
        "scannerName": "<SCANNERNAME>",
        "scannerUuid": "<SCANNERUUID>",
        "assessmentId": <ASSESSMENTID>,
        "networkId": <NETWORKID>,
        "applicationId": <APPLICATIONID>,
        "state": "<STATE>"
      }
    ]
  },
  "page": {
    "size": <SIZE>,
    "totalElements": <TOTALELEMENTS>,
    "totalPages": <TOTALPAGES>,
    "number": <NUMBER>
  }
}

HTTP Status Codes

200 Sample Response

{
  "_embedded": {
    "files": [
      {
        "id": 53606,
        "scannerName": "Nexpose",
        "scannerUuid": "NEXPOSE",
        "assessmentId": 8070,
        "networkId": 15,
        "applicationId": null,
        "state": "PROCESSED"
      }
    ]
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  }
}

Adding a File to an Upload

Add a file to an upload.

API Call: POST/client/{clientId}/upload/{uploadId}/file

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/upload/<UPLOADID>/file

URL Parameters

User Roles

The user roles that can add files to an upload are:

• Group Manager with upload permissions
• Manager

Python

Python Sample add_fileUpload Snippet

TBA

Make sure to replace the angle bracket parameters here with your own values.

Python Parameters

cURL

cURL Sample add_fileUpload Snippet

curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/upload/<UPLOADID>/file"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"
  -H  "Content-Type: multipart/form-data"
  -F "scanFile=@<FILENAME>;type=<FILETYPE>"

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Response Parameters

Sample Response

[
  {
    "id": <ID>,
    "scannerName": "<SCANNERNAME>",
    "scannerUuid": "<SCANNERUUID>",
    "assessmentId": <ASSESSMENTID>,
    "networkId": <NETWORKID>,
    "applicationId": <APPLICATIONID>,
    "state": "<STATE>"
  }
]

HTTP Status Codes

201 Sample Response

[
  {
    "id": 53606,
    "scannerName": "Nexpose",
    "scannerUuid": "NEXPOSE",
    "assessmentId": 8070,
    "networkId": 15,
    "applicationId": null,
    "state": "PROCESSED"
  }
]

400 Sample Response

{
  "status": 0,
  "path": "string",
  "errors": [
    {
      "field": "string",
      "code": "string"
    }
  ]
}

Configuring an Upload File

Configure an Upload File

API Call: PUT/client/{clientId}/upload/{uploadId}/file/{fileId}

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/upload/<UPLOADID>/file/<FILEID>

URL Parameters

User Roles

The user roles that can configure an upload file are:

• Group Manager with upload permissions
• Manager

Python

Python Sample configure_upload Snippet

TBA

Make sure to replace the angle bracket parameters here with your own values.

Python Parameters

cURL

cURL Sample configure_upload Snippet

curl -X PUT "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/upload/<UPLOADID>/file/<FILEID>"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"
  -H  "Content-Type: application/json"
  -d "{  \"assessmentId\": <ASSESSMENTID>,  \"networkId\": <NETWORKID>,  \"applicationId\": <APPLICATIONID>}"

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Response Parameters

Sample Response

[
  {
    "id": <ID>,
    "scannerName": "<SCANNERNAME>",
    "scannerUuid": "<SCANNERUUID>",
    "assessmentId": <ASSESSMENTID>,
    "networkId": <NETWORKID>,
    "applicationId": <APPLICATIONID>,
    "state": "<STATE>"
  }
]

HTTP Status Codes

200 Sample Response

{
  "id": 53606,
  "scannerName": "Nexpose",
  "scannerUuid": "NEXPOSE",
  "assessmentId": 8070,
  "networkId": 15,
  "applicationId": null,
  "state": "PROCESSED"
}

400 Sample Response

{
  "status": 0,
  "path": "string",
  "errors": [
    {
      "field": "string",
      "code": "string"
    }
  ]
}

Removing a File from an Upload

Remove file from an upload.

API Call: DELETE/client/{clientId}/upload/{uploadId}/file/{fileId}

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/upload/<UPLOADID>/file/<FILEID>

URL Parameters

User Roles

The user roles that can remove a file from an upload are:

• Group Manager with upload permissions
• Manager

Python

Python Sample delete_uploadFile Snippet

TBA

Make sure to replace the angle bracket parameters here with your own values.

Python Parameters

cURL

cURL Sample delete_uploadFile Snippet

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

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

HTTP Status Codes

Downloading All Upload Files in an Upload

Download all upload files in an upload.

API Call: GET/client/{clientId}/upload/{uploadId}/file/download

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/upload/<UPLOADID>/file/download

URL Parameters

User Roles

The user roles that can download all upload files in an upload are:

• Group Manager with upload permissions
• Manager

Python

Python Sample downloadAll_uploadFiles Snippet

TBA

Make sure to replace the angle bracket parameters here with your own values.

Python Parameters

cURL

cURL Sample downloadAll_uploadFiles Snippet

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

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

HTTP Status Codes

400 Sample Response

{
  "status": 0,
  "path": "string",
  "errors": [
    {
      "field": "string",
      "code": "string"
    }
  ]
}

Try changing from application/octet-stream to application/json or vice-versa.

Fetching an Upload File by UUID

Fetch an upload file by UUID.

API Call: GET/client/{clientId}/upload/{uploadId}/file/{fileUUID}

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/upload/<UPLOADID>/file/<FILEUUID>

URL Parameters

User Roles

The user roles that can fetch an upload file by UUID are:

• Group Manager with upload permissions
• Manager

Python

Python Sample fetch_uploadUuid Snippet

TBA

Make sure to replace the angle bracket parameters here with your own values.

Python Parameters

cURL

cURL Sample fetch_uploadUuid Snippet

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

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

HTTP Status Codes

HTTP Status Codes

400 Sample Response

{
  "status": 0,
  "path": "string",
  "errors": [
    {
      "field": "string",
      "code": "string"
    }
  ]
}

Try changing from application/octet-stream to application/json or vice-versa.

Starting Processing an Upload

Start processing an upload.

API Call: POST/client/{clientId}/upload/{uploadId}/start

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/upload/<UPLOADID>/start

URL Parameters

User Roles

The user roles that can start processing an upload are:

• Group Manager with Upload Permissions
• Manager

Python

Python Sample start_upload Snippet

TBA

Make sure to replace the angle bracket parameters here with your own values.

Python Parameters

cURL

cURL Sample start_upload Snippet

curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/upload/<UPLOADID>/start"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"
  -H  "Content-Type: application/json"
  -d "{  \"autoUrba\": <AUTOURBA>}"

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Response Parameters

Sample Response

{
  "id": <ID>
}

HTTP Status Codes

200 Sample Response

{
  "id": 12
}

400 Sample Response

{
  "status": 0,
  "path": "string",
  "errors": [
    {
      "field": "string",
      "code": "string"
    }
  ]
}