Getting Started

This guide walks you through creating your Cosmoner account, setting up your first project, and making API calls.

1. Create an Account

POST /v1/accounts

{
  "name": "Jane Doe",
  "email": "[email protected]",
  "password": "your-secure-password",
  "paymentMethodId": "pm_..."
}

The paymentMethodId is optional at signup. You can add a payment method later via the billing API.

After signing up, check your inbox for a verification email and confirm your address.

2. Sign In

POST /api/auth/sign-in/email

{
  "email": "[email protected]",
  "password": "your-secure-password"
}

This returns a session cookie used to authenticate subsequent requests.

3. Create a Project

All resources (apps, servers, domains, storage) belong to a project. Create one to get started:

POST /v1/projects/create

{
  "name": "My Project"
}

4. Create an API Key (Optional)

For programmatic access, create an API key with the permissions you need:

POST /v1/api-keys

{
  "name": "CI/CD Key",
  "permissions": ["apps:read", "apps:write"]
}

See the API Keys guide for the full list of available permission scopes.

5. Start Building

From here you can:

• Deploy an app — See the Apps API
• Register a domain — See the Domains API
• Set up email sending — See the SMTP Setup guide
• Provision storage — See the Storage API
• Provision a server — See the Servers API

Base URL

All API requests should be made to your platform's API base URL:

https://api.cosmoner.com

Response Format

Every response follows this envelope:

{ "success": true, "data": { ... } }

{ "success": false, "error": { "code": "VALIDATION_ERROR", "message": "..." } }

Standard HTTP status codes are used: 200, 201, 400, 401, 403, 404, 422, 500.