1. Home
  2. Docs
  3. API Documentation
  4. Reports
  5. CreateReport

CreateReport

Route: https://kayran.live/api/CreateReport

You can use this function to create a report that summarizes a particular scan.

Roles Required: Admin and Users. Private Users can only Create Reports for Scans they have created.

Request Syntax

{
    "apiKey": "String",
    "type": json|docx|pdf|html|csv|xml|executive summary|bir|dev|black,
    "token": "String",
    "vulnsIds": ["111", "222"]
}

Request Parameters

Parameters being used in the Request

Parameter Name :

apiKey

Parameter Usage and Options :

Your Kayran given API Key.

How do I get it ? :

Located in the “Profile” section.

Note : by default, the “API Status” is enabled, unless, the Admin has disabled it in the “Server Settings” section.

Type :

String

Is it Optional ? :

No.


Parameter Name :

type

Parameter Usage and Options :

The type/format of the report you wish to export. To learn more about Report Types.

Value :

json| docx| pdf| html| csv| xml| executive summary| bir (Business Impact Report)| dev(Developer)| black(Blacked Report).

Type :

String

Is it Optional ? :

No.


Parameter Name :

token

Parameter Usage and Options :

The scan’s token.

How do I get it ? :

Simply use the “GetScan” or “GetAllScans” function, or navigate to a certain scan’s page, and in the address bar, you will notice “token=String”, use that String.

Type :

String

Is it Optional ? :

No.


Parameter Name :
vulnsIds

Parameter Usage and Options :

The ID’s of the requested vulnerabilities.

How do I get it ? :

By entering the vulnerability page in Kayran, on the address bar, the “id=231231232133”, use the number that appears.

Type :

String

Is it Optional ? :

No.


Successful Response


{
    "Errors": "0", 
    "Function": "CreateReport", 
    "data": {}, 
}

Note : successful response will display the requested report

Errors and their Possible Causes

For more information, please refer to the General Errors section.