Getting Started

Everything you need to make your first authenticated request, from account to response.

1. Create an Enterprise account

The Public API is available on the Enterprise plan. If your account isn't on Enterprise yet, upgrade from Pricing or contact sales — API access unlocks automatically once your subscription is active.

2. Generate an API key

Head to Developer Portal → API Keys and click Create API Key. Give it a name, choose an expiration, and select only the scopes it actually needs (see Scopes). Your key is shown exactly once — copy it immediately and store it somewhere safe.

3. Make your first request

Every request needs the key sent as a Bearer token in the Authorization header:

curl "https://api.paqet.net/v1/dns/lookup?domain=example.com&type=ARecord" \
  -H "Authorization: Bearer pk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

4. Read the response

Every endpoint returns the same envelope, whether it succeeds or fails:

{
  "success": true,
  "data": {
    "summary": "A record for example.com",
    "durationMs": 128,
    "results": [{ "value": "93.184.216.34" }]
  }
}

success tells you which shape to expect — data on success, or code and message on failure.

5. Handle errors

{
  "success": false,
  "code": "SCOPE_REQUIRED",
  "message": "The API key does not have the required scope for this operation."
}

Match on the code field, not the message text — messages may change wording over time, codes won't. See the full Errors reference.

6. Read the rate limit headers

Every response includes your current standing, regardless of whether the request succeeded:

X-RateLimit-Limit: 10000
X-RateLimit-Remaining: 9994
X-RateLimit-Reset: 1700000000

See Rate Limits for the full retry strategy.