API documentation — Pingdom

Cited by

Facts read from this source

• API version Report an error

  “Pingdom Public API (3.1)”

• API type Report an error

  “The Pingdom API is RESTful and HTTP-based.”

• API capability Report an error

  “With the API, you can create your own scripts or applications with most of the functionality you can find inside the Pingdom control panel.”

• Auth token Report an error

  “Authentication is needed in order to use the Pingdom API, and for this a Pingdom API Token is required.”

• Auth bearer Report an error

  “The authentication method for using tokens is HTTP Bearer Authentication (encrypted over HTTPS). This means that you will provide your token every time you make a request. No sessions are used.”

• Auth basic supported Report an error

  “For compatibility reasons, the Pingdom API allows to use HTTP Basic Authentication with tokens. In cases where this is necessary, input the API token as the username and leave the password field empty.”

• Token access levels Report an error

  “The Pingdom API Token has a property called “Access level” to define its permissions. All operations that create or modify something (e.g. checks) need the Read/Write permission.”

• Base URL https required Report an error

  “The base server address is: https://api.pingdom.com Please note that HTTPS is required. You will not be able to connect through unencrypted HTTP.”

• Parameter formats Report an error

  “GET requests should provide their parameters as a query string, part of the URL. POST, PUT and DELETE requests should provide their parameters as a JSON.”

• Json responses Report an error

  “All responses are sent JSON-encoded.”

• Rate limiting Report an error

  “The Pingdom API has usage limits to avoid individual rampant applications degrading the overall user experience. There are two layers of limits, the first cover a shorter period of time and the second a longer period.”

• Rate limit exceeded status Report an error

  “If limits are exceeded, an HTTP 429 error code with the message "Request limit exceeded, try again later" is sent back.”

• Gzip Report an error

  “Responses can be gzip-encoded on demand.”

• Php example Report an error

  “Here is a short example of how you can use the API with PHP. You need the cURL extension for PHP.”

• Transaction check types Report an error

  “There are two types of transaction checks: script: the legacy TMS check created with predefined commands in the Pingdom UI or via the public API recording: the TMS check created by recording performed actions in WPM recorder.”

• Tms script commands Report an error

  “There has to be exactly one go_to step”

• Tms validations Report an error

  “Verify the state of the page”

• Endpoint actions Report an error

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

• Endpoint analysis Report an error

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

• Endpoint checks list Report an error

  “Returns a list overview of all checks.”

• Checks list limit Report an error

  “Limits the number of returned probes to the specified quantity. (Max value is 25000)”

• Check types Report an error

  “Enum: "http" "httpcustom" "tcp" "ping" "dns" "udp" "smtp" "pop3" "imap"”

• Check resolution Report an error

  “resolution integer Default: 5 Enum: 1 5 15 30 60 How often should the check be tested? (minutes)”

• Responsetime threshold plan restriction Report an error

  “Triggers a down alert if the response time exceeds threshold specified in ms (Not available for Starter and Free plans.)”

• Ipv6 Report an error

  “Use ipv6 instead of ipv4, if an IP address is provided as host this will be overrided by the IP address version”

• Probe region filters Report an error

  “Currently only region is supported. Possible values are 'EU', 'NA', 'APAC' and 'LATAM'. For example, "region: NA".”

• Certificate verification Report an error

  “Treat target site as down if an invalid/unverifiable certificate is found.”

• Bulk check modification Report an error

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

• Tagging Report an error

  “List of tags for check. The maximum length of a tag is 64 characters.”

• Content validation Report an error

  “Target site should contain this string. Note! This parameter cannot be used together with the parameter “shouldnotcontain”, use only one of them in your request.”

• Openapi spec download Report an error

  “Download OpenAPI specification:Download”

• Best practice cache Report an error

  “If you are building a web page using the Pingdom API, we recommend that you do all API request on the server side, and if possible cache them.”

• Max check resolution Report an error

  “The highest check resolution is one minute.”

21 facts read from this page are not shown because they could not be confirmed on the page as captured.

Scores citing this record

• The Agency Developer Checks, locations & failure confirmation
• The Agency Developer Alerting, escalation & on-call
• The Agency Developer Status pages & incident communication
• The Agency Developer API, monitoring as code & team administration
• The Agency Developer Uptime reports, data & the vendor's own reliability
• The Agency Developer European sovereignty
• The Agency Developer Pricing transparency
• The Customer Support Lead Checks, locations & failure confirmation
• The Customer Support Lead Alerting, escalation & on-call
• The Customer Support Lead Status pages & incident communication
• The Customer Support Lead API, monitoring as code & team administration
• The Customer Support Lead Uptime reports, data & the vendor's own reliability
• The Customer Support Lead European sovereignty
• The Customer Support Lead Pricing transparency
• The E-Commerce Operations Manager Checks, locations & failure confirmation
• The E-Commerce Operations Manager Alerting, escalation & on-call
• The E-Commerce Operations Manager Status pages & incident communication
• The E-Commerce Operations Manager API, monitoring as code & team administration
• The E-Commerce Operations Manager Uptime reports, data & the vendor's own reliability
• The E-Commerce Operations Manager European sovereignty
• The E-Commerce Operations Manager Pricing transparency
• The SaaS Platform Engineer Checks, locations & failure confirmation
• The SaaS Platform Engineer Alerting, escalation & on-call
• The SaaS Platform Engineer Status pages & incident communication
• The SaaS Platform Engineer API, monitoring as code & team administration
• The SaaS Platform Engineer Uptime reports, data & the vendor's own reliability
• The SaaS Platform Engineer European sovereignty
• The SaaS Platform Engineer Pricing transparency
• The Information Security Officer Checks, locations & failure confirmation
• The Information Security Officer Alerting, escalation & on-call
• The Information Security Officer Status pages & incident communication
• The Information Security Officer API, monitoring as code & team administration
• The Information Security Officer Uptime reports, data & the vendor's own reliability
• The Information Security Officer European sovereignty
• The Information Security Officer Pricing transparency
• The Skeptic Checks, locations & failure confirmation
• The Skeptic Alerting, escalation & on-call
• The Skeptic Status pages & incident communication
• The Skeptic API, monitoring as code & team administration
• The Skeptic Uptime reports, data & the vendor's own reliability
• The Skeptic European sovereignty
• The Skeptic Pricing transparency