🔑 Understand API-key authentication
Search Atlas API requests require a valid API key. The key identifies your account and authorizes access to the API features available to you.
If the API documentation index does not show an authentication entry, this does not mean authentication is unavailable. Open the endpoint documentation and follow its API-key requirements.
🛠️ Add your API key to a request
- Open the Search Atlas platform and locate your API access or developer settings.
- Copy an active API key. Create a new key if you do not have one.
- Send the key in the authentication header required by the API documentation, such as the documented API-key header.
- Keep the key private and store it in an environment variable or secure secrets manager.
Do not place an API key in a public code repository, browser-side script, URL, screenshot, or support message. Never include it when sharing logs.
🔍 Check authentication errors
- 401 Unauthorized: Confirm that the key is included, copied completely, active, and sent using the required header name.
- 403 Forbidden: The key may be valid but lack permission for the requested resource.
- Documentation mismatch: Check that you are using the current API version and the authentication instructions for that endpoint.
- Unexpected failures: Remove extra spaces or quotation marks and confirm that your request is sent to the correct Search Atlas API host.
🔒 Protect and replace a key
Use separate keys for development and production when possible. If a key is exposed, revoke it immediately, create a replacement, and update the systems that use it.
💬 Get help with authentication
When contacting support, share the endpoint, HTTP status code, request timestamp, and a redacted request example. Do not share your API key.
If you need further assistance, open the chat widget in the bottom-right corner of the platform and type human teammate to be instantly connected with a member of our team.