Upsun Environment API
On Upsun, an environment encompasses a single instance of yourentire application stack, the services used by the application,the application's data storage, and the environment's backups.In general, an environment represents a single branch or merge requestin the Git repository backing a project. It is a virtual clusterof read-only application and service containers with read-writemounts for application and service data.On Upsun, the default branch is your production environment—thus,merging changes to this branch will put those changes to production.
Upsun Environment API is one of 50 APIs that Upsun publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Environment. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 19 operations across 14 paths, and defines 14 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Upsun Environment 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 19
Across 14 paths, the API surfaces 19 operations — 2 DELETE, 4 GET, 2 PATCH, 11 POST. Each is listed below with its method, path, parameters, and response codes.
On Upsun, an environment encompasses a single instance of your entire application stack, the services used by the application, the application's data storage, and the environment'…
Schemas 14
The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Environment (37 properties), EnvironmentPatch (9 properties), EnvironmentBranchInput (5 properties), EnvironmentInitializeInput (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Upsun 12
Other APIs Upsun publishes across the network.
This is an independent, third-party profile of Upsun Environment 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.