1. Home
  2. Docs
  3. API Documentation
  4. Discovery
  5. GetAllDiscovery

GetAllDiscovery

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

This feature will allow you to fetch and view all of your discovery scans.

Roles Required: Admin, User and Private User.

Request Syntax

{
    "apiKey": "String"
}

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.


Successful Response


{
    "Error": 0,
    "Function": "GetAllDiscovery",
    "Data": [
        {
            "token": "xxxxxxxx-xxxx-xxx-xxxxxxxx",
            "user_id": null,
            "domain": "example.com",
            "name": "https://example.com/",
            "status": "Completed",
            "in_progress": "False",
            "project_id": null,
            "user_name": ""
        }
}

Errors and their Possible Causes

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