Sevalla API

Overview of Sevalla’s API.

Sevalla’s REST API (Application Programming Interface) gives you a simple yet powerful way to access and interact with your Sevalla projects. It streamlines working with our platform, making it easy to retrieve data, perform actions, and automate tasks efficiently.

For full details on available API endpoints, to download our OpenAPI specification, and to try out endpoints, see our API reference.

Authentication and user access (API key)

To use Sevalla’s API, you need to generate an API key to authenticate and access your account through the API. You can generate multiple API keys.

1. Get your API key

   Generate an API key from your Sevalla dashboard > Integration > API keys > Create API key. This key authenticates all API requests.

2. Authenticate requests

   Pass your API key as a Bearer token in the Authorization header:

   curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://api.sevalla.com/v2/applications
   
3. Explore the endpoints

   Browse the endpoint reference in the sidebar of the API reference docs. Each endpoint includes request and response schemas, parameter details, and code examples you can copy directly into your project.

Use the Try it console on any endpoint page to make live API calls. You’ll need your API key and any required parameters for the endpoint you want to test.

When the API key is provided, this is the only time you can see it. Make sure you copy it and store it somewhere safe.

To remove an API key, click the ellipsis (three dots) and click Delete.

API permissions

When creating an API key, you can choose a predefined role or define custom capabilities. Predefined role matches the existing roles available in User management. Custom capabilities allow you to define precise permissions, such as create, read, update, or delete, at both the resource type and individual resource level.

For example, you can grant read-only access to specific applications or allow update access to selected sites only.

Rate limits

To protect our API from being flooded with too many requests, the number of requests per minute is limited to the following:

• 120 requests per minute per company ID identified from the API key.
• 1000 requests per minute per IP address. This would come into force if you have access to multiple companies.
• 5 requests per minute for resource creation.

To see your current rate limit status, check the RateLimit headers in the most recent API response. It is not currently possible to increase the rate limit.