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 Project API

## Project OverviewOn Upsun, a Project is backed by a single Git repositoryand encompasses your entire application stack, the servicesused by your application, the application's data storage,the production and staging environments, and the backups of thoseenvironments.When you create a new project, you start with a single[Environment](#tag/Environment) called *Master*,corresponding to the master branch in the Git repository ofthe project—this will be your production environment.If you connect your project to an external Git repousing one of our [Third-Party Integrations](#tag/Third-Party-Integrations)a new development environment can be created for each branchor pull request created in the repository. When a new developmentenvironment is created, the production environment's datawill be cloned on-the-fly, giving you an isolated, production-readytest environment.This set of API endpoints can be used to retrieve a list of projectsassociated with an API key, as well as create and update the parametersof existing projects.> **Note**:>> To list projects or to create a new project, use [`/subscriptions`](#tag/Subscriptions).

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

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

This API exposes 5 operations across 3 paths, and defines 4 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 3 paths 4 schemas 1 DELETE2 GET1 PATCH1 POST

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 Project 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 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Project 5

Project Overview On Upsun, a Project is backed by a single Git repository and encompasses your entire application stack, the services used by your application, the application's d…

GET
/projects/{projectId}
Get a project
get-projects 1 param → default
PATCH
/projects/{projectId}
Update a project
update-projects 1 param body → default
DELETE
/projects/{projectId}
Delete a project
delete-projects 1 param → default
GET
/projects/{projectId}/capabilities
Get a project's capabilities
get-projects-capabilities 1 param → default
POST
/projects/{projectId}/clear_build_cache
Clear project build cache
action-projects-clear-build-cache 1 param → default

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Project (16 properties), ProjectCapabilities (13 properties), ProjectPatch (7 properties), AcceptedResponse (2 properties). Each schema is shown below with its type and property counts.

ProjectCapabilities
object
13 properties 8 required
Project
object
16 properties 16 required
AcceptedResponse
object
2 properties 2 required
ProjectPatch
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

upsun-project-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 Project 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.