FAQ: API

FAQ: API

Answers to common questions about the PulseAPI REST API.

Is the REST API available on all plans?

No. API access requires a Starter, Professional, or Team plan. The Free plan does not include API access.

How do I authenticate API requests?

Use a Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY_HERE

Generate API keys in Settings → API Keys. See Creating an API Key.

Are API keys per-user or per-team?

API keys are per-user and scoped to the team context they were created in. A key created while viewing Team A can only access Team A's resources.

What can I do with the API?

The PulseAPI REST API lets you:

  • Create, read, update, and delete monitors
  • Read incident records and check history
  • Manage alert rules and notification channels
  • Trigger manual checks
  • Manage team members and projects

See the full API Reference for all available endpoints.

What are the API rate limits?

Rate limits vary by endpoint. The API documentation includes rate limit headers in responses (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset). If you receive a 429 Too Many Requests response, back off and retry after the reset timestamp.

Can I create monitors via the API?

Yes. Send a POST request to /api/v1/monitors with the monitor configuration. See the API Reference for request parameters.

Can I use the API to get check history?

Yes. Use GET /api/v1/monitors/{id}/checks to retrieve check history for a specific monitor. Results are paginated.

Is there an API changelog?

Yes. See API Changelog for a history of API changes. Major version changes (e.g., v1 → v2) are announced in advance with a deprecation period.

Does the API use versioning?

Yes. The current version is v1. All API endpoints are prefixed with /api/v1/. Breaking changes will be introduced in a new version (e.g., /api/v2/) with prior notice.

How do I report an API bug or request a feature?

Contact support with the details.

Still have questions? Contact support.

    • Related Articles

    • FAQ: General

      Answers to the most common general questions about PulseAPI. How often does PulseAPI check my endpoints? It depends on your plan and what interval you configure on each monitor. The minimum interval is 60 seconds on Free and Starter plans, 15 seconds ...

    • Creating an API Key

      This article explains how to create a new API key for programmatic access to the PulseAPI REST API. Prerequisites: API access requires a Starter, Professional, or Team plan. Steps In the left sidebar, click Settings. Click the API Keys tab. Click ...

    • Managing API Keys

      API keys let you authenticate requests to the PulseAPI REST API so you can manage monitors, read incidents, and access your data programmatically. This article is an overview of API key management — for specific actions, see the linked articles ...

    • FAQ: Billing

      Answers to common questions about PulseAPI billing and plans. Can I try PulseAPI for free? Yes. The Free plan is available with no credit card required. It includes up to 10 monitors, email notifications, and 7-day check history. See Plans and ...

    • Deleting an API Key

      Deleting an API key immediately and permanently revokes it. Any system using the deleted key will fail to authenticate. Steps In the left sidebar, click Settings. Click the API Keys tab. Find the key you want to delete. Click the ... menu → Delete. ...