Route: https://api.cytrix.io/ChangeDescription
This feature will allow you to change the description of an of an existing scan.
Roles Required: Admin. Users and Private Users can only Change the Description for Scans they initiated.
Request Syntax
{
"apiKey": "string",
"token": "string",
"description": "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 :
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 :
description
Parameter Usage and Options :
The scan’s description.
Type :
String
Is it Optional ? :
No.
Successful Response
{
“Error”: 0,
“Function”: “ChangeDescription”,
“Data”: “The description has been successfully updated”
}
Errors and their Possible Causes
{ “Error”: 1, “Function”: “ChangeSpeed”, “Data”: “Target not in progress, status: Completed”} – you can only change the speed of scans that are “In Progress”.
For more information, please refer to the General Errors section.