Endpoints

All API requests are made to the base URL:

https://api.upsun.com

The API follows the OpenAPI (Swagger) specification and returns HAL-style JSON over HTTPS.

Resource overview

The API is organized around these primary resources:

Resource	Base path	Description
Organizations	`/organizations`	Create, list, update, and delete organizations
Projects	`/projects`	Manage projects and their settings
Environments	`/projects/{id}/environments`	Branch, merge, activate, and deactivate environments
Subscriptions	`/subscriptions`	Manage project subscriptions and plans
Users	`/users`	User profiles and account management
Members	`/organizations/{id}/members`	Organization membership and permissions
Invitations	`/organizations/{id}/invitations`	Invite users to organizations

List endpoints support pagination with query parameters:

Use the sort parameter on list endpoints. Prefix with - for descending order:

# Sort by creation date, newest first
curl -H "Authorization: Bearer $TOKEN" \
  "https://api.upsun.com/organizations?sort=-created_at"

Most list endpoints accept filter parameters specific to the resource:

# Filter organizations by status
curl -H "Authorization: Bearer $TOKEN" \
  "https://api.upsun.com/organizations?filter[status]=active"