How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Upsun References API

The References API from Upsun — 5 operation(s) for references.

Upsun References API is one of 50 APIs that Upsun publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include References. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 5 paths, and defines 29 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, {schemes}://api.upsun.com.

5 operations 5 paths 29 schemas 5 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.upsun.com
Authentication
OAuth 2.0, OAuth 2.0
Contact
Terms of Service
Resource Areas
1

Authentication & Security 2

Upsun References API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow. It supports OAuth 2.0 (OAuth2Admin) using the clientCredentials flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.

References 5
GET
/ref/users
List referenced users
list-referenced-users 2 params → 200400
GET
/ref/teams
List referenced teams
list-referenced-teams 2 params → 200400
GET
/ref/organizations
List referenced organizations
list-referenced-orgs 2 params → 200400403
GET
/ref/projects
List referenced projects
list-referenced-projects 2 params → 200400403404
GET
/ref/regions
List referenced regions
list-referenced-regions 2 params → 200400403404

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are RegionReference (16 properties), ProjectReference (10 properties), UserReference (8 properties), OrganizationReference (8 properties). Each schema is shown below with its type and property counts.

CreatedAt
string
The date and time when the resource was created.
OrganizationID
string
The ID of the organization.
RegionZone
string
The geographical zone of the region.
RegionLabel
string
The human-readable name of the region.
ProjectReference
object
The referenced project, or null if it no longer exists.
10 properties 10 required
ProjectID
string
The ID of the project.
RegionProvider
object
Information about the region provider.
Error
object
5 properties
SubscriptionID
string
The ID of the subscription.
RegionPrivate
boolean
Indicator whether or not this platform is for private use only.
RegionEnvImpact
object
Information about the region provider's environmental impact.
RegionTimezone
string
Default timezone of the region.
UpdatedAt
string
The date and time when the resource was last updated.
RegionSelectionLabel
string
The label to display when choosing between regions for new projects.
RegionProjectLabel
string
The label to display on existing projects.
ProjectPlan
string
The project plan.
ProjectType
string
The type of projects.
RegionCode
string
The code of the region
OrganizationReference
object
The referenced organization, or null if it no longer exists.
8 properties
RegionReference
object
The referenced region, or null if it no longer exists.
16 properties 13 required
RegionEndpoint
string
Link to the region API endpoint.
RegionID
string
The machine name of the region where the project is located.
ProjectStatus
string
The status of the project.
RegionDataCenter
object
Information about the region provider data center.
UserReference
object
The referenced user, or null if it no longer exists.
8 properties
RegionAvailable
boolean
Indicator whether or not this region is selectable during the checkout. Not available regions will never show up during checkout.
TeamReference
object
The referenced team, or null if it no longer exists.
7 properties
ProjectTitle
string
The title of the project.
RegionCompliance
object
Information about the region's compliance.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

upsun-references-api-openapi.yml Raw ↑

Other APIs Upsun publishes across the network.

Upsun Add-ons API
Upsun Alerts API
Upsun API Tokens API
Upsun Autoscaling API
Upsun Cert Management API
Upsun Connections API
Upsun Deployment API
Upsun Deployment Target API
Upsun Discounts API
Upsun Domain Management API
Upsun Environment Activity API
Upsun Environment API
Where this information came from

This is an independent, third-party profile of Upsun References API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.