Seqera API
Seqera Platform services API
Authentication
- HTTP: Bearer Auth
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | jwt |
The API requires authentication with a Platform access token to perform requests.
Create an access tokenOpenAPI specification
The API and its interactive reference documentation is built on the OpenAPI standard.
For more information on the OpenAPI standard, see OpenAPI.
API versioning
The API uses the semantic versioning convention (major.minor.patch). In the event that a breaking change is introduced in future versions, we will publish guidance on the v1 support schedule and steps to mitigate disruption to your production environment. The following do not constitute breaking changes:
- Adding new API endpoints, new HTTP methods to existing endpoints, request parameters, or response fields
- Adding new values to existing enums or string constants
- Expanding accepted input formats or value ranges
- Adding new optional headers or query parameters
- Improving error messages or adding new error codes
- Deprecation warnings (without removal)
Clients should be designed to gracefully handle unknown enum values, ignore unrecognized response fields, and not rely on specific error message text.
Encoding and formatting standards
- For Seqera Cloud accounts, the API can be accessed from
https://api.cloud.seqera.io. - All API endpoints use HTTPS, and all request and response payloads use JSON encoding.
- All timestamps use the ISO 8601 date-time standard format:
YYYY-MM-DDTHH:MM:SSZ.
From version 23.4, the Platform API is live on https://api.cloud.seqera.io. The legacy API https://api.tower.nf remains fully operational, so existing API integrations will continue to perform as expected. Deprecation of the legacy API will be communicated well in advance to avoid any breaking changes to your integrations.
Programmatic API
Both the Seqera Platform CLI and seqerakit are built on the Platform API and provide a programmatic automation layer for operations.
You can also use tools such as openapi-python-client to generate your own programmatic API for a particular language (such as Python) based on the OpenAPI schema. However, we do not guarantee that any OpenAPI client generators will work with the Platform API.