API Key Authentication for GetRequest

Every request you send through GetRequest’s API Gateway must include your API key. The key tells GetRequest which account is making the request and whether it has permission to proceed. Without it — or with an invalid key — the gateway rejects the request before it ever reaches your endpoint.

Finding your API key

Your API key is available in the GetRequest dashboard under Settings → API Key. It is separate from your project URI (more on that distinction below). You’ll need it any time you send traffic through a GetRequest endpoint.

Including the key in requests

Pass your API key as the x-api-key header on every request. The header name is lowercase and must match exactly.

curl -X POST https://e.getrequest.io/{project_uri}/your-slug \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"hello": "world"}'

const response = await fetch('https://e.getrequest.io/{project_uri}/your-slug', {
  method: 'POST',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ hello: 'world' }),
});

const data = await response.json();
console.log(data);

import requests

response = requests.post(
    'https://e.getrequest.io/{project_uri}/your-slug',
    headers={
        'x-api-key': 'YOUR_API_KEY',
        'Content-Type': 'application/json',
    },
    json={'hello': 'world'},
)

print(response.json())

Never commit your API key to source control or expose it in client-side code. Treat it with the same care as a password. If you suspect it has been compromised, regenerate it immediately.

API key vs. project URI

These two identifiers are easy to confuse, but they serve entirely different purposes:

Identifier	What it is	Where to find it
API key	Authenticates you to the API Gateway	Settings → API Key
Project URI	Identifies which project a request belongs to (e.g., `ddfkU760XMs2z7te`)	Your project page

Your API key is a credential — it proves you own the account. Your project URI is just a routing token embedded in the endpoint URL. You include the project URI in the URL path, and the API key in the request header. The two are not interchangeable.

What happens with a missing or invalid key

If you omit the x-api-key header or supply an incorrect value, the API Gateway returns an authentication error and the request is rejected immediately. It does not reach your endpoint, is not logged, and is not counted against your monthly quota. Double-check that you’re copying the key from Settings → API Key and that no extra whitespace was included.

Rotating your API key

If your key is compromised, shared accidentally, or you simply want to cycle it as a routine security practice, you can regenerate it at any time:

Open the GetRequest dashboard and navigate to Settings → API Key.
Click Regenerate.
Copy the new key and update all clients, services, and environment variables that use it.

Your old API key is invalidated the moment you click Regenerate. Any requests still using the old key will immediately start receiving authentication errors. Make sure you update all integrations before regenerating.

You can regenerate your API key up to 6 times per hour. If you hit that limit, wait until the hour resets before regenerating again.

Get Started

Core Concepts

Guides

Account

API Key Authentication for GetRequest

Finding your API key

Including the key in requests

API key vs. project URI

What happens with a missing or invalid key

Rotating your API key

​Finding your API key

​Including the key in requests

​API key vs. project URI

​What happens with a missing or invalid key

​Rotating your API key

Finding your API key

Including the key in requests

API key vs. project URI

What happens with a missing or invalid key

Rotating your API key