Visualping API

Edited

Contents of this article:

  • What can the visualping API do?

  • Creating an API key

  • Managing my API keys

  • Visualping API skill for Claude

  • FAQ


What can the Visualping API do?

Before getting started, note that a Visualping Business or Solutions plan is required to generate a Visualping API key.

The Visualping API lets you integrate Visualping's monitoring capabilities directly into your own applications and workflows. Use it to programmatically create, update and delete jobs, retrieve changes, and automate actions based on website changes.

Check out our complete API documentation here.


Creating an API key

Step 1:

Open the developer settings

Go to Settings>Developer from the dashboard, or using the link.

Step 2:

Create a new key

Click on Create API Key.

Then fill out the key details:

Name

  • Give the key a descriptive name. Remember that "Zapier - Price Alerts" is easier to audit than "Key 1".

Scope: Organization vs. Workspace

  • Use Organization if your integration needs data from multiple workspaces (e.g., a centralized reporting dashboard).

  • Use Workspace if you want to limit access to a single workspace's jobs.

    • If Workspace is selected, you will need to select the specific workspace from the "Workspace" dropdown.

Access: Read vs. Write

  • Use Read if you only need to pull data (e.g., listing jobs, checking change history).

  • Use Write if your integration needs to create or modify jobs (e.g., programmatically adding monitors).

Tip: Follow the principle of least privilege. Start with Read access and a Workspace scope. Upgrade later if needed.

Expiration

  • Use Never for long-running integrations you maintain actively.

  • Use 1 month or 3 months for temporary projects, contractor access, or testing.

  • Use 6 months or 1 year as a middle ground: automatic expiry without frequent rotation.

Finally click on Create,

Step 3:

Save the key

Your new key will appear in the "API Key Created" dialog. Click Copy to copy the key to your clipboard. Paste the key somewhere secure, as the key will only be shown once. If you close this dialog without copying the key, you'll need to delete it and create a new one.


Managing my API keys

From the Developer tab, you can:

  • View all active keys with their scope, access level, and last-used date

  • Delete a key you no longer need (this immediately revokes access)

You can have up to 5 API keys per organization. If you've reached the limit, delete an unused key before creating a new one.

Pro Tip: Rotate keys periodically for security. Create a new key, update your integration, then delete the old one.


Visualping API skill for Claude

We have created a Claude skill that lets you interact with the Visualping API directly from Claude — create jobs, list jobs, check change history, and more, all using natural language.

Check out this Github page for installation steps and more details.


Frequently Asked Questions

I don't see the Developer tab

You need Admin access to your organization. Ask your account administrator to either grant you Admin permissions or create the key for you.

I closed the dialog without copying my key

The key cannot be retrieved after the dialog is closed. Delete the key from the Developer page and create a new one.

I've reached the 5-key limit

Review your existing keys on the Developer page. Delete any that are no longer in use, then create a new one.

My API key isn't working

  • Confirm the key hasn't expired.

  • Check that the key's Access level matches what your integration needs (e.g., a Read-only key can't create jobs).

  • Check that the key's Scope covers the workspace your integration is trying to access.

  • Make sure you're passing the key correctly in your API request headers. See the API docs for authentication details.

I need more than 5 keys

Contact Visualping support at support@visualping.io to discuss your needs.


Related articles:

Was this article helpful?

Sorry about that! Care to tell us more?

Thanks for the feedback!

There was an issue submitting your feedback
Please check your connection and try again.