1. Home
  2. Docs
  3. API Documentation
  4. Payloads
  5. GetPayloads

GetPayloads

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

This function allows you to fetch all of the Payloads that exists in your server.

Roles Required: Admin and Users.

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”: “GetPayloads”,

    “Data”: [

        {

            “user_id”: “12345”,

            “name”: “Name”,

            “payloads”: “String”,

            “src_result”: “String”,

            “severity”: 3,

            “uuid”: “abcdefg-123456”

         }

     ]

}

Errors and their Possible Causes

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