maintenance_job

Last published : Aug 10, 2026
Configuration for Maintenance Job resource.
Related information

Properties

(click to see Operations )
Name Data Type Permissions Description
scheduleTimesEpoch <String> Read-write Schedule time epoch (string representation of 11 digit numbers)..
device_family <String> Read-write Family of Devices for which config job was executed. Minimum length = 1 Maximum length = 64
tasklog_id <String> Read-write Task Log Id of the Config Job. Minimum length = 1 Maximum length = 128
name <String> Read-write Name of maintenance job. Minimum length = 1 Maximum length = 128
task_name <String> Read-write task name of maintenance job..
slack_profile <String> Read-write Slack profile.
parent_id <String> Read-write Parent Id of maintenance job..
mail_profiles <String> Read-write Comma separated list of Mail profiles.
id <String> Read-write Id is system generated key for all the maintenance jobs.
attached_maintenance_job <String> Read-write Attached maintenance job.
scheduleTime <String> Read-write Comma separated times of the day(DD:HH:MM) on which Configuration Template is scheduled.
status <String> Read-only Status of maintenance Job Started, In Progress, Scheduled, Failed, Completed.
username <String> Read-only Name of user who created maintenance job.
tenant_id <String> Read-only Tenant Id of the Config Jobs.
timestamp <Integer> Read-only Time of Creation of Maintenance Job.
devices_count <Integer> Read-only Number of Devices on which commands executed.
devices_completed_count <Integer> Read-only Devices Completed Count.

Operations

(click to see Properties )
  • ADD
  • DELETE
  • GET (ALL)
  • MODIFY
Some options that you can use for each operations:
  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:
    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes
    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,
    To do this, you must specify the username and password in the request header of the NITRO request as follows:
    X-NITRO-USER: <username>
    X-NITRO-PASS: <password>
    Note: In such cases, make sure that the request header DOES not include the following:
    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
*Note: * Mandatory parameters are marked in red and placeholder content is marked in green
The following parameters can be used in the nitro request : onerror <String_value>
Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE

add

URL: https://<MGMT-IP>/nitro/v2/config/maintenance_job?onerror=<String_value> HTTPS Method: POST
Request Headers: Content-Type: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"maintenance_job": {
"name":<String_value>,
"task_name":<String_value>,
"attached_maintenance_job":<String_value>,
"slack_profile":<String_value>,
"parent_id":<String_value>,
"id":<String_value>,
"scheduleTimesEpoch":<String_value>,
"device_family":<String_value>,
"tasklog_id":<String_value>,
"mail_profiles":<String_value>,
"scheduleTime":<String_value>}}
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "maintenance_job":[{
"scheduleTimesEpoch":<String_value>,
"device_family":<String_value>,
"status":<String_value>,
"tasklog_id":<String_value>,
"name":<String_value>,
"task_name":<String_value>,
"slack_profile":<String_value>,
"parent_id":<String_value>,
"username":<String_value>,
"mail_profiles":<String_value>,
"resource":<String_value>,
"tenant_id":<String_value>,
"timestamp":<Integer_value>,
"action":<String_value>,
"resource_object":<String_value>,
"id":<String_value>,
"devices_count":<Integer_value>,
"attached_maintenance_job":<String_value>,
"scheduleTime":<String_value>,
"devices_completed_count":<Integer_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v2/config/maintenance_job/id_value<String> HTTPS Method: DELETE
Request Headers: X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/maintenance_job Query-parameters:
filter https://<MGMT-IP>/nitro/v2/config/maintenance_job ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of maintenance_job resources configured on the system. You can set a filter on any property of the resource.
pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/maintenance_job ?pagesize=#no;pageno=#no Use this query-parameter to get the maintenance_job resources in chunks.
count https://<MGMT-IP>/nitro/v2/config/maintenance_job ?count=yes Use this query-parameter to get the count of maintenance_job resources.
HTTPS Method: GET
Request Headers: Accept: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Headers:
Content-Type:application/json
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "maintenance_job":[{
"scheduleTimesEpoch":<String_value>,
"device_family":<String_value>,
"status":<String_value>,
"tasklog_id":<String_value>,
"name":<String_value>,
"task_name":<String_value>,
"slack_profile":<String_value>,
"parent_id":<String_value>,
"username":<String_value>,
"mail_profiles":<String_value>,
"resource":<String_value>,
"tenant_id":<String_value>,
"timestamp":<Integer_value>,
"action":<String_value>,
"resource_object":<String_value>,
"id":<String_value>,
"devices_count":<Integer_value>,
"attached_maintenance_job":<String_value>,
"scheduleTime":<String_value>,
"devices_completed_count":<Integer_value>}]}

modify

URL: https://<MGMT-IP>/nitro/v2/config/maintenance_job/id_value<String> HTTPS Method: PUT
Request Headers: Content-Type: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"maintenance_job":{
<b>"id":<String_value></b>,
"name":<String_value>,
"task_name":<String_value>,
"attached_maintenance_job":<String_value>,
"slack_profile":<String_value>,
"parent_id":<String_value>,
"scheduleTimesEpoch":<String_value>,
"device_family":<String_value>,
"tasklog_id":<String_value>,
"mail_profiles":<String_value>,
"scheduleTime":<String_value>}}
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "maintenance_job":[{
"scheduleTimesEpoch":<String_value>,
"device_family":<String_value>,
"status":<String_value>,
"tasklog_id":<String_value>,
"name":<String_value>,
"task_name":<String_value>,
"slack_profile":<String_value>,
"parent_id":<String_value>,
"username":<String_value>,
"mail_profiles":<String_value>,
"resource":<String_value>,
"tenant_id":<String_value>,
"timestamp":<Integer_value>,
"action":<String_value>,
"resource_object":<String_value>,
"id":<String_value>,
"devices_count":<Integer_value>,
"attached_maintenance_job":<String_value>,
"scheduleTime":<String_value>,
"devices_completed_count":<Integer_value>}]}