Maintenance Plans Object

Defines the schema for configuring a maintenance plan.

API Endpoint

https://api.bigpanda.io/resources/v2.0/maintenance-plans

Supported Methods

POST, GET, PATCH, DELETE

Parameters

The Maintenance Plans object schema includes the following attributes:

Attribute

Description

Type

Example

id

System-generated unique identifier for a maintenance plan.

String

"id" : "1234a53b6789c12d3efg45h"

status

The maintenance plan's status.

String

“status”: ”expired”

maintenance_key

Third party (Jira, ServiceNow, etc.) system key. If not provided, a BigPanda identifier is generated for the plan.

String

"maintenance_key": "CNG-17810"

name

User-defined name for the plan.

String

"name" : "Plan-SJC"

condition

Maintenance condition in BPQL Object format.

String

"condition": {"=": ["host", "prod-api-1"]}

start

The scheduled date and time that the plan will start in Unix Epoch format.

String

“start”: “1234567”

end

The scheduled date and time that the plan will end in Unix Epoch format.

String

“end”: “1234999”

description

Brief user defined summary of the maintenance plan.

String

"description" : "Maintenance Plan for the SJC servers to be upgraded"

custom_tags

Metadata about the plan in an array of key:value pairs.

Array of Objects

"custom_tags" : [ { "name" : "app", "value" : "esp"} ]

created_at

The date and time that the plan was created in Unix Epoch format.

Long

"created_at" : 1493922189

created_by

The ID of the user who created the plan.

String

"created_by" : "Administrator 1"

updated_at

The date and time that the plan was last updated in Unix Epoch format.

Long

"updated_at" : 1372854204

updated_by

The ID of the user who last updated the plan.

String

"updated_by" : "Administrator 2"