DocsAPI ReferenceRelease Notes
API Reference
BigPanda AppRequest DemoBigPanda UniversityBigPanda Community

Retrieve All Plans v2

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

Retrieve a list of all maintenance plans, or filter and search maintenance plans that meet specific conditions.

🚧

Authentication

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

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

🚧

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.

🚧

Rate Limitations

To maintain quality of service, BigPanda APIs are limited to 5 requests per second.

Additional requests will return a 429 response code and the request will need to be retried

👍

Epoch Time Conversion

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

Migrating to the Retrieve All Plans v2 Route

This route provides improved search and filter functionality over the Maintenance Plans V2 Retrieve All Plans v1 route.

Differences between the v1 and v2 route:

  • URL: https://api.bigpanda.io/resources/v2.0/maintenance-plans --> https://api.bigpanda.io/resources/v2.0/ordered-maintenance-plans
  • Queries: active: true --> status: <planned or running>; active: false --> status: done
  • Pagination: pagination --> page and per_page fields
  • New Query modifiers: sort_by, order, search_text, frequency

See the Manage Planned Maintenance documentation for additional details on plan fields and statuses.

Sample Call

curl --request GET \
     --url https://api.bigpanda.io/resources/v2.0/ordered-maintenance-plans?sort_by=created_at&order=desc&per_page=100&page=1&search_text=east&status=planned&frequency=once&source=nagios.east \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer <User API Key>'

curl --request GET \
     --url https://eu-api.bigpanda.io/resources/v2.0/ordered-maintenance-plans?sort_by=created_at&order=desc&per_page=100&page=1&search_text=east&status=planned&frequency=once&source=nagios.east \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer <User API Key>'
Language