Route: https://api.cytrix.io/NewPayload
This function allows you to Create and Upload a new Payload to your Server.
Roles Required: Admin and User.
Request Syntax
{
"apiKey": "String",
"name": "String",
"payload": "String",
"srcResult": "String","severity": int,
"description": "String",
"impact": "String",
"recommendation": "String",
"links": "String",
"cwe": "String",
"cvss": "float",
"details": "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.
Parameter Name :
name
Parameter Usage and Options :
The Name of the Payload you wish to Create. For example: SQL Injection.
Type :
String
Is it Optional ? :
No.
Parameter Name :
payload
Parameter Usage and Options :
The Payload that you wish to be used.
Type :
String
Is it Optional ? :
No.
Parameter Name :
srcResult
Parameter Usage and Options :
The Result of this Payload (Regex or Text).
Type :
String
Is it Optional ? :
No.
Parameter Name :
severity
Parameter Usage and Options :
The Severity of the Payload you wish to Create.
Type :
Integer
0 – 3 (Informative-Low-Medium-High)
Is it Optional ? :
No.
Parameter Name :
description
Parameter Usage and Options :
The Description of the Payload you wish to Create.
Type :
String
Is it Optional ? :
Yes.
Parameter Name :
impact
Parameter Usage and Options :
The Impact of the Payload you wish to Create.
Type :
String
Is it Optional ? :
Yes.
Parameter Name :
recommendation
Parameter Usage and Options :
The Recommendation for the Remediation of the Payload you wish to Create.
Type :
String
Is it Optional ? :
Yes.
Parameter Name :
links
Parameter Usage and Options :
In case you wish to add References the Payload you wish to Create.
Example: https://example1.com/ , https://example2.com/
Type :
String
Is it Optional ? :
Yes.
Parameter Name :
cwe
Parameter Usage and Options :
In case you wish to add CWEs that the Payload is related to.
Type :
String
Is it Optional ? :
Yes.
Parameter Name :
cvss
Parameter Usage and Options :
In case you wish to add a CVSS Score to the Payload.
Type :
Float/Integer
Is it Optional ? :
Yes.
Parameter Name :
details
Parameter Usage and Options :
In case you wish to add More Details regarding the Payload you wish to Create.
Type :
String
Is it Optional ? :
Yes.
Successful Response
{
"Error": 0,
"Function": "NewPayload",
"Data": "New Payload Successfully Created"
}
Errors and their Possible Causes
For more information, please refer to the General Errors section.