1. Home
  2. Docs
  3. API Documentation
  4. Schedule
  5. GetSchedule

GetSchedule

Use this function to view\fetch all your scheduled scans.

Note : this functions fetch all your scheduled scans, even disabled ones.

Request Syntax

{

“apiKey”: “string”,

“sort”: “id”|”name”|”status”,

“desc”: true|false

}


Request Parameters

Parameters being used in the Request

Parameter Name :

apiKey

Parameter Usage and Options :

Your Kayran 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 :

sort

Parameter Usage and Options :

In case you want to fetch the scheduled scans in a specific order.

Value :

id\name\status

Type :

String

Is it Optional ? :

Yes.


Parameter Name :

desc

Parameter Usage and Options :

In case you want to fetch the scheduled scans in in descending order.

Value :

true\false

Type :

Boolean

Is it Optional ? :

No – if you enable sort.


Successful Response

{
“Error”: 0,
“Function”: “DeleteSchedule”,
“Data”: “[{\”id\”: 123456, \”url\”: \”URL/\”, \”token\”: \”String\”, \”interval_every\”: \”1 week\”, \”user_id\”: \”123465789\”, \”date\”: \”2022-05-30 08:53:40\”, \”status\”: \”enable\”}]”
}

Errors and their Possible Causes

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