CG Scanning API V2latest
Create Schedule
POST/v2/schedulesLast modified: 3 days ago
Create a Schedule
Request
Body Params application/json
schedule
object
required
name
string
required
The schedule name
Example:
My Schedule
comment
string
optional
The schedule comment
Example:
My comment
period
integer
optional
The period of the schedule
Example:
4
period_unit
enum<string>
optional
The period unit
Allowed values:
dayweekmonth
Example:
week
first_time
string
required
The first time of the schedule
Example:
2023-11-25 19:21:14 UTC
timezone
string
optional
The schedule's timezone
Example:
UTC
bymonthday
string
optional
By month day
Example:
1
byday
string
optional
By day
Example:
1SU
Example
{
"schedule": {
"name": "My Schedule",
"comment": "My comment",
"period": 4,
"period_unit": "day",
"first_time": "2023-11-25 19:21:14 UTC",
"timezone": "UTC",
"bymonthday": "1",
"byday": "1SU"
}
}Request samples
Responses
Created(201)
Unauthorized(401)
Parameter Error(422)
HTTP Code: 201
Content Type : JSONapplication/json
Schedule created
Data Schema
object {0}
Example
{}Last modified: 3 days ago