How do I create an API key?

Where: Settings → Advanced → Connect other apps

Open this page: admin.<your-site>/settings/integrations (replace <your-site> with your site address). If you don’t see it in the menu, turn on Show all settings on the Settings page.

Before you start

• Only the site owner can create keys.

Steps

1. Open Settings → Advanced → Connect other apps → API keys.
2. Press Create key.
3. Enter a Name, for example "Partner website".
4. Under What can it do? tick what is needed:
   • Read stories: published stories, not paywalled text.
   • Read full paywalled text: also the full text of paid stories.
   • Send drafts: add stories as drafts. Nothing goes live without your team.
   • Send photos: add photos to your media library from a web address.
   • Read sections and tags.
   • Read traffic numbers: story views and visitor totals.
   • Read money reports: totals only, never readers.
5. Optional: set Expires on, Only from these addresses (one per line, up to 20), Requests per minute (1 to 600) and Requests per day (1 to 1,000,000).
6. Press Create key.
7. Copy the key from the box. This is the only time you will see it. Press I saved it.
8. Give the key to the other app. It sends it in the "Authorization: Bearer" header.

Good to know

• The list shows each key's Name, Can do, Last used, Expires and Status: Working, Expired or Stopped.
• Make a new key replaces a key. The old one keeps working for a while you choose, or choose Stop now if it may have leaked.
• Stop key refuses all requests with that key at once. You cannot undo this. Create a new key to let the app in again.
• A key's detail shows its use in the last 30 days.
• Each key has its own limits. An app that asks too often is slowed down.
• A key with paywalled text lets anyone who has it read stories your readers pay for. Keep it safe.

Common problems

• "You have reached the number of keys you can have. Stop a key you no longer use first."
• "Give the key a name."
• "Choose at least one thing the key can do."
• "Choose a day in the future."

Questions

Related

• Connect other apps
• Webhooks