Skip to content

Put previews into your own tools and pipelines

The REST API manages preview links, runs QA reports and checks DNS propagation with the same rules and plan limits as the dashboard. Create a preview for every pull request, deploy or customer migration.

Create a free previewSee pricing
curl
# List the links of the workspace
curl https://api.dnspeek.link/api/v1/links \
  -H "Authorization: Bearer $DNSPEEK_API_KEY"

# Create a preview link
curl -X POST https://api.dnspeek.link/api/v1/links \
  -H "Authorization: Bearer $DNSPEEK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"targetDomain":"shop.example.com","targetIp":"203.0.113.10"}'

What you get

  • Links, reports and DNS

    Create, change and delete preview links, start QA reports and read their results, and check DNS propagation.

  • Keys you control

    Read and write or read-only access, an expiry date, an IP allowlist and one-click rotation. Every key is listed with its last use.

  • Events where your team works

    Send DNS propagation, QA results, client approvals and expiring links to Slack, Telegram, Microsoft Teams, Discord, email or a signed webhook.

  • Previews for every pull request

    A GitHub Action creates or updates a preview per pull request, can run a QA report and comments the results on it.

How it works

  1. 1

    Create an API key

    Open API Keys in the sidebar, name the key and choose its access, expiry and allowed IPs. Copy it: it is shown once.

  2. 2

    Call the API

    Send the key as a Bearer token. Every endpoint, field and error code is in the REST API reference.

  3. 3

    Hand the link on

    Put the preview URL in a pull request, a ticket or a welcome email to your customer.

Plans

What each plan includes for this feature, from the current plan catalog.

  • API access

    Free
    Not included
    Pro
    Included
    Agency
    Included
    Provider
    Included

  • API requests / minute per key

    Free
    Not included
    Pro
    60
    Agency
    300
    Provider
    1,000

  • Rows per bulk import

    Free
    Not included
    Pro
    100
    Agency
    1,000
    Provider
    10,000

  • Notification channels

    Free
    Not included
    Pro
    3
    Agency
    20
    Provider
    Unlimited

Compare all plans

Questions, answered

Which plans include the API?

Plans with API access; see the table above for the plans and their request limits.

Can customers open a filled-in preview form without a key?

Yes. A link to /new with the domain and IP in the address opens the preview form filled in, on every plan. Nothing is created until they click.

Whose links does a key create?

A key works in the workspace it was created in and acts as the person who created it. If they leave the workspace, the key stops working.

Is there a limit on requests?

Yes, a number of requests per minute per key that depends on the plan. Safe retries with an idempotency key are supported.

Check the new server before your visitors do

Free, no credit card, and no account needed for your first link.

No server handy? See a demo