Schedules

put/api/v1/schedules/{scheduleId}

Request

  • Base URL: https://api.immy.bot (the document declares no server; this is the origin it was published from)
  • URL: https://api.immy.bot/api/v1/schedules/{scheduleId}
  • Auth: none declared

Path parameters

scheduleIdinteger required

Request body

idinteger
namestring nullable
targetstring nullable
targetType'All' | 'Computer' | 'Metascript' | 'Person' | 'AzureGroup' | 'TenantMetascript' | 'AllForTenant' | 'ProviderDeviceGroup' | 'ProviderClientGroup' | 'TenantFilterScript' | 'FilterScript' | 'AllTenants' | 'SpecificTenant' | 'Tag' | 'TenantTag' | 'CloudTag' | 'CloudProviderClientGroup'

The string or integer value may be used. All = 1, Computer = 2, Metascript = 5, Person = 7, AzureGroup = 8, TenantMetascript = 20, AllForTenant = 21, ProviderDeviceGroup = 22, ProviderClientGroup = 23, TenantFilterScript = 24, FilterScript = 25, AllTenants = 28, SpecificTenant = 29, Tag = 30, TenantTag = 31, CloudTag = 40, CloudProviderClientGroup = 42

targetGroupFilter'All' | 'Servers' | 'Workstations' | 'PortableDevices' | 'WorkstationsAndPortableDevices' | 'DomainControllers' | 'PrimaryDomainControllers'

The string or integer value may be used. All = 0, Servers = 1, Workstations = 2, PortableDevices = 3, WorkstationsAndPortableDevices = 4, DomainControllers = 5, PrimaryDomainControllers = 6

targetCategory'Computer' | 'Tenant' | 'Person'

The string or integer value may be used. Computer = 0, Tenant = 1, Person = 2

providerDeviceGroupTypestring uuid nullable
providerClientGroupTypestring uuid nullable
providerLinkIdinteger nullable
tenantIdinteger nullable
propagateToChildTenantsboolean
customCronExpressionstring nullable
timestring nullable
dayinteger nullable
maintenanceTimestring nullable
disabledboolean
sendDetectionEmailboolean
sendDetectionEmailWhenAllActionsAreCompliantboolean
sendFollowUpEmailboolean
sendFollowUpOnlyIfActionNeededboolean
showRunNowButtonboolean
showPostponeButtonboolean
maintenanceType'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'ChocolateySoftware' | 'NiniteSoftware' | 'LocalMaintenanceTask' | 'GlobalMaintenanceTask' | 'AgentUpdate'

The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, ChocolateySoftware = 3, NiniteSoftware = 4, LocalMaintenanceTask = 5, GlobalMaintenanceTask = 6, AgentUpdate = 7

maintenanceIdentifierstring nullable
timeZoneInfoIdstring nullable
rebootPreference'Normal' | 'Suppress' | 'Prompt' | 'Force'

The string or integer value may be used. Normal = 0, Suppress = 1, Prompt = 2, Force = -1

promptTimeoutAction'Reboot' | 'Suppress' | 'FailSession'

The string or integer value may be used. Reboot = 0, Suppress = 1, FailSession = 2

autoConsentToRebootsboolean
promptTimeoutMinutesinteger
applyWindowsUpdatesboolean
showMaintenanceActionsboolean
allowAccessToMSPResourcesboolean
allowAccessToParentTenantboolean
offlineBehavior'Skip' | 'ApplyOnConnect'

The string or integer value may be used. Skip = 1, ApplyOnConnect = 2

suppressRebootsDuringBusinessHoursboolean
useComputersTimezoneForExecutionboolean
scheduleExecutionAfterActiveHoursboolean

Response

OK

targetTextstring nullable
targetTypeNamestring nullable
targetScopeNamestring nullable
targetMissingboolean
tenantMissingboolean
targetTypeMissingboolean
targetTypeDescriptionstring nullable
targetType'All' | 'Computer' | 'Metascript' | 'Person' | 'AzureGroup' | 'TenantMetascript' | 'AllForTenant' | 'ProviderDeviceGroup' | 'ProviderClientGroup' | 'TenantFilterScript' | 'FilterScript' | 'AllTenants' | 'SpecificTenant' | 'Tag' | 'TenantTag' | 'CloudTag' | 'CloudProviderClientGroup'

The string or integer value may be used. All = 1, Computer = 2, Metascript = 5, Person = 7, AzureGroup = 8, TenantMetascript = 20, AllForTenant = 21, ProviderDeviceGroup = 22, ProviderClientGroup = 23, TenantFilterScript = 24, FilterScript = 25, AllTenants = 28, SpecificTenant = 29, Tag = 30, TenantTag = 31, CloudTag = 40, CloudProviderClientGroup = 42

onboardingOnlyboolean
targetstring nullable
targetCategory'Computer' | 'Tenant' | 'Person'

The string or integer value may be used. Computer = 0, Tenant = 1, Person = 2

targetGroupFilter'All' | 'Servers' | 'Workstations' | 'PortableDevices' | 'WorkstationsAndPortableDevices' | 'DomainControllers' | 'PrimaryDomainControllers'

The string or integer value may be used. All = 0, Servers = 1, Workstations = 2, PortableDevices = 3, WorkstationsAndPortableDevices = 4, DomainControllers = 5, PrimaryDomainControllers = 6

tenantIdinteger nullable
propagateToChildTenantsboolean
allowAccessToParentTenantboolean
providerLinkIdinteger nullable
providerClientGroupTypestring uuid nullable
providerDeviceGroupTypestring uuid nullable
targetGroupFilterNamestring nullable
idinteger
namestring nullable
disabledboolean
customCronExpressionstring nullable
timestring nullable
dayinteger nullable
maintenanceTimestring nullable
sendDetectionEmailboolean
sendDetectionEmailWhenAllActionsAreCompliantboolean
sendFollowUpEmailboolean
sendFollowUpOnlyIfActionNeededboolean
showRunNowButtonboolean
showPostponeButtonboolean
showMaintenanceActionsboolean
maintenanceType'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'ChocolateySoftware' | 'NiniteSoftware' | 'LocalMaintenanceTask' | 'GlobalMaintenanceTask' | 'AgentUpdate'

The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, ChocolateySoftware = 3, NiniteSoftware = 4, LocalMaintenanceTask = 5, GlobalMaintenanceTask = 6, AgentUpdate = 7

maintenanceIdentifierstring nullable
rebootPreference'Normal' | 'Suppress' | 'Prompt' | 'Force'

The string or integer value may be used. Normal = 0, Suppress = 1, Prompt = 2, Force = -1

promptTimeoutAction'Reboot' | 'Suppress' | 'FailSession'

The string or integer value may be used. Reboot = 0, Suppress = 1, FailSession = 2

autoConsentToRebootsboolean
promptTimeoutMinutesinteger
applyWindowsUpdatesboolean
allowAccessToMSPResourcesboolean
updatedDateUTCstring date-time
createdDateUTCstring date-time
updatedByinteger nullable
createdByinteger nullable
updatedByNamestring nullable
timeZoneInfoIdstring nullable
offlineBehavior'Skip' | 'ApplyOnConnect'

The string or integer value may be used. Skip = 1, ApplyOnConnect = 2

suppressRebootsDuringBusinessHoursboolean
nextOccurenceDatestring date-time nullable
useComputersTimezoneForExecutionboolean
scheduleExecutionAfterActiveHoursboolean

Changes

No recorded changes to this operation across all 1 revision of this API.