Welcome to the Thalassa Cloud API Reference. This documentation provides details about our REST API endpoints, request parameters, response formats, and authentication methods.

Our API allows you to programmatically interact with Thalassa Cloud resources, including organizations, VPCs, subnets, and more. Use this reference to build integrations, automate workflows, and extend the functionality of Thalassa Cloud to meet your specific needs.

The API documentation is presented in an interactive format that allows you to explore endpoints, view example requests and responses.

Getting a personal access token

To interact with the Thalassa Cloud API, you’ll need a personal access token for authentication. Here’s how to get one:

1. Log in to the Thalassa Cloud console
2. Click on your profile menu in the top right corner
3. Select “API Access” from the dropdown menu
4. Click “Create Personal Access Token”
5. Choose the appropriate scope for your token:
   • Read-only: For operations that only need to retrieve data
   • Read/write: For operations that need to create, modify, or delete resources
6. Set an expiration date for your token (recommended for security)
7. Give your token a descriptive name to identify its purpose
8. Click “Create” to generate your token

Personal access tokens are designed for automation systems and integrations such as:

• Command-line interfaces (CLI)
• CI/CD pipelines
• Terraform configurations
• Custom scripts and applications

Important security notes:

• Store your token securely; it acts as your authentication credentials
• Always set an expiration date on tokens to limit potential security risks
• Rotate tokens regularly for sensitive integrations
• Never share your tokens or commit them to public repositories

API Docs

These API docs are our first implementation. They have been published here to gather feedback on our API. API documentation may not be fully up-to-date due to heavy ongoing development.