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. Company owners, company administrators, and company developers can create API keys. The level of access to the API will depend on the user’s access. For example, an API key generated by a company developer will not have the same access as a key generated by a company owner or administrator.
  1. Go to your username > Company settings > API Keys and click Create API Key.
  2. Choose an expiration or set a custom start date and number of hours for the key to expire.
  3. Give the key a name and click Generate.
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.
Keep your API key safe, and don’t share it with anyone who shouldn’t have access. If you need to share it with a developer or other user who needs API access, we recommend using a password manager like 1Password to share it securely. If you remove a user from your company, you should also review the API keys and revoke access to any that the user may have had access to.
To revoke access to an API key, click Revoke.

​
API endpoints

With Sevalla’s API, you can perform the following actions:

​
Applications

  • Get a list of your company’s applications and details about a specific application, including the deployment details and processes, update the application’s settings, and delete an application.
  • Get the deployment details of an application and manually or programmatically deploy your application.
  • Create an internal connection between your application and database.
  • Enable CDN and edge caching and clear the cache for both.

​
Pipelines

  • Get a list of your company’s pipelines.
  • Create a preview application.
  • Promote a preview application to the next stage in the pipeline.

​
Databases

  • Get a list of your company’s databases and details about a specific database, create a new database, update the database settings, and delete a database.

​
Static Site Hosting

  • Get a list of your company’s static sites and details about a specific site, update your site’s settings, and delete a site.
  • Get the deployment details of a static site and manually or programmatically deploy your site.

​
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.