Skip to main content
Version: v2

Authentication

The server API requires an API key to access and modify data in FullStory.

note

The API key must have Admin or Architect level permissions to view or delete data.

This API key should be added to the Authorization header for all requests:

'Authorization: Basic {YOUR_API_KEY}'

You can view and manage your API keys in the “API Keys” section of the FullStory settings page.

List Keys

Creating a Key

Standard and Admin FullStory users may create API keys, and Architect users (available only for Enterprise plans) may also create API keys. Only keys created with Admin or Architect level permissions will work for requests that view or delete data. Standard keys will work for create, update, and batch (create/status) requests. You can create multiple keys, but for security reasons you should only create as many as you need, no more. To create a new API key:

  1. Click the “Create key” button in the top-right corner of the keys list. The “Create API Key” sidecar will slide out from the right. Create Key
  2. Enter a meaningful key name, and select the permission level for this key. If you don’t get these quite right, don’t worry--you can change them later.
  3. Click “Save API Key.”
  4. Upon successful creation of a key, a modal will appear with the new key’s value. You must copy the value from this modal at this time. You will not be able to see the key value again. Copy the value, save it in your preferred API key or password manager, and close the modal.

More details about managing API keys can be found here.