Summary
This article explains how to configure authentication for REST API actions in Astra. It covers the supported authentication methods, when to use each one, and how to set them up correctly so your API requests are accepted.
Instructions
Authentication tells an external system that the request coming from Astra is allowed. When setting up a REST API action, you can choose one of the supported authentication methods based on what your API requires.
Astra currently supports the following authentication options:
API key authentication
Basic authentication
No authentication
API key authentication
This is the most common authentication method used by modern APIs.
With API key authentication, you send a key or token in the request headers.
What you need to provide
auth_key: The name of the HTTP header (for example,
AuthorizationorX-API-Key)auth_value: The value sent in the header (for example,
Bearer your-token)
Common patterns
Service type | Header name | Header value format |
Most APIs |
|
|
Custom APIs |
|
|
Webhook services |
|
|
Make sure the header name and value exactly match what your API documentation expects.
Basic authentication
Basic authentication is typically used by older or legacy systems. With this method:
You provide a username and password
Astra sends these credentials using standard HTTP Basic Authentication
No authentication
Some public webhook endpoints do not require any authentication.
Tips for a successful setup
Confirm the required authentication method in your API documentation
Double-check header names, values, and token formats
Test the REST API action after saving to ensure authentication is working
Choosing the correct authentication method ensures your REST API actions run smoothly and securely.