Create Downtime Scheduler using APIs - Applications Manager User Guide

Active Directory
management Manage, track, and secure Active Directory

Identity governance
and administrationOrchestrate user identity management and access controls for Zero Trust

Privileged access
managementControl and secure privileged access to critical enterprise systems

ADManager Plus
Active Directory, Microsoft 365, and Exchange management and reporting
ADAudit Plus
Hybrid AD, cloud, and file auditing; security; and compliance
ADSelfService Plus
Identity security with adaptive MFA, SSPR, and SSO
Exchange Reporter Plus
Reporting, auditing, and monitoring for hybrid Exchange and Skype
RecoveryManager Plus
Active Directory, Microsoft 365, and Exchange backup and recovery

View all products

MaintenanceTask API

The APIs given below allow you to work with downtime schedules in Applications Manager:

Request Parameters

The common parameters involved in these API requests are described below:

Field	Description
apikey	The key generated from the Generate API Key option in the Settings tab.
taskName	The name of the maintenance task. This should be a unique value.
taskType	The type of task to be created. Possible values are monitor (for an individual monitor) and group (for a monitor group) .You can configure a schedule for a monitor group by providing the tasktype as group.
taskStatus	Current status of the schedule. You have to choose from either 'enable' or 'disable'
dataCollectionType	This option allows you to stop either monitoring or alarms during maintenance. Possible parameter values are suppressMonitoring and suppressAlarms.
taskid	The unique identifier for the task
resourceid	The resource id of the monitor or monitor group for which the schedule has to be created.
taskUserGroup	The name of the user group associated with the Downtime Scheduler.

Field

Description

apikey

The key generated from the Generate API Key option in the Settings tab.

taskName

The name of the maintenance task. This should be a unique value.

taskType

The type of task to be created. Possible values are monitor (for an individual monitor) and group (for a monitor group) .You can configure a schedule for a monitor group by providing the tasktype as group.

taskStatus

Current status of the schedule. You have to choose from either 'enable' or 'disable'

dataCollectionType

This option allows you to stop either monitoring or alarms during maintenance. Possible parameter values are suppressMonitoring and suppressAlarms.

taskid

The unique identifier for the task

resourceid

The resource id of the monitor or monitor group for which the schedule has to be created.

taskUserGroup

The name of the user group associated with the Downtime Scheduler.

Sample Request:

This example helps you to create a downtime schedule in Applications Manager:

https://apm-prod-server:8443/AppManager/xml/CreateMaintenanceTask?apikey=aaaaaabbbbbbccccccddddddeeeeee&taskMethod=daily&taskStartTime=20:00&taskEndTime=21:00&taskStatus=disable&taskEffectFrom=2010-05-24%2016:48&taskName=dr1&taskType=monitor&resourceid=10000055&

If the API is not executed correctly, the request will fail and errors will be thrown. Refer this page for a list of common error conditions.

Was this content helpful?

We are sorry. Help us improve this page.

How can we improve this page?

Need more information on this topic

Need better screenshots

Need clear step by step instructions

Others

Do you need assistance with this topic?

Yes No

By clicking "Submit", you agree to processing of personal data according to the Privacy Policy.

Identity and access management

Unified service management

Unified endpoint management and security

IT operations management and observability

Security information and event management

Advanced IT analytics

Low-code app development

Cloud solutions for enterprise IT

IT management for MSPs

Active Directory management Manage, track, and secure Active Directory

Identity governance and administrationOrchestrate user identity management and access controls for Zero Trust

Privileged access managementControl and secure privileged access to critical enterprise systems

Enterprise and IT service managementDeliver a consistent employee experience across business functions

Customer service managementBuild a one-stop portal for customers with efficient account management

IT asset managementCentralize and automate the complete IT asset life cycle

SIEM Spot, investigate, and neutralize security threats

Log and compliance managementGain deeper visibility into security events and ensure compliance

Security auditingAudit Active Directory, cloud platforms and files to enhance your security posture

Endpoint management and protection platform (UEM and EPP)Secure and manage endpoints to protect your IT assets effectively

Endpoint managementAchieve intelligent IT device management with zero user intervention

Endpoint securityDefend against threat actors with proactive and reactive measures

Full-stack observability and digital experience monitoringAchieve end-to-end visibility, proactive issue resolution, and enhanced security

Network and server performance monitoringEnsure network, server, and storage reliability with AI-powered insights

IT incident managementEfficiently manage and resolve IT incidents while ensuring transparency

DNS and DHCP managementOptimize IP address and domain management

Cloud cost managementRight-size and take control of your cloud costs

IT analyticsConnect to your IT applications and visualize all facets of your IT

Cloud-native solutions for IT managementMonitor, manage, audit, and secure your multi-cloudand hybrid infrastructure

Business applications for ITBoost productivity and improve team collaboration

Custom solution builderBuild tailor-made apps to automate operations at your organization

Solutions for MSPsGrow your MSP business with scalable and secure IT management solutions

MaintenanceTask API

Request Parameters

Sample Request:

How can we improve this page?

Do you need assistance with this topic?

Active Directory
management Manage, track, and secure Active Directory

Identity governance
and administrationOrchestrate user identity management and access controls for Zero Trust

Privileged access
managementControl and secure privileged access to critical enterprise systems

Enterprise and IT service
managementDeliver a consistent employee experience across business functions

Customer service
managementBuild a one-stop portal for customers with efficient account management

IT asset
managementCentralize and automate the complete IT asset life cycle

Network and server
performance monitoringEnsure network, server, and storage reliability with AI-powered insights

IT incident
managementEfficiently manage and resolve IT incidents while ensuring transparency

Cloud-native solutions for IT managementMonitor, manage, audit, and secure your multi-cloud
and hybrid infrastructure