API Documentation

⌘K
  1. Home
  2. Docs
  3. API Documentation
  4. Discovery
  5. ExportDiscovery

ExportDiscovery

Route: https://api.cytrix.io/ExportDiscovery

This feature allows you to export the results of a discovery scan.

Roles Required: Admin and User.

Request Syntax

{
    "apiKey": "String",
    "token": "String"
    "tp": json|raw|csv

}

Request Parameters

Parameters being used in the Request

Parameter Name :

apiKey

Parameter Usage and Options :

Your CYTRIX 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 :

token

Parameter Usage and Options :

The scan’s token.

How do I get it ? :

Simply use “GetAllDiscovery” 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 :

tp

Parameter Usage and Options :

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

Value :

json|csv|raw.

Type :

String

Is it Optional? :

No.


Successful Response


{
    "Error": 0,
    "Function": "ExportDiscovery",
    "Data": "example.com"
}

Errors and their Possible Causes

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