Creating an API Key

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

  1. In the left sidebar, click Settings.
  2. Click the API Keys tab.
  3. Click Create API Key.
  4. Enter a Name for the key. Use a descriptive name that identifies how it will be used (e.g., "CI/CD Pipeline", "Monitoring Dashboard", "Zapier Integration").
  5. Select the Permissions (abilities) this key should have. Grant only the permissions needed for the intended use.
  6. Click Create.

Copy Your API Key

After creation, PulseAPI displays the full API key token once. This is the only time you'll see the complete token.

Warning: Copy the token immediately and store it in a secure location — a password manager, secrets manager (e.g., AWS Secrets Manager, HashiCorp Vault), or your CI/CD environment's secret variables. If you navigate away without copying it, the token is gone and you'll need to create a new key.

The API Keys list will only ever show the last 8 characters of the token afterward.

Using Your API Key

Include the API key in the Authorization header of every API request:

Authorization: Bearer YOUR_API_KEY_HERE

For example, with curl:

curl https://api.pulseapi.io/v1/monitors \
  -H "Authorization: Bearer YOUR_API_KEY_HERE"

Refer to the API Reference for a full list of available endpoints.

Related Articles

Still have questions? Contact support.

    • Related Articles

    • 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. ...

    • Rotating an API Key

      Rotating an API key generates a new token and immediately invalidates the old one. Use rotation when you suspect a key has been compromised, as part of a regular security rotation schedule, or when handing off access to a new system. Steps In the ...

    • 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 ...

    • Monitor Settings Reference

      This article describes every field in the monitor create/edit form. Use it as a reference when configuring a monitor or troubleshooting unexpected behavior. Basic Settings Name A label for the monitor. Appears in the dashboard, incident ...

    • Deleting Your Account

      Deleting your account permanently removes your PulseAPI user account and all personal data. This is separate from canceling a subscription or deleting a team. Warning: Account deletion is irreversible. There is no grace period or recovery option. ...