Authentication

The Upsun REST API uses OAuth2 bearer tokens for authentication. You exchange an API token for a short-lived access token, then include it in the Authorization header of every request.

Create an API token

You will first need to have an Upsun account and create an API Token via the Console.

Exchange for an access token

Use the token exchange endpoint to get a short-lived access token:

curl -u platform-api-user: \
  -d 'grant_type=api_token&api_token=YOUR_API_TOKEN' \
  https://auth.upsun.com/oauth2/token

The response contains a bearer token valid for 900 seconds (15 minutes):

{
  "access_token": "YOUR_ACCESS_TOKEN",
  "expires_in": 900,
  "token_type": "bearer"
}

Make authenticated requests

Include the access token in the Authorization header:

curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  https://api.upsun.com/projects

Base URL: All API requests go to https://api.upsun.com.

Token lifecycle

Property	Value
Token type	Bearer
Expires in	900 seconds (15 minutes)
Exchange endpoint	`https://auth.upsun.com/oauth2/token`
Grant type	`api_token`

Access tokens expire after 15 minutes. Your application should handle re-authentication by exchanging the API token again when a request returns 401 Unauthorized.

Last modified on March 13, 2026

Overview Errors

⌘I

SDK

REST API

OpenAPI Reference

Create an API token

Exchange for an access token

Make authenticated requests

Token lifecycle

​Create an API token

​Exchange for an access token

​Make authenticated requests

​Token lifecycle

Create an API token

Exchange for an access token

Make authenticated requests

Token lifecycle