EASM ReportRequest

The Ivanti Neurons External Attack Surface Management feature crawls seed domains that customers provide. This API lets customers specify seed domains that should not be allowed.

Required Header Parameters

Name Type Description

X-On-Behalf-Of

String

Provide a name or some form of information that identifies the requester. This is used for auditing purposes and will be displayed in the Ivanti Neurons user interface. A 400 status code is returned if this is not provided.

Authorization

Authheader

Use the Bearer <access-token> value determined during the Authentication process.

Request Body Parameters

GET /report/{id}

Get the status of a report that was started earlier.

Name Type Description

id

String($guid)

The GUID of the created report.

api-version

String

The current API version that is supported (2024.1).

Response Output Example

Copy 
 {
  "id": "add481e9-02ef-4254-bcd6-caf29370b292",
  "reportName": "Fix-phanthom final",
  "reportLevel": "account",
  "workspaceId": -1,
  "workspaceName": "all",
  "accountId": 1677,
  "status": 5,
  "reportStatusText": "Complete",
  "preparedByEmail": "",
  "preparedByUser": "Team Phantom",
  "refreshDate": "2024-08-13T09:41:56.5037325+00:00",
  "reportLocation": "/Team Phantom/Fix-phanthom_final.pdf"
}

Delete /report/{id}

Delete a completed or a failed EASM report.

Name Type Description

id

String($guid)

The GUID of the report to delete.

api-version

String

The current API version that is supported (2024.1).

Response Output Example

Copy 
Response Status 200 OK

GET /report/{id}/report

Get the download link for the completed report.

Name Type Description

id

String($guid)

The GUID of the report to get.

api-version

String

The current API version that is supported (2024.1).

Response Output Example

Copy 
https://<download URL>

GET /report

Returns the list of all created reports with their current status.

Name Type Description

api-version

String

The current API version that is supported (2024.1).

Response Output Example

Copy 
[
  {
    "id": "add481e9-02ef-4254-bcd6-caf29370b292",
    "reportName": "Fix-phanthom final",
    "reportLevel": "account",
    "workspaceId": -1,
    "workspaceName": "all",
    "accountId": 1677,
    "status": 5,
    "reportStatusText": "Complete",
    "preparedByEmail": "",
    "preparedByUser": "Team Phantom",
    "refreshDate": "2024-08-13T09:41:56.5037325+00:00",
    "reportLocation": "/Phantom/Fix-phanthom_final.pdf"
  },
  {
    "id": "30ece774-6fe5-4fae-80f6-61d1ed77ac26",
    "reportName": "ff-rep-version2",
    "reportLevel": "account",
    "workspaceId": -1,
    "workspaceName": "all",
    "accountId": 1677,
    "status": 5,
    "reportStatusText": "Complete",
    "preparedByEmail": "",
    "preparedByUser": "Team Phantom",
    "refreshDate": "2024-08-13T09:36:12.0960076+00:00",
    "reportLocation": "/Phantom/ff-rep-version2.pdf"
  }
]

POST /report

Create an EASM report trigger request.

Name Type Description

api-version

String

The current API version that is supported (2024.1).

Request body

application/json

Example:

{

"id": "string",

"reportName": "string",

"reportLevel": "string",

"workspaceId": 0,

"workspaceName": "string",

"accountId": 0,

"status": 1,

"reportStatusText": "string",

"preparedByEmail": "string",

"preparedByUser": "string",

"refreshDate": "2024-08-19T13:12:47.308Z",

"reportLocation": "string"

}

Response Output Example

The GUID of the requested report.

Copy 
add481e9-02ef-4254-bcd6-caf29370b292

GET /report/recent

Returns a specified count of recent reports.

Name Type Description

size

Integer($int32)

Number of recent reports that is required.

api-version

String

The current API version that is supported (2024.1).

Response Output Example

Copy 
(Assuming size = 2 from the query parameter)
[
  {
    "id": "add481e9-02ef-4254-bcd6-caf29370b292",
    "reportName": "Fix-phanthom final",
    "reportLevel": "account",
    "workspaceId": -1,
    "workspaceName": "all",
    "accountId": 1677,
    "status": 5,
    "reportStatusText": "Complete",
    "preparedByEmail": "",
    "preparedByUser": "Team Phantom",
    "refreshDate": "2024-08-13T09:41:56.5037325+00:00",
    "reportLocation": "/Team Phantom/Fix-phanthom_final.pdf"
  },
  {
    "id": "30ece774-6fe5-4fae-80f6-61d1ed77ac26",
    "reportName": "ff-rep-version2",
    "reportLevel": "account",
    "workspaceId": -1,
    "workspaceName": "all",
    "accountId": 1677,
    "status": 5,
    "reportStatusText": "Complete",
    "preparedByEmail": "",
    "preparedByUser": "Team Phantom",
    "refreshDate": "2024-08-13T09:36:12.0960076+00:00",
    "reportLocation": "/Team Phantom/ff-rep-version2.pdf"
  }
]

GET /report/export

Returns the list of generated reports’ information in an Excel sheet for the specified number of previous days.

Name Type Description

previousDays

Integer($int32)

Number of previous days from which the metrics are needed.

api-version

String

The current API version that is supported (2024.1).

Response Output Example

Copy 
https://<Excel spreadsheet URL>

PUT /report/{id}/cancel

Cancel or abort the EASM report generation of a specified report.

Name Type Description

id

String{$guid}

The GUID of the report to cancel.

api-version

String

The current API version that is supported (2024.1).

Response Output Example

Copy 
Response status 200 OK 
add481e9-02ef-4254-bcd6-caf29370b292

POST /report/{id}/start

Retrigger a previously cancelled/aborted report again.

Name Type Description

id

String{guid}

GUID of the report to restart.

api-version

String

The current API version that is supported (2024.1).

Response Output Example

A new GUID for the retriggered report.

Copy 
afd91cc1-a5ac-473c-a844-275ff1188ffb