Route: https://api.cytrix.io/EnableSchedule
This function allow you to enable\activate scheduled scans.
Note : scheduled scans are enabled by default, unless otherwise instructed.
Roles Required: Admin. Users and Private Users can only Enable Scans they have Scheduled.
Request Syntax
{
“apiKey”: “string”,
“scheduleId”: “String”,
“scheduleIds”: [“String”, “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 :
scheduleId
Parameter Usage and Options :
The scheduled scan’s ID.
How do I get it ? :
Simply use the “GetSchedule” function, or navigate to a certain scheduled scan’s page, and in the address bar, you will notice “id=12315456”, use that number
Type :
Integer
Is it Optional ? :
No.
Parameter Name :
scheduleIds
Parameter Usage and Options :
Same as “scheduleId”, only for cases you wish to address a number of scheduled scans.
How do I get it ? :
Simply use the “GetSchedule” function, or navigate to a certain scheduled scan’s page, and in the address bar, you will notice “id=12315456”, use that number.
Type :
Integer
Is it Optional ? :
Yes\No – depends on whether you wish to address a number of scheduled scans.
Successful Response
{
“Error”: 0,
“Function”: “EnableSchedule”,
“Data”: {
“0”: {
“schedule_id”: 123456,
“code”: 1,
“info”: “Enabled target schedule”
}
}
}
Errors and their Possible Causes
For more information, please refer to the General Errors section.