Welcome to the New BigPanda API Documentation

Create a new maintenance plan

US Region

https://api.bigpanda.io

POST

/resources/v2.0/maintenance-plans

Creates a new schema definition for creating a new maintenance plan.

Condition limitations

Maintenance plan conditions cannot be longer than 25,000 characters long. All alert tags in maintenance plan conditions are case-insensitive.

See the Epoch Converter to convert times to unix epoch format.

Authentication

All BigPanda APIs require Bearer Token Authorization in the call headers.
This API uses the User API Key type of Authorization token. Your User API Key must be provided in the header, prefixed by the word Bearer.

Example:
Authorization: Bearer [YOUR_USER_API_KEY]

Rate limit: 5 requests per second.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Examples

Responses

🟢201

application/json

201

Bodyapplication/json

🟠400

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.bigpanda.io/resources/v2.0/maintenance-plans' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "host1 maintenance",
    "condition": {
        "property1": "string",
        "property2": "string"
    },
    "start": 0,
    "end": 0,
    "description": "string",
    "frequency": "Once",
    "frequency_data": {
        "relativity": "string",
        "duration": 0
    },
    "post_maintenance_action": "None",
    "time_zone": "string",
    "custom_tags": [
        {
            "name": "string",
            "value": "string"
        }
    ]
}'

Response Example

201 - Example 1

{
    "id": "64f0b24f340000bbd269595c",
    "status": "planned",
    "maintenance_key": "MNT-de9d22d700e9",
    "name": "host1 maintenance",
    "start": 1733904622,
    "end": 1734768622,
    "description": "this is a description",
    "custom_tags": [
        {
            "name": "app",
            "value": "esp"
        }
    ],
    "created_by": "63bd56897755560012bf3555",
    "created_at": 1613252381,
    "updated_by": "63bd56897755560012bf3555",
    "updated_at": 1613252381,
    "frequency": "Daily",
    "frequency_data": 1613252381
}

Modified at 2026-09-04 16:33:42

Maintenance Plans

Retrieve All Plans

Create a new maintenance plan

Condition limitations#

Authentication#

Request

Responses

Condition limitations

Authentication