v1

latestOpenAPI 3.0.0CoreStack Inc License2026-07-248001,5071.7 MB

Schedules

Updates a Schedule

Update schedule

post/v1/schedules/item/{schedule_id}

Path parameters

schedule_idstring required

Specify the schedule Id to update the schedule data

Request body

schedule_idstring

ID of the schedule

namestring required

Schedule Name

category'ComplianceStandard' | 'Policy' | 'PolicyRemediation' | 'Reports' | 'Script' | 'Template' required

Category of the schedule.

source'Report' | 'ScheduleRecommendation'

Source of the schedule creation

descriptionstring

Description of the schedule

recurrence'Once' | 'Minutes' | 'Hours' | 'Daily' | 'Weekly' | 'Monthly' | 'Annually'

Re-occurrence of the schedule

next_runstring date-time

When will the schedule run for the next time

last_runstring date-time

When the last schedule triggered

end_runstring date-time

Upto when the schedule should run

timezonestring

Timezone of the schedule

resourcestring required

ID of the resource which is scheduled. Can be retrieved using the respective List API

resource_argsstring

Input Parameters for the resource that is scheduled which is a JSON string

is_activeboolean

Flag to represent whether the schedule is active or not.

is_system_scheduleboolean

Flag to represent whether the schedule is system scheduled or not.

tenant_idstring

Tenant owning the schedule.

created_atstring date-time

When the schedule is created

created_bystring

Who has created the schedule

updated_atstring date-time

When the schedule is updated

updated_bystring

Who has updated the schedule

Example request

{
  "category": "ComplianceStandard",
  "source": "Report",
  "recurrence": "Once"
}

Response

Success

schedule_idstring

ID of the schedule

namestring required

Schedule Name

category'ComplianceStandard' | 'Policy' | 'PolicyRemediation' | 'Reports' | 'Script' | 'Template' required

Category of the schedule.

source'Report' | 'ScheduleRecommendation'

Source of the schedule creation

descriptionstring

Description of the schedule

recurrence'Once' | 'Minutes' | 'Hours' | 'Daily' | 'Weekly' | 'Monthly' | 'Annually'

Re-occurrence of the schedule

next_runstring date-time

When will the schedule run for the next time

last_runstring date-time

When the last schedule triggered

end_runstring date-time

Upto when the schedule should run

timezonestring

Timezone of the schedule

resourcestring required

ID of the resource which is scheduled. Can be retrieved using the respective List API

resource_argsstring

Input Parameters for the resource that is scheduled which is a JSON string

is_activeboolean

Flag to represent whether the schedule is active or not.

is_system_scheduleboolean

Flag to represent whether the schedule is system scheduled or not.

tenant_idstring

Tenant owning the schedule.

created_atstring date-time

When the schedule is created

created_bystring

Who has created the schedule

updated_atstring date-time

When the schedule is updated

updated_bystring

Who has updated the schedule

Example response

{
  "category": "ComplianceStandard",
  "source": "Report",
  "recurrence": "Once"
}