DocsAPI ReferenceRelease Notes
API Reference
BigPanda AppRequest DemoBigPanda UniversityBigPanda Community

Retrieve All Plans v1

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

Retrieves the schema definitions for all maintenance plans.

📘

New endpoint version & additional functionality

The Retrieve All Plans v2 adds additional functionality and performance to retrieving maintenance plans. When possible, BigPanda recommends leveraging the V2 route API instead of the V1 route.

If you have previously configured a recurring call using the V1 route, you can update those processes to the new version by following the Migration steps below.

No additional steps are necessary to configure a new API call using the V2 route.

🚧

Authentication

All BigPanda APIs require Bearer Token Authorization in the call headers.

This API uses the User API Key type of Authorization token.

📘

If there are more than the default 100 plans retrieved, a link header to access the next page of results will be returned:
</maintenance-plans?pagination=true&next=2_1564317563_5d3d977b310000179e99ecdd>; rel=next

🚧

Limitations

Maintenance plans can only be returned for 60 days after the end date.

The API can only return up to 100,000 maintenance plans.

👍

Epoch Time Conversion

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

Sample Call

curl --request GET \
     --url https://api.bigpanda.io/resources/v2.0/maintenance-plans \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer <User API Key>'

curl --request GET \
     --url https://eu-api.bigpanda.io/resources/v2.0/maintenance-plans \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer <User API Key>'
Language