Pingdom¶

class pingdom.Pingdom(username, password, app_key)¶

Create a Pingdom service.

Variables:	username (str) – The username for the authenticated user. password (str) – The password for the authenticated user. app_key (str) – The app_key for the application.

Actions¶

Pingdom.actions()¶: Return the resource corresponding to all actions

Actions.get(from_=None, to=None, limit=None, offset=None, checkids=None, contactids=None, status=None, via=None)¶

Returns a list of actions (alerts) that have been generated for your account.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceActions

Analysis¶

Pingdom.analysis(checkid)¶

Return the resource corresponding to the analysis for specified check

Variables:	checkid (str) – The check id

Analysis.get(from_=None, to=None, limit=None, offset=None)¶

Returns a list of the latest root cause analysis results for a specified check.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceAnalysis

Analysis.get_raw_analysis(analysisid)¶

Get Raw Analysis Results

Variables:	analysisid (str) – The specified error analysis id

Check¶

Pingdom.check(checkid)¶

Return the resource corresponding to a single check

Variables:	checkid (str) – The check id

Analysis¶

Check.analysis()¶: Return the resource corresponding to the analysis for the check.

Analysis.get(from_=None, to=None, limit=None, offset=None)

Returns a list of the latest root cause analysis results for a specified check.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceAnalysis

Analysis.get_raw_analysis(analysisid)

Get Raw Analysis Results

Variables:	analysisid (str) – The specified error analysis id

Results¶

Check.results()¶: Return the resource corresponding to the results for the check.

Results.get(from_=None, to=None, limit=None, offset=None, probes=None, status=None, includeanalysis=None, maxresponse=None, minresponse=None)¶

Return a list of raw test results for a specified check

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceResults

Summary¶

Check.summary()¶: Return the resource corresponding to the summary for the check.

Summary.average(from_=None, to=None, probes=None, includeuptime=None, bycountry=None, byprobe=None)¶

Get the average time / uptime value for a specified check and time period.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSummary.average

Summary.hoursofday(from_=None, to=None, probes=None, uselocaltime=None)¶

Returns the average response time for each hour of the day (0-23) for a specific check over a selected time period. I.e. it shows you what an average day looks like during that time period.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSummary.hoursofday

Summary.outage(from_=None, to=None, order=None)¶

Get a list of status changes for a specified check and time period. If order is speficied to descending, the list is ordered by newest first. (Default is ordered by oldest first.)

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSummary.outage

Summary.performance(from_=None, to=None, resolution=None, includeuptime=None, probes=None, order=None)¶

For a given interval in time, return a list of sub intervals with the given resolution. Useful for generating graphs. A sub interval may be a week, a day or an hour depending on the choosen resolution.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSummary.performance

Summary.probes(from_=None, to=None)¶

Get a list of probes that performed tests for a specified check during a specified period.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSummary.probes

Check.delete()¶

Deletes a check. You will lose all collected data.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#MethodDelete+Check

Check.get()¶

Returns a detailed description of a specified check.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#MethodGet+Detailed+Check+Information

Check.update(obj)¶

Modify settings for a check. The provided settings will overwrite previous values. Settings not provided will stay the same as before the update. To clear an existing value, provide an empty value. Please note that you cannot change the type of a check once it has been created.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/MethodModify+Check

Checks¶

Pingdom.checks()¶: Return the resource corresponding to all checks

Checks.create(obj)¶

Creates a new check with settings specified by provided parameters.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#MethodCreate+New+Check

Checks.delete()¶

Deletes a list of checks. You will lose all collected data.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#MethodDelete+Multiple+Checks

Checks.get(limit=None, offset=None)¶

Returns a list overview of all checks.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceChecks

Checks.update(obj)¶

Pause or change resolution for multiple checks in one bulk call.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#MethodModify+Multiple+Checks

Contact¶

Pingdom.contact(contactid)¶

Return the resource corresponding to a single contact

Variables:	contactid (str) – The contact id

Contact.delete()¶

Deletes a contact.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#MethodDelete+Contact

Contact.update(obj)¶

Modify a contact.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/MethodModify+Contact

Contacts¶

Pingdom.contacts()¶: Return the resource corresponding to all contacts

Contacts.create(obj)¶

Creates a new contact with settings specified by provided parameters.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#MethodCreate+Contact

Contacts.delete()¶

Deletes a list of contacts.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#MethodDelete+Multiple+Contacts

Contacts.get(limit=None, offset=None)¶

Returns a list of all contacts.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceContacts

Contacts.update(obj)¶

Modifies a list of contacts.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#MethodModify+Multiple+Contacts

Credits¶

Pingdom.credits()¶: Return the resource corresponding to all credits

Credits.get()¶

Returns information about remaining checks, SMS credits and SMS auto-refill status.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceCredits

Probes¶

Pingdom.probes()¶: Return the resource corresponding to all probes

Probes.get(limit=None, offset=None, onlyactive=None, includedeleted=None)¶

Returns a list of all Pingdom probe servers.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceProbes

Reference¶

Pingdom.reference()¶: Return the resource corresponding to the reference of regions

Reference.get()¶

Get a reference of regions, timezones and date/time/number formats and their identifiers.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceReference

ReportsEmail¶

Pingdom.report_email(reportid)¶

Return the resource corresponding to a single email report

Variables:	reportid (str) – The report id

ReportsEmail.create(obj)¶

Create a new resource.

Variables:	obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsEmail.delete()¶: Delete this resource.

ReportsEmail.get()¶

ReportsEmail.update(obj)¶

Update this resource.

Variables:	obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsPublic¶

Pingdom.report_public(reportid)¶

Return the resource corresponding to a single public report

Variables:	reportid (str) – The report id

ReportsPublic.create(obj)¶

Create a new resource.

Variables:	obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsPublic.delete()¶: Delete this resource.

ReportsPublic.get()¶

ReportsPublic.update(obj)¶

Update this resource.

Variables:	obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsShared¶

Pingdom.report_shared(reportid)¶

Return the resource corresponding to a single shared report

Variables:	reportid (str) – The report id

ReportsShared.create(obj)¶

Create a new resource.

Variables:	obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsShared.delete()¶: Delete this resource.

ReportsShared.get()¶

ReportsShared.update(obj)¶

Update this resource.

Variables:	obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsEmail¶

Pingdom.reports_email()¶: Return the resource corresponding to the email reports

ReportsEmail.create(obj)

Create a new resource.

Variables:	obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsEmail.delete(): Delete this resource.

ReportsEmail.get()

ReportsEmail.update(obj)

Update this resource.

Variables:	obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsPublic¶

Pingdom.reports_public()¶: Return the resource corresponding to the public reports

ReportsPublic.create(obj)

Create a new resource.

Variables:	obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsPublic.delete(): Delete this resource.

ReportsPublic.get()

ReportsPublic.update(obj)

Update this resource.

Variables:	obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsShared¶

Pingdom.reports_shared()¶: Return the resource corresponding to the shared reports

ReportsShared.create(obj)

Create a new resource.

Variables:	obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsShared.delete(): Delete this resource.

ReportsShared.get()

ReportsShared.update(obj)

Update this resource.

Variables:	obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Results¶

Pingdom.results(checkid)¶

Return the resource corresponding to the raw test results for a specified check

Variables:	checkid (str) – The check id

Results.get(from_=None, to=None, limit=None, offset=None, probes=None, status=None, includeanalysis=None, maxresponse=None, minresponse=None)

Return a list of raw test results for a specified check

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceResults

Servertime¶

Pingdom.servertime()¶: Return the resource corresponding to the servertime

Servertime.get()¶

Get the current time of the API server.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceServertime

Settings¶

Pingdom.settings()¶: Return the resource corresponding to the settings

Settings.get()¶: For single-object resources, fetch the object’s data. For collections, fetch all of the objects.

Settings.update(obj)¶

Modify account-specific settings.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#MethodModify+Account+Settings

Single¶

Pingdom.single()¶: Return the resource corresponding to the single test

Single.get(**params)¶

Performs a single test using a specified Pingdom probe against a specified target. Please note that this method is meant to be used sparingly, not to set up your own monitoring solution.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSingle

Summary¶

Pingdom.summary(checkid)¶

Return the resource corresponding to the summary for a specified check.

Variables:	checkid (str) – The check id

Summary.average(from_=None, to=None, probes=None, includeuptime=None, bycountry=None, byprobe=None)

Get the average time / uptime value for a specified check and time period.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSummary.average

Summary.hoursofday(from_=None, to=None, probes=None, uselocaltime=None)

Returns the average response time for each hour of the day (0-23) for a specific check over a selected time period. I.e. it shows you what an average day looks like during that time period.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSummary.hoursofday

Summary.outage(from_=None, to=None, order=None)

Get a list of status changes for a specified check and time period. If order is speficied to descending, the list is ordered by newest first. (Default is ordered by oldest first.)

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSummary.outage

Summary.performance(from_=None, to=None, resolution=None, includeuptime=None, probes=None, order=None)

For a given interval in time, return a list of sub intervals with the given resolution. Useful for generating graphs. A sub interval may be a week, a day or an hour depending on the choosen resolution.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSummary.performance

Summary.probes(from_=None, to=None)

Get a list of probes that performed tests for a specified check during a specified period.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSummary.probes

Traceroute¶

Pingdom.traceroute()¶: Return the resource corresponding to the traceroute test

Traceroute.get(host=None, probeid=None)¶

Perform a traceroute to a specified target from a specified Pingdom probe.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceTraceroute