The Perry Weather API uses API keys to authenticate requests. Every call to the API must include a valid key in the x-api-key header so the server can identify your organization and enforce access controls.

Creating & Managing API Keys

This section is for Perry Weather account admins who need to generate and manage API keys.

Prerequisites

You must have the access to edit integrations in your Perry Weather account to create keys. If you do not have this access, please contact your account admin.

Creating a key

1. In the Perry Weather dashboard, navigate to Integrations > Perry Weather APIs.
2. Select the API Keys tab.
3. Click Create API Key.
4. Enter a descriptive name for the key (e.g. "Production API Key").
5. Click Create Key.
6. The key is displayed on screen. Copy it immediately — this is your only opportunity to view the key. You will not be able to retrieve it after closing the dialog.
7. Click Done.

Viewing existing keys

The API Keys tab lists every active key for your organization. Each entry shows:

• Name — the label you assigned when the key was created.
• Created — the date the key was generated.

Deleting a key

1. Locate the key you want to remove in the list.
2. Click the delete icon on that row.
3. Confirm the deletion in the dialog that appears.

Deletion is permanent and immediate — any application using the deleted key will lose access right away.

Replacing a lost key

If a key has been lost or compromised, delete the old key and create a new one.

Key management best practices

• Store keys securely. Use environment variables or a secrets manager (e.g. AWS Secrets Manager, HashiCorp Vault). Never hard-code keys in source files or commit them to version control.
• Rotate keys periodically. Create a replacement key, update your applications, then delete the old one.
• Use descriptive names. Name each key after its environment or application (e.g. "Staging - Weather Widget", "Production - Backend Service") so you can identify and manage them easily.
• Delete unused keys promptly. Reducing the number of active keys limits your exposure if one is compromised.
• Limit key distribution. Share keys only with the systems and team members that need them.

Using API Keys

This section is for developers integrating with the Perry Weather API. Once an admin has provided you with an API key, include it in every request as shown below.

Authentication header

Add the x-api-key header to every HTTP request:

x-api-key: YOUR-API-KEY

cURL

curl -X GET "https://customer.api.perryweather.com/v1/health" \
-H "x-api-key: YOUR_API_KEY"

JavaScript (fetch)

const response = await fetch("https://customer.api.perryweather.com/v1/health", {
headers: {
  "x-api-key": "YOUR_API_KEY",
},
});
const data = await response.json();

Python (requests)

import requests

response = requests.get(
  "https://customer.api.perryweather.com/v1/health",
  headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()