# AI on Upsun Source: https://developer.upsun.com/ai Deploy AI agents, MCP servers, and intelligent applications on Upsun products
# AI on Upsun

Let Upsun Dispatch™ plan, code, and review your software with governed AI-agent workflows. Use Upsun Cloud to deploy AI agents, MCP servers, RAG applications, and chatbots. Integrate with Claude, GPT, Gemini, and any LLM API.

Agents
Agentic Automation

Upsun Dispatch

Governed AI-agent workflows that plan, code, review, and optimize your software. Connect a repository, leave a comment, and Upsun Dispatch takes it from there.

Turn issues into pull requests

Comment @upsun-dispatch implement on a GitHub, Jira, or Linear issue and Upsun Dispatch opens or updates a pull or merge request

Automated code review

Upsun Dispatch reviews GitHub pull requests and GitLab merge requests, publishing checks, comments, and summaries

Full visibility into every run

Monitor run status, logs, timelines, and usage from the Upsun Dispatch console

Everyone works from the same run

Captured as it happens. Visible to the whole team, not just whoever kicked it off.

Upsun Dispatch run timeline showing an approved plan step and a live code step

Findings are prioritized and actionable

A summary and recommendation, then findings ranked by impact.

Upsun Cloud performance-agent task report showing a summary, a recommendation, and a ranked list of findings
New: AI Observability
## Upsun Cloud Performance Agent

Find performance bottlenecks without writing a profiling script or reading through hours of trace data. Get a report with actionable fixes.

Correlates every signal you have

Profiling data, live traffic, and your source code, all analyzed in one pass

Nothing to install

Bring your own LLM API key and get a report in minutes

Findings with suggested diffs

Each report ranks bottlenecks and proposes a code fix, not just a graph

Tools
Model Context Protocol
## Upsun MCP Server

Give Claude direct access to your Upsun infrastructure. Manage projects, environments, and deployments through natural language conversations.

Deploy with natural language

Ask Claude to deploy your app, create environments, or scale resources

Manage infrastructure

Query logs, check metrics, and troubleshoot issues conversationally

Works with Claude Desktop

Seamless integration with your existing AI assistant workflow

terminal
# Add the Upsun MCP Server
\$ claude mcp add --transport http upsun [https://mcp.upsun.com/mcp](https://mcp.upsun.com/mcp)
# Now ask Claude to deploy
You: "Deploy my Next.js app to production"
✓ MCP Server connected
✓ Found project: my-nextjs-app
✓ Creating environment: main
✓ Deploying application...
✓ Deployment complete!
Claude Code CLI
# Deploy with slash commands
claude> /upsun deploy --environment=main
Building application 'myapp'...
Provisioning services...
✓ Deployed to main
# Check environment status
claude> /upsun status
Claude Code Integration
## Upsun Skill for Claude Code

Deploy directly from your terminal with Claude Code CLI. Manage your entire Upsun infrastructure without leaving your development environment.

Slash command interface

Simple commands like /upsun deploy for instant deployment

Integrated workflow

Code, test, and deploy without context switching

Full environment control

Create, merge, and manage environments from the command line

View on GitHub
Apps
terminal — bash

Quick Start: Deploy an AI Agent

Get started with a simple Python AI agent that integrates with the Anthropic API.

.upsun/config.yaml
applications:
ai-agent:
type: "python:3.12"
relationships:
database: "db:postgresql"
hooks:
build: |
pip install anthropic flask
web:
commands:
start: "python app.py"
services:
db:
type: postgresql:16
app.py
import anthropic
import os
client = anthropic.Anthropic(
api\_key=os.environ\["ANTHROPIC\_API\_KEY"]
)
message = client.messages.create(
model="claude-3-5-sonnet-20241022",
max\_tokens=1024,
messages=\[
]
)
# Set your API key as an environment variable
\$ upsun variable:create --level environment --name ANTHROPIC\_API\_KEY --value "your-key"
# Deploy to Upsun
\$ git push upsun main
Building application 'ai-agent'...
Provisioning PostgreSQL database...
✓ Deployment complete
[https://main-abc123.us-5.platformsh.site/](https://main-abc123.us-5.platformsh.site/)
Full AI Agent Tutorial
Use Cases
## What You Can Build

Deploy any AI application that integrates with LLM APIs. Upsun provides the infrastructure, databases, and networking you need.

Deploy conversational AI powered by Claude, GPT, or Gemini with persistent chat history and context management. Host Model Context Protocol servers that extend Claude Desktop and other AI tools with custom capabilities. Build retrieval-augmented generation apps with vector databases like Chroma and Qdrant for context-aware AI responses.
## Supported Technologies

Build with your preferred stack. Any language, any LLM, any database.

Runtimes

Python Node.js PHP Go Ruby Java

LLM Providers

Claude GPT-4 Gemini Azure OpenAI Bedrock

AI Frameworks

LangChain LlamaIndex Haystack Semantic Kernel

Vector Databases

pgvector Chroma Qdrant Redis MongoDB

CPU-optimized for AI orchestration. Call external LLM APIs for GPU-intensive inference. Your app handles business logic, data processing, and UX — cost-effective and easy to scale.

Learn More
## Resources & Tutorials Complete guide to deploying conversational AI agents with persistent memory Host Model Context Protocol servers for Claude Desktop and other tools Production RAG application with vector search and intelligent context Set up Chroma, Qdrant, or pgvector for embeddings storage Latest AI tutorials, best practices, and case studies Get help and share your AI projects with the community

Ready to Deploy Your AI Application?

Start building AI agents, MCP servers, and intelligent applications on Upsun today.

# Upsun MCP on your Agent Source: https://developer.upsun.com/ai/mcp/integrations/all How to integrate Upsun MCP into an agent TO-DO: Create this content! # Upsun MCP on Cursor Source: https://developer.upsun.com/ai/mcp/integrations/cursor How to integrate Upsun MCP into Cursor TO-DO: Create this content! # Upsun MCP on VSCode Source: https://developer.upsun.com/ai/mcp/integrations/vscode How to integrate Upsun MCP into VSCode TO-DO: Create this content! # Overview Source: https://developer.upsun.com/ai/mcp/overview Why use MCP TO-DO: Create this content! # Best Practices Source: https://developer.upsun.com/ai/onboarding/best-practices Best practices for onboarding with Upsun AI Tools TO-DO: Create this content! # Overview Source: https://developer.upsun.com/ai/onboarding/overview Help onboard new users with Upsun AI Tools TO-DO: Create this content! # Setup Source: https://developer.upsun.com/ai/onboarding/setup Set up onboarding with Upsun AI Tools TO-DO: Create this content! # Get add-ons Source: https://developer.upsun.com/api-reference/add-ons/get-add-ons https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/addons Retrieves information about the add-ons for an organization. # Get usage alerts for a subscription Source: https://developer.upsun.com/api-reference/alerts/get-usage-alerts-for-a-subscription https://meta.upsun.com/openapi-spec get /alerts/subscriptions/{subscriptionId}/usage # Update usage alerts. Source: https://developer.upsun.com/api-reference/alerts/update-usage-alerts https://meta.upsun.com/openapi-spec patch /alerts/subscriptions/{subscriptionId}/usage # Create an API token Source: https://developer.upsun.com/api-reference/api-tokens/create-an-api-token https://meta.upsun.com/openapi-spec post /users/{user_id}/api-tokens Creates an API token # Delete an API token Source: https://developer.upsun.com/api-reference/api-tokens/delete-an-api-token https://meta.upsun.com/openapi-spec delete /users/{user_id}/api-tokens/{token_id} Deletes an API token # Get an API token Source: https://developer.upsun.com/api-reference/api-tokens/get-an-api-token https://meta.upsun.com/openapi-spec get /users/{user_id}/api-tokens/{token_id} Retrieves the specified API token. # List a user's API tokens Source: https://developer.upsun.com/api-reference/api-tokens/list-a-users-api-tokens https://meta.upsun.com/openapi-spec get /users/{user_id}/api-tokens Retrieves a list of API tokens associated with a single user. # Modifies Autoscaler settings Source: https://developer.upsun.com/api-reference/autoscaling/modifies-autoscaler-settings https://meta.upsun.com/openapi-spec patch /projects/{projectId}/environments/{environmentId}/autoscaling/settings Modifies Autoscaler settings # Retrieves Autoscaler settings Source: https://developer.upsun.com/api-reference/autoscaling/retrieves-autoscaler-settings https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/autoscaling/settings Retrieves Autoscaler settings # Updates Autoscaler settings Source: https://developer.upsun.com/api-reference/autoscaling/updates-autoscaler-settings https://meta.upsun.com/openapi-spec post /projects/{projectId}/environments/{environmentId}/autoscaling/settings Updates Autoscaler settings # Get server cache metrics Source: https://developer.upsun.com/api-reference/blackfire-monitoring/get-server-cache-metrics https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/observability/server/caches Returns time-series PHP cache usage ratios (0.0-1.0) for OPcache memory, OPcache interned strings buffer (ISB), APCu memory, realpath cache, and PCRE cache. Includes hit rate ratios (0.0-1.0) for APCu and OPcache. Each data point contains `timestamp` and optional data fields. Fields are omitted for timestamps with no data - this indicates no data was received. Filtered by agent ID and execution contexts (web, cli, etc.). # Get server monitoring overview Source: https://developer.upsun.com/api-reference/blackfire-monitoring/get-server-monitoring-overview https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/observability/server Returns time-series server monitoring data for the specified metrics (wall time, memory usage, peak memory usage, CPU load, stdout, requests per minute). Includes alert evaluations and APM quota usage. Data points contain metric values aggregated at the requested granularity. # Get server transaction breakdown Source: https://developer.upsun.com/api-reference/blackfire-monitoring/get-server-transaction-breakdown https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/observability/server/transactions-break-down Returns transaction breakdown with impact scores, showing how each transaction contributes to overall resource consumption. Includes time-series data for top-hit transactions and aggregated metrics per transaction. Use breakdown_dimension to analyze by wall time (wt), memory (pmu), or stdout. Supports extensive filtering by context, transaction, host, framework, runtime, HTTP method, status code, and more. # Get top spans Source: https://developer.upsun.com/api-reference/blackfire-monitoring/get-top-spans https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/observability/server/top-spans Returns the top spans aggregated across traces, sorted by impact or other metrics. Each span includes wall time, P96, call count, percentage of traces containing the span, and impact score. Supports filtering by context, transaction, host, framework, runtime, HTTP method/status, and service layer. # Get profile call graph Source: https://developer.upsun.com/api-reference/blackfire-profiling/get-profile-call-graph https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/observability/profiles/{uuid}/graph Returns the call graph data for a Blackfire profile, showing function calls and their performance metrics. # Get profile details Source: https://developer.upsun.com/api-reference/blackfire-profiling/get-profile-details https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/observability/profiles/{uuid}/profile Returns full profile data including metrics, metadata, and recommendations. # Get profile subprofiles Source: https://developer.upsun.com/api-reference/blackfire-profiling/get-profile-subprofiles https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/observability/profiles/{uuid}/subprofiles Returns subprofiles (child profiles) associated with a Blackfire profile. # Get profile timeline data Source: https://developer.upsun.com/api-reference/blackfire-profiling/get-profile-timeline-data https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/observability/profiles/{uuid}/timeline Returns timeline visualization data for a Blackfire profile, showing the execution flow over time. # Get recommendation statistics Source: https://developer.upsun.com/api-reference/blackfire-profiling/get-recommendation-statistics https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/observability/profiles/recommendations Returns recommendation statistics for the environment, optionally filtered by transaction. Proxied from the Blackfire API. Each recommendation includes the constraint details, occurrence count, and links to the latest profile and documentation. # List profiling results Source: https://developer.upsun.com/api-reference/blackfire-profiling/list-profiling-results https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/observability/profiles Returns a paginated list of profiles for the environment, optionally filtered by transaction name. Proxied from the Blackfire API. # Add an SSL certificate Source: https://developer.upsun.com/api-reference/cert-management/add-an-ssl-certificate https://meta.upsun.com/openapi-spec post /projects/{projectId}/certificates Add a single SSL certificate to a project. # Delete an SSL certificate Source: https://developer.upsun.com/api-reference/cert-management/delete-an-ssl-certificate https://meta.upsun.com/openapi-spec delete /projects/{projectId}/certificates/{certificateId} Delete a single SSL certificate associated with a project. # Get an SSL certificate Source: https://developer.upsun.com/api-reference/cert-management/get-an-ssl-certificate https://meta.upsun.com/openapi-spec get /projects/{projectId}/certificates/{certificateId} Retrieve information about a single SSL certificate associated with a project. # Get list of SSL certificates Source: https://developer.upsun.com/api-reference/cert-management/get-list-of-ssl-certificates https://meta.upsun.com/openapi-spec get /projects/{projectId}/certificates Retrieve a list of objects representing the SSL certificates associated with a project. # Get projects provisioners Source: https://developer.upsun.com/api-reference/cert-management/get-projects-provisioners https://meta.upsun.com/openapi-spec get /projects/{projectId}/provisioners # Get projects provisioners 1 Source: https://developer.upsun.com/api-reference/cert-management/get-projects-provisioners-1 https://meta.upsun.com/openapi-spec get /projects/{projectId}/provisioners/{certificateProvisionerDocumentId} # Patch projects provisioners Source: https://developer.upsun.com/api-reference/cert-management/patch-projects-provisioners https://meta.upsun.com/openapi-spec patch /projects/{projectId}/provisioners/{certificateProvisionerDocumentId} # Update an SSL certificate Source: https://developer.upsun.com/api-reference/cert-management/update-an-ssl-certificate https://meta.upsun.com/openapi-spec patch /projects/{projectId}/certificates/{certificateId} Update a single SSL certificate associated with a project. # Delete a federated login connection Source: https://developer.upsun.com/api-reference/connections/delete-a-federated-login-connection https://meta.upsun.com/openapi-spec delete /users/{user_id}/connections/{provider} Deletes the specified connection. # Get a federated login connection Source: https://developer.upsun.com/api-reference/connections/get-a-federated-login-connection https://meta.upsun.com/openapi-spec get /users/{user_id}/connections/{provider} Retrieves the specified connection. # List federated login connections Source: https://developer.upsun.com/api-reference/connections/list-federated-login-connections https://meta.upsun.com/openapi-spec get /users/{user_id}/connections Retrieves a list of connections associated with a single user. # Get application filter values Source: https://developer.upsun.com/api-reference/continuous-profiling/get-application-filter-values https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{envId}/continuous-profiling/app/{app}/filter Returns available label filter fields and their distinct values for the given application. Use these values to build filter parameters (`runtime[]`, `runtime_version[]`, etc.) on the timeline and merge endpoints # Get application timeline Source: https://developer.upsun.com/api-reference/continuous-profiling/get-application-timeline https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{envId}/continuous-profiling/app/{app} Returns timeline data points for the given application and profile type, scoped to the authenticated agent. Points are aggregated at a computed grain (60s to 1h) based on the time range. The response includes the bounded time range, aggregation metadata, and the agent retention period # Get merged profile Source: https://developer.upsun.com/api-reference/continuous-profiling/get-merged-profile https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{envId}/continuous-profiling/app/{app}/merge Returns a merged profile for the given application over the specified time range. The output format is controlled by the `out` query parameter: `pprof` returns a gzipped protobuf with Content-Disposition header, `dot` returns a GraphViz DOT graph, `flamebearerv2` returns JSON flame graph data # List profiled applications Source: https://developer.upsun.com/api-reference/continuous-profiling/list-profiled-applications https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{envId}/continuous-profiling Returns all applications reporting continuous profiling data for the authenticated agent, scoped to the given time range. Each application includes its available profile types (with unit and aggregation metadata) and detected languages # Create a project deployment target Source: https://developer.upsun.com/api-reference/deployment-target/create-a-project-deployment-target https://meta.upsun.com/openapi-spec post /projects/{projectId}/deployments Set the deployment target information for a project. # Delete a single project deployment target Source: https://developer.upsun.com/api-reference/deployment-target/delete-a-single-project-deployment-target https://meta.upsun.com/openapi-spec delete /projects/{projectId}/deployments/{deploymentTargetConfigurationId} Delete a single deployment target configuration associated with a specific project. # Get a single project deployment target Source: https://developer.upsun.com/api-reference/deployment-target/get-a-single-project-deployment-target https://meta.upsun.com/openapi-spec get /projects/{projectId}/deployments/{deploymentTargetConfigurationId} Get a single deployment target configuration of a project. # Get project deployment target info Source: https://developer.upsun.com/api-reference/deployment-target/get-project-deployment-target-info https://meta.upsun.com/openapi-spec get /projects/{projectId}/deployments The deployment target information for the project. # Update a project deployment Source: https://developer.upsun.com/api-reference/deployment-target/update-a-project-deployment https://meta.upsun.com/openapi-spec patch /projects/{projectId}/deployments/{deploymentTargetConfigurationId} # Get a single environment deployment Source: https://developer.upsun.com/api-reference/deployment/get-a-single-environment-deployment https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/deployments/{deploymentId} Retrieve a single deployment configuration with an id of `current`. This may be subject to change in the future. Only `current` can be queried. # Get an environment's deployment information Source: https://developer.upsun.com/api-reference/deployment/get-an-environments-deployment-information https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/deployments Retrieve the read-only configuration of an environment's deployment. The returned information is everything required to recreate a project's current deployment. More specifically, the objects returned by this endpoint contain the configuration derived from the repository's YAML configuration file: `.upsun/config.yaml`. Additionally, any values deriving from environment variables, the domains attached to a project, project access settings, etc. are included here. This endpoint currently returns a list containing a single deployment configuration with an `id` of `current`. This may be subject to change in the future. # Get projects gitdiffs Source: https://developer.upsun.com/api-reference/diff/get-projects-gitdiffs- https://meta.upsun.com/openapi-spec get /projects/{projectId}/git/diffs/{diffBaseId}/{diffTargetId} # Get an organization discount Source: https://developer.upsun.com/api-reference/discounts/get-an-organization-discount https://meta.upsun.com/openapi-spec get /discounts/{id} # Get the value of the First Project Incentive discount Source: https://developer.upsun.com/api-reference/discounts/get-the-value-of-the-first-project-incentive-discount https://meta.upsun.com/openapi-spec get /discounts/types/allowance # List organization discounts Source: https://developer.upsun.com/api-reference/discounts/list-organization-discounts https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/discounts Retrieves all applicable discounts granted to the specified organization. # Delete projects domain claims Source: https://developer.upsun.com/api-reference/domain-claim/delete-projects-domain-claims https://meta.upsun.com/openapi-spec delete /projects/{projectId}/domain-claims/{domainClaimId} # Get projects domain claims Source: https://developer.upsun.com/api-reference/domain-claim/get-projects-domain-claims https://meta.upsun.com/openapi-spec get /projects/{projectId}/domain-claims # Get projects domain claims 1 Source: https://developer.upsun.com/api-reference/domain-claim/get-projects-domain-claims-1 https://meta.upsun.com/openapi-spec get /projects/{projectId}/domain-claims/{domainClaimId} # Patch projects domain claims Source: https://developer.upsun.com/api-reference/domain-claim/patch-projects-domain-claims https://meta.upsun.com/openapi-spec patch /projects/{projectId}/domain-claims/{domainClaimId} # Post projects domain claims Source: https://developer.upsun.com/api-reference/domain-claim/post-projects-domain-claims https://meta.upsun.com/openapi-spec post /projects/{projectId}/domain-claims # Add a project domain Source: https://developer.upsun.com/api-reference/domain-management/add-a-project-domain https://meta.upsun.com/openapi-spec post /projects/{projectId}/domains Add a single domain to a project. If the `ssl` field is left blank without an object containing a PEM-encoded SSL certificate, a certificate will [be provisioned for you via Let's Encrypt.](https://docs.upsun.com/anchors/routes/https/certificates/) # Add an environment domain Source: https://developer.upsun.com/api-reference/domain-management/add-an-environment-domain https://meta.upsun.com/openapi-spec post /projects/{projectId}/environments/{environmentId}/domains Add a single domain to an environment. If the environment is not production, the `replacement_for` field is required, which binds a new domain to an existing one from a production environment. If the `ssl` field is left blank without an object containing a PEM-encoded SSL certificate, a certificate will [be provisioned for you via Let's Encrypt](https://docs.upsun.com/anchors/routes/https/certificates/). # Delete a project domain Source: https://developer.upsun.com/api-reference/domain-management/delete-a-project-domain https://meta.upsun.com/openapi-spec delete /projects/{projectId}/domains/{domainId} Delete a single user-specified domain associated with a project. # Delete an environment domain Source: https://developer.upsun.com/api-reference/domain-management/delete-an-environment-domain https://meta.upsun.com/openapi-spec delete /projects/{projectId}/environments/{environmentId}/domains/{domainId} Delete a single user-specified domain associated with an environment. # Get a list of environment domains Source: https://developer.upsun.com/api-reference/domain-management/get-a-list-of-environment-domains https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/domains Retrieve a list of objects representing the user-specified domains associated with an environment. Note that this does *not* return the `.platformsh.site` subdomains, which are automatically assigned to the environment. # Get a project domain Source: https://developer.upsun.com/api-reference/domain-management/get-a-project-domain https://meta.upsun.com/openapi-spec get /projects/{projectId}/domains/{domainId} Retrieve information about a single user-specified domain associated with a project. # Get an environment domain Source: https://developer.upsun.com/api-reference/domain-management/get-an-environment-domain https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/domains/{domainId} Retrieve information about a single user-specified domain associated with an environment. # Get list of project domains Source: https://developer.upsun.com/api-reference/domain-management/get-list-of-project-domains https://meta.upsun.com/openapi-spec get /projects/{projectId}/domains Retrieve a list of objects representing the user-specified domains associated with a project. Note that this does *not* return the domains automatically assigned to a project that appear under "Access site" on the user interface. # Update a project domain Source: https://developer.upsun.com/api-reference/domain-management/update-a-project-domain https://meta.upsun.com/openapi-spec patch /projects/{projectId}/domains/{domainId} Update the information associated with a single user-specified domain associated with a project. # Update an environment domain Source: https://developer.upsun.com/api-reference/domain-management/update-an-environment-domain https://meta.upsun.com/openapi-spec patch /projects/{projectId}/environments/{environmentId}/domains/{domainId} Update the information associated with a single user-specified domain associated with an environment. # Get observability entrypoint Source: https://developer.upsun.com/api-reference/entrypoint/get-observability-entrypoint https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/observability Returns API entrypoint with hypermedia links to all observability endpoints (resources, logs, HTTP traffic, continuous profiling, server metrics) following HATEOAS principles. Includes data retention policies per metric type (retention_period, max_range, recommended_default_range in minutes), environment metadata (project_id, environment_id, environment_type, vendor), and per-service resource links. Use _links for API navigation. # Cancel an environment activity Source: https://developer.upsun.com/api-reference/environment-activity/cancel-an-environment-activity https://meta.upsun.com/openapi-spec post /projects/{projectId}/environments/{environmentId}/activities/{activityId}/cancel Cancel a single activity as specified by an `id` returned by the [Get environment activities list](#tag/Environment-Activity%2Fpaths%2F~1projects~1%7BprojectId%7D~1environments~1%7BenvironmentId%7D~1activities%2Fget) endpoint. Please note that not all activities are cancelable. # Get an environment activity log entry Source: https://developer.upsun.com/api-reference/environment-activity/get-an-environment-activity-log-entry https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/activities/{activityId} Retrieve a single environment activity entry as specified by an `id` returned by the [Get environment activities list](#tag/Environment-Activity%2Fpaths%2F~1projects~1%7BprojectId%7D~1environments~1%7BenvironmentId%7D~1activities%2Fget) endpoint. See the documentation on that endpoint for details about the information this endpoint can return. # Get environment activity log Source: https://developer.upsun.com/api-reference/environment-activity/get-environment-activity-log https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/activities Retrieve an environment's activity log. This returns a list of object with records of actions such as: - Commits being pushed to the repository - A new environment being branched out from the specified environment - A snapshot being created of the specified environment The object includes a timestamp of when the action occurred (`created_at`), when the action concluded (`updated_at`), the current `state` of the action, the action's completion percentage (`completion_percent`), and other related information in the `payload`. The contents of the `payload` varies based on the `type` of the activity. For example: - An `environment.branch` action's `payload` can contain objects representing the `parent` environment and the branching action's `outcome`. - An `environment.push` action's `payload` can contain objects representing the `environment`, the specific `commits` included in the push, and the `user` who pushed. # Create backup of environment Source: https://developer.upsun.com/api-reference/environment-backups/create-backup-of-environment https://meta.upsun.com/openapi-spec post /projects/{projectId}/environments/{environmentId}/backup Trigger a new backup of an environment to be created. See the [Backups](https://docs.upsun.com/anchors/environments/backup/) section of the documentation for more information. # Delete an environment backup Source: https://developer.upsun.com/api-reference/environment-backups/delete-an-environment-backup https://meta.upsun.com/openapi-spec delete /projects/{projectId}/environments/{environmentId}/backups/{backupId} Delete a specific backup from an environment using the `id` of the entry retrieved by the [Get backups list](#tag/Environment-Backups%2Fpaths%2F~1projects~1%7BprojectId%7D~1environments~1%7BenvironmentId%7D~1backups%2Fget) endpoint. # Get an environment backup's info Source: https://developer.upsun.com/api-reference/environment-backups/get-an-environment-backups-info https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/backups/{backupId} Get the details of a specific backup from an environment using the `id` of the entry retrieved by the [Get backups list](#tag/Environment-Backups%2Fpaths%2F~1projects~1%7BprojectId%7D~1environments~1%7BenvironmentId%7D~1backups%2Fget) endpoint. # Get an environment's backup list Source: https://developer.upsun.com/api-reference/environment-backups/get-an-environments-backup-list https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/backups Retrieve a list of objects representing backups of this environment. # Restore an environment snapshot Source: https://developer.upsun.com/api-reference/environment-backups/restore-an-environment-snapshot https://meta.upsun.com/openapi-spec post /projects/{projectId}/environments/{environmentId}/backups/{backupId}/restore Restore a specific backup from an environment using the `id` of the entry retrieved by the [Get backups list](#tag/Environment-Backups%2Fpaths%2F~1projects~1%7BprojectId%7D~1environments~1%7BenvironmentId%7D~1backups%2Fget) endpoint. # Get environment type links Source: https://developer.upsun.com/api-reference/environment-type/get-environment-type-links https://meta.upsun.com/openapi-spec get /projects/{projectId}/environment-types/{environmentTypeId} Lists the endpoints used to retrieve info about the environment type. # Get environment types Source: https://developer.upsun.com/api-reference/environment-type/get-environment-types https://meta.upsun.com/openapi-spec get /projects/{projectId}/environment-types List all available environment types # Add an environment variable Source: https://developer.upsun.com/api-reference/environment-variables/add-an-environment-variable https://meta.upsun.com/openapi-spec post /projects/{projectId}/environments/{environmentId}/variables Add a variable to an environment. The `value` can be either a string or a JSON object (default: string), as specified by the `is_json` boolean flag. Additionally, the inheritability of an environment variable can be determined through the `is_inheritable` flag (default: true). See the [Environment Variables](https://docs.upsun.com/anchors/variables/set/environment/create/) section in our documentation for more information. # Delete an environment variable Source: https://developer.upsun.com/api-reference/environment-variables/delete-an-environment-variable https://meta.upsun.com/openapi-spec delete /projects/{projectId}/environments/{environmentId}/variables/{variableId} Delete a single user-defined environment variable. # Get an environment variable Source: https://developer.upsun.com/api-reference/environment-variables/get-an-environment-variable https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/variables/{variableId} Retrieve a single user-defined environment variable. # Get list of environment variables Source: https://developer.upsun.com/api-reference/environment-variables/get-list-of-environment-variables https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/variables Retrieve a list of objects representing the user-defined variables within an environment. # Update an environment variable Source: https://developer.upsun.com/api-reference/environment-variables/update-an-environment-variable https://meta.upsun.com/openapi-spec patch /projects/{projectId}/environments/{environmentId}/variables/{variableId} Update a single user-defined environment variable. The `value` can be either a string or a JSON object (default: string), as specified by the `is_json` boolean flag. Additionally, the inheritability of an environment variable can be determined through the `is_inheritable` flag (default: true). See the [Variables](https://docs.upsun.com/anchors/variables/) section in our documentation for more information. # Activate an environment Source: https://developer.upsun.com/api-reference/environment/activate-an-environment https://meta.upsun.com/openapi-spec post /projects/{projectId}/environments/{environmentId}/activate Set the specified environment's status to active # Branch an environment Source: https://developer.upsun.com/api-reference/environment/branch-an-environment https://meta.upsun.com/openapi-spec post /projects/{projectId}/environments/{environmentId}/branch Create a new environment as a branch of the current environment. # Deactivate an environment Source: https://developer.upsun.com/api-reference/environment/deactivate-an-environment https://meta.upsun.com/openapi-spec post /projects/{projectId}/environments/{environmentId}/deactivate Destroy all services and data running on this environment so that only the Git branch remains. The environment can be reactivated later at any time; reactivating an environment will sync data from the parent environment and redeploy. **NOTE: ALL DATA IN THIS ENVIRONMENT WILL BE IRREVOCABLY LOST** # Delete an environment Source: https://developer.upsun.com/api-reference/environment/delete-an-environment https://meta.upsun.com/openapi-spec delete /projects/{projectId}/environments/{environmentId} Delete a specified environment. # Deploy an environment Source: https://developer.upsun.com/api-reference/environment/deploy-an-environment https://meta.upsun.com/openapi-spec post /projects/{projectId}/environments/{environmentId}/deploy Trigger a controlled [manual deployment](https://docs.upsun.com/learn/overview/build-deploy.html#manual-deployment) to release all the staged changes # Get an environment Source: https://developer.upsun.com/api-reference/environment/get-an-environment https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId} Retrieve the details of a single existing environment. # Get list of project environments Source: https://developer.upsun.com/api-reference/environment/get-list-of-project-environments https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments Retrieve a list of a project's existing environments and the information associated with each environment. # Initialize a new environment Source: https://developer.upsun.com/api-reference/environment/initialize-a-new-environment https://meta.upsun.com/openapi-spec post /projects/{projectId}/environments/{environmentId}/initialize Initialize and configure a new environment with an existing repository. The payload is the url of a git repository with a profile name: ``` { "repository": "git@github.com:platformsh/a-project-template.git@master", "profile": "Example Project", "files": [ { "mode": 0600, "path": "config.json", "contents": "XXXXXXXX" } ] } ``` It can optionally carry additional files that will be committed to the repository, the POSIX file mode to set on each file, and the base64-encoded contents of each file. This endpoint can also add a second repository URL in the `config` parameter that will be added to the contents of the first. This allows you to put your application in one repository and the Upsun YAML configuration files in another. # Merge an environment Source: https://developer.upsun.com/api-reference/environment/merge-an-environment https://meta.upsun.com/openapi-spec post /projects/{projectId}/environments/{environmentId}/merge Merge an environment into its parent. This means that code changes from the branch environment will be merged into the parent branch, and the parent branch will be rebuilt and deployed with the new code changes, retaining the existing data in the parent environment. # Pause an environment Source: https://developer.upsun.com/api-reference/environment/pause-an-environment https://meta.upsun.com/openapi-spec post /projects/{projectId}/environments/{environmentId}/pause Pause an environment, stopping all services and applications (except the router). Development environments are often used for a limited time and then abandoned. To prevent unnecessary consumption of resources, development environments that haven't been redeployed in 14 days are automatically paused. You can pause an environment manually at any time using this endpoint. Further information is available in our [public documentation](https://docs.upsun.com/anchors/environments/paused/). # Post projects environments maintenance redeploy Source: https://developer.upsun.com/api-reference/environment/post-projects-environments-maintenance-redeploy https://meta.upsun.com/openapi-spec post /projects/{projectId}/environments/{environmentId}/maintenance-redeploy # Redeploy an environment Source: https://developer.upsun.com/api-reference/environment/redeploy-an-environment https://meta.upsun.com/openapi-spec post /projects/{projectId}/environments/{environmentId}/redeploy Trigger the redeployment sequence of an environment. # Resume a paused environment Source: https://developer.upsun.com/api-reference/environment/resume-a-paused-environment https://meta.upsun.com/openapi-spec post /projects/{projectId}/environments/{environmentId}/resume Resume a paused environment, restarting all services and applications. Development environments that haven't been used for 14 days will be paused automatically. They can be resumed via a redeployment or manually using this endpoint or the CLI as described in the [public documentation](https://docs.upsun.com/anchors/environments/paused/). # Synchronize a child environment with its parent Source: https://developer.upsun.com/api-reference/environment/synchronize-a-child-environment-with-its-parent https://meta.upsun.com/openapi-spec post /projects/{projectId}/environments/{environmentId}/synchronize This synchronizes the code and/or data of an environment with that of its parent, then redeploys the environment. Synchronization is only possible if a branch has no unmerged commits and it can be fast-forwarded. If data synchronization is specified, the data in the environment will be overwritten with that of its parent. # Update an environment Source: https://developer.upsun.com/api-reference/environment/update-an-environment https://meta.upsun.com/openapi-spec patch /projects/{projectId}/environments/{environmentId} Update the details of a single existing environment. # Get access document by access ID Source: https://developer.upsun.com/api-reference/grants/get-access-document-by-access-id https://meta.upsun.com/openapi-spec get /access/{access_id} Returns the full access document referenced by token claim `access_id`. # List extended access of a user Source: https://developer.upsun.com/api-reference/grants/list-extended-access-of-a-user https://meta.upsun.com/openapi-spec get /users/{user_id}/extended-access List extended access of the given user, which includes both individual and team access to project and organization. # Get HTTP traffic timeline by IP Source: https://developer.upsun.com/api-reference/http-traffic/get-http-traffic-timeline-by-ip https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/observability/http/breakdown/ips Returns HTTP traffic analytics grouped by IP address with IPs ranked by impact (response time × request count). Use limit parameter to control total items returned (default: 200, max: 300) and top_hits_count to control how many items are flagged as top hits and tracked in the timeline (default: 10, max: 15). Items with index < top_hits_count are flagged with top_hit: true and tracked in top_hits_timeline; the remainder (up to limit) are returned with top_hit: false. # Get HTTP traffic timeline by URL Source: https://developer.upsun.com/api-reference/http-traffic/get-http-traffic-timeline-by-url https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/observability/http/breakdown/urls Returns HTTP traffic analytics with URLs ranked by impact (response time × request count), aggregated metrics (average, median, p96 response times in milliseconds), status code distributions, and time-series data. Use limit parameter to control total items returned (default: 200, max: 300) and top_hits_count to control how many items are flagged as top hits and tracked in the timeline (default: 10, max: 15). Items with index < top_hits_count are flagged with top_hit: true and tracked in top_hits_timeline; the remainder (up to limit) are returned with top_hit: false. # Get HTTP traffic timeline by user agent Source: https://developer.upsun.com/api-reference/http-traffic/get-http-traffic-timeline-by-user-agent https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/observability/http/breakdown/user-agents Returns HTTP traffic analytics grouped by User Agent with User Agents ranked by impact (response time × request count). Use limit parameter to control total items returned (default: 200, max: 300) and top_hits_count to control how many items are flagged as top hits and tracked in the timeline (default: 10, max: 15). Items with index < top_hits_count are flagged with top_hit: true and tracked in top_hits_timeline; the remainder (up to limit) are returned with top_hit: false. # Get invoice Source: https://developer.upsun.com/api-reference/invoices/get-invoice https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/invoices/{invoice_id} Retrieves an invoice for the specified organization. # List invoices Source: https://developer.upsun.com/api-reference/invoices/list-invoices https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/invoices Retrieves a list of invoices for the specified organization. # List support tickets Source: https://developer.upsun.com/api-reference/list-support-tickets https://meta.upsun.com/openapi-spec get /tickets # Confirm TOTP enrollment Source: https://developer.upsun.com/api-reference/mfa/confirm-totp-enrollment https://meta.upsun.com/openapi-spec post /users/{user_id}/totp Confirms the given TOTP enrollment. # Disable organization MFA enforcement Source: https://developer.upsun.com/api-reference/mfa/disable-organization-mfa-enforcement https://meta.upsun.com/openapi-spec post /organizations/{organization_id}/mfa-enforcement/disable Disables MFA enforcement for the specified organization. # Enable organization MFA enforcement Source: https://developer.upsun.com/api-reference/mfa/enable-organization-mfa-enforcement https://meta.upsun.com/openapi-spec post /organizations/{organization_id}/mfa-enforcement/enable Enables MFA enforcement for the specified organization. # Get information about TOTP enrollment Source: https://developer.upsun.com/api-reference/mfa/get-information-about-totp-enrollment https://meta.upsun.com/openapi-spec get /users/{user_id}/totp Retrieves TOTP enrollment information. # Get organization MFA settings Source: https://developer.upsun.com/api-reference/mfa/get-organization-mfa-settings https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/mfa-enforcement Retrieves MFA settings for the specified organization. # Re-create recovery codes Source: https://developer.upsun.com/api-reference/mfa/re-create-recovery-codes https://meta.upsun.com/openapi-spec post /users/{user_id}/codes Re-creates recovery codes for the MFA enrollment. # Send MFA reminders to organization members Source: https://developer.upsun.com/api-reference/mfa/send-mfa-reminders-to-organization-members https://meta.upsun.com/openapi-spec post /organizations/{organization_id}/mfa/remind Sends a reminder about setting up MFA to the specified organization members. # Withdraw TOTP enrollment Source: https://developer.upsun.com/api-reference/mfa/withdraw-totp-enrollment https://meta.upsun.com/openapi-spec delete /users/{user_id}/totp Withdraws from the TOTP enrollment. # Create confirmation credentials for for 3D-Secure Source: https://developer.upsun.com/api-reference/orders/create-confirmation-credentials-for-for-3d-secure https://meta.upsun.com/openapi-spec post /organizations/{organization_id}/orders/{order_id}/authorize Creates confirmation credentials for payments that require online authorization # Download an invoice. Source: https://developer.upsun.com/api-reference/orders/download-an-invoice https://meta.upsun.com/openapi-spec get /orders/download # Get order Source: https://developer.upsun.com/api-reference/orders/get-order https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/orders/{order_id} Retrieves an order for the specified organization. # List orders Source: https://developer.upsun.com/api-reference/orders/list-orders https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/orders Retrieves orders for the specified organization. # Cancel a pending invitation to an organization Source: https://developer.upsun.com/api-reference/organization-invitations/cancel-a-pending-invitation-to-an-organization https://meta.upsun.com/openapi-spec delete /organizations/{organization_id}/invitations/{invitation_id} Cancels the specified invitation. # Invite user to an organization by email Source: https://developer.upsun.com/api-reference/organization-invitations/invite-user-to-an-organization-by-email https://meta.upsun.com/openapi-spec post /organizations/{organization_id}/invitations Creates an invitation to an organization for a user with the specified email address. # List invitations to an organization Source: https://developer.upsun.com/api-reference/organization-invitations/list-invitations-to-an-organization https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/invitations Returns a list of invitations to an organization. # Estimate total spend Source: https://developer.upsun.com/api-reference/organization-management/estimate-total-spend https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/estimate Estimates the total spend for the specified organization. # Get billing alert configuration Source: https://developer.upsun.com/api-reference/organization-management/get-billing-alert-configuration https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/alerts/billing Retrieves billing alert configuration for the specified organization. # Get organization prepayment information Source: https://developer.upsun.com/api-reference/organization-management/get-organization-prepayment-information https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/prepayment Retrieves prepayment information for the specified organization, if applicable. # List organization prepayment transactions Source: https://developer.upsun.com/api-reference/organization-management/list-organization-prepayment-transactions https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/prepayment/transactions Retrieves a list of prepayment transactions for the specified organization, if applicable. # Update billing alert configuration Source: https://developer.upsun.com/api-reference/organization-management/update-billing-alert-configuration https://meta.upsun.com/openapi-spec patch /organizations/{organization_id}/alerts/billing Updates billing alert configuration for the specified organization. # Create organization member Source: https://developer.upsun.com/api-reference/organization-members/create-organization-member https://meta.upsun.com/openapi-spec post /organizations/{organization_id}/members Creates a new organization member. # Delete organization member Source: https://developer.upsun.com/api-reference/organization-members/delete-organization-member https://meta.upsun.com/openapi-spec delete /organizations/{organization_id}/members/{user_id} Deletes the specified organization member. # Get organization member Source: https://developer.upsun.com/api-reference/organization-members/get-organization-member https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/members/{user_id} Retrieves the specified organization member. # List organization members Source: https://developer.upsun.com/api-reference/organization-members/list-organization-members https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/members Accessible to organization owners and members with the "manage members" permission. # Update organization member Source: https://developer.upsun.com/api-reference/organization-members/update-organization-member https://meta.upsun.com/openapi-spec patch /organizations/{organization_id}/members/{user_id} Updates the specified organization member. # Create project Source: https://developer.upsun.com/api-reference/organization-projects/create-project https://meta.upsun.com/openapi-spec post /organizations/{organization_id}/projects Creates a new project in the specified organization. # Delete project Source: https://developer.upsun.com/api-reference/organization-projects/delete-project https://meta.upsun.com/openapi-spec delete /organizations/{organization_id}/projects/{project_id} Deletes the specified project. # Get project Source: https://developer.upsun.com/api-reference/organization-projects/get-project https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/projects/{project_id} Retrieves the specified project. # List projects Source: https://developer.upsun.com/api-reference/organization-projects/list-projects https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/projects Retrieves a list of projects for the specified organization. # Query project carbon emissions metrics Source: https://developer.upsun.com/api-reference/organization-projects/query-project-carbon-emissions-metrics https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/projects/{project_id}/metrics/carbon Queries the carbon emission data for the specified project using the supplied parameters. # Stream provisioning progress Source: https://developer.upsun.com/api-reference/organization-projects/stream-provisioning-progress https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/projects/provisioning Streams real-time provisioning progress for projects being created in the specified organization. The response is an NDJSON stream where each line is a JSON object representing a provisioning event. The stream emits events as provisioning stages complete and terminates automatically when all in-flight projects finish (or fail). A keep-alive event is sent periodically to prevent connection timeouts. The body is a newline-delimited stream of JSON objects. Each line is a single `ProvisionEvent`. The `data`, `done`, and `error` events include a `steps` array listing the ordered provisioning steps. Event types: - `data` — a provisioning stage completed - `done` — provisioning finished successfully - `error` — provisioning failed - `keep_alive` — connection keep-alive # Update project Source: https://developer.upsun.com/api-reference/organization-projects/update-project https://meta.upsun.com/openapi-spec patch /organizations/{organization_id}/projects/{project_id} Updates the specified project. # Create organization Source: https://developer.upsun.com/api-reference/organizations/create-organization https://meta.upsun.com/openapi-spec post /organizations Creates a new organization. # Delete organization Source: https://developer.upsun.com/api-reference/organizations/delete-organization https://meta.upsun.com/openapi-spec delete /organizations/{organization_id} Deletes the specified organization. # Get organization Source: https://developer.upsun.com/api-reference/organizations/get-organization https://meta.upsun.com/openapi-spec get /organizations/{organization_id} Retrieves the specified organization. # List organizations Source: https://developer.upsun.com/api-reference/organizations/list-organizations https://meta.upsun.com/openapi-spec get /organizations Non-admin users will only see organizations they are members of. # Update organization Source: https://developer.upsun.com/api-reference/organizations/update-organization https://meta.upsun.com/openapi-spec patch /organizations/{organization_id} Updates the specified organization. # User organizations Source: https://developer.upsun.com/api-reference/organizations/user-organizations https://meta.upsun.com/openapi-spec get /users/{user_id}/organizations Retrieves organizations that the specified user is a member of. # Confirm phone number Source: https://developer.upsun.com/api-reference/phonenumber/confirm-phone-number https://meta.upsun.com/openapi-spec post /users/{user_id}/phonenumber/{sid} Confirms phone number using a verification code. # Verify phone number Source: https://developer.upsun.com/api-reference/phonenumber/verify-phone-number https://meta.upsun.com/openapi-spec post /users/{user_id}/phonenumber Starts a phone number verification session. # Get address Source: https://developer.upsun.com/api-reference/profiles/get-address https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/address Retrieves the address for the specified organization. # Get profile Source: https://developer.upsun.com/api-reference/profiles/get-profile https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/profile Retrieves the profile for the specified organization. # Update address Source: https://developer.upsun.com/api-reference/profiles/update-address https://meta.upsun.com/openapi-spec patch /organizations/{organization_id}/address Updates the address for the specified organization. # Update profile Source: https://developer.upsun.com/api-reference/profiles/update-profile https://meta.upsun.com/openapi-spec patch /organizations/{organization_id}/profile Updates the profile for the specified organization. # Cancel a project activity Source: https://developer.upsun.com/api-reference/project-activity/cancel-a-project-activity https://meta.upsun.com/openapi-spec post /projects/{projectId}/activities/{activityId}/cancel Cancel a single activity as specified by an `id` returned by the [Get project activity log](#tag/Project-Activity%2Fpaths%2F~1projects~1%7BprojectId%7D~1activities%2Fget) endpoint. Please note that not all activities are cancelable. # Get a project activity log entry Source: https://developer.upsun.com/api-reference/project-activity/get-a-project-activity-log-entry https://meta.upsun.com/openapi-spec get /projects/{projectId}/activities/{activityId} Retrieve a single activity log entry as specified by an `id` returned by the [Get project activity log](#tag/Project-Activity%2Fpaths%2F~1projects~1%7BprojectId%7D~1activities%2Fget) endpoint. See the documentation on that endpoint for details about the information this endpoint can return. # Get project activity log Source: https://developer.upsun.com/api-reference/project-activity/get-project-activity-log https://meta.upsun.com/openapi-spec get /projects/{projectId}/activities Retrieve a project's activity log including logging actions in all environments within a project. This returns a list of objects with records of actions such as: - Commits being pushed to the repository - A new environment being branched out from the specified environment - A snapshot being created of the specified environment The object includes a timestamp of when the action occurred (`created_at`), when the action concluded (`updated_at`), the current `state` of the action, the action's completion percentage (`completion_percent`), the `environments` it applies to and when the activity expires (`expires_at`). There are other related information in the `payload`. The contents of the `payload` varies based on the `type` of the activity. For example: - An `environment.branch` action's `payload` can contain objects representing the environment's `parent` environment and the branching action's `outcome`. - An `environment.push` action's `payload` can contain objects representing the `environment`, the specific `commits` included in the push, and the `user` who pushed. Expired activities are removed from the project activity log, except the last 100 expired objects provided they are not of type `environment.cron` or `environment.backup`. # Cancel a pending invitation to a project Source: https://developer.upsun.com/api-reference/project-invitations/cancel-a-pending-invitation-to-a-project https://meta.upsun.com/openapi-spec delete /projects/{project_id}/invitations/{invitation_id} Cancels the specified invitation. # Invite user to a project by email Source: https://developer.upsun.com/api-reference/project-invitations/invite-user-to-a-project-by-email https://meta.upsun.com/openapi-spec post /projects/{project_id}/invitations Creates an invitation to a project for a user with the specified email address. # List invitations to a project Source: https://developer.upsun.com/api-reference/project-invitations/list-invitations-to-a-project https://meta.upsun.com/openapi-spec get /projects/{project_id}/invitations Returns a list of invitations to a project. # Get list of project settings Source: https://developer.upsun.com/api-reference/project-settings/get-list-of-project-settings https://meta.upsun.com/openapi-spec get /projects/{projectId}/settings Retrieve the global settings for a project. # Update a project setting Source: https://developer.upsun.com/api-reference/project-settings/update-a-project-setting https://meta.upsun.com/openapi-spec patch /projects/{projectId}/settings Update one or more project-level settings. # Add a project variable Source: https://developer.upsun.com/api-reference/project-variables/add-a-project-variable https://meta.upsun.com/openapi-spec post /projects/{projectId}/variables Add a variable to a project. The `value` can be either a string or a JSON object (default: string), as specified by the `is_json` boolean flag. See the [Variables](https://docs.upsun.com/anchors/variables/set/project/create/) section in our documentation for more information. # Delete a project variable Source: https://developer.upsun.com/api-reference/project-variables/delete-a-project-variable https://meta.upsun.com/openapi-spec delete /projects/{projectId}/variables/{projectVariableId} Delete a single user-defined project variable. # Get a project variable Source: https://developer.upsun.com/api-reference/project-variables/get-a-project-variable https://meta.upsun.com/openapi-spec get /projects/{projectId}/variables/{projectVariableId} Retrieve a single user-defined project variable. # Get list of project variables Source: https://developer.upsun.com/api-reference/project-variables/get-list-of-project-variables https://meta.upsun.com/openapi-spec get /projects/{projectId}/variables Retrieve a list of objects representing the user-defined variables within a project. # Update a project variable Source: https://developer.upsun.com/api-reference/project-variables/update-a-project-variable https://meta.upsun.com/openapi-spec patch /projects/{projectId}/variables/{projectVariableId} Update a single user-defined project variable. The `value` can be either a string or a JSON object (default: string), as specified by the `is_json` boolean flag. See the [Variables](https://docs.upsun.com/anchors/variables/set/project/create/) section in our documentation for more information. # Clear project build cache Source: https://developer.upsun.com/api-reference/project/clear-project-build-cache https://meta.upsun.com/openapi-spec post /projects/{projectId}/clear_build_cache On rare occasions, a project's build cache can become corrupted. This endpoint will entirely flush the project's build cache. More information on [clearing the build cache can be found in our user documentation.](https://docs.upsun.com/anchors/troubleshoot/clear-build-cache/) # Get a project Source: https://developer.upsun.com/api-reference/project/get-a-project https://meta.upsun.com/openapi-spec get /projects/{projectId} Retrieve the details of a single project. # Get a project's capabilities Source: https://developer.upsun.com/api-reference/project/get-a-projects-capabilities https://meta.upsun.com/openapi-spec get /projects/{projectId}/capabilities Get a list of capabilities on a project, as defined by the billing system. For instance, one special capability that could be defined on a project is large development environments. # Post projects maintenance redeploy Source: https://developer.upsun.com/api-reference/project/post-projects-maintenance-redeploy https://meta.upsun.com/openapi-spec post /projects/{projectId}/maintenance-redeploy # List project history Source: https://developer.upsun.com/api-reference/projects/list-project-history https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/projects/{project_id}/history Retrieves history records for the specified project, oldest first. # Query project carbon emissions metrics for an entire organization Source: https://developer.upsun.com/api-reference/query-project-carbon-emissions-metrics-for-an-entire-organization https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/metrics/carbon Queries the carbon emission data for all projects owned by the specified organiation. # List plan records Source: https://developer.upsun.com/api-reference/records/list-plan-records https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/records/plan Retrieves plan records for the specified organization. # List usage records Source: https://developer.upsun.com/api-reference/records/list-usage-records https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/records/usage Retrieves usage records for the specified organization. # List referenced organizations Source: https://developer.upsun.com/api-reference/references/list-referenced-organizations https://meta.upsun.com/openapi-spec get /ref/organizations Retrieves a list of organizations referenced by a trusted service. Clients cannot construct the URL themselves. The correct URL will be provided in the HAL links of another API response, in the _links object with a key like ref:organizations:0. # List referenced projects Source: https://developer.upsun.com/api-reference/references/list-referenced-projects https://meta.upsun.com/openapi-spec get /ref/projects Retrieves a list of projects referenced by a trusted service. Clients cannot construct the URL themselves. The correct URL will be provided in the HAL links of another API response, in the _links object with a key like ref:projects:0. # List referenced regions Source: https://developer.upsun.com/api-reference/references/list-referenced-regions https://meta.upsun.com/openapi-spec get /ref/regions Retrieves a list of regions referenced by a trusted service. Clients cannot construct the URL themselves. The correct URL will be provided in the HAL links of another API response, in the _links object with a key like ref:regions:0. # List referenced teams Source: https://developer.upsun.com/api-reference/references/list-referenced-teams https://meta.upsun.com/openapi-spec get /ref/teams Retrieves a list of teams referenced by a trusted service. Clients cannot construct the URL themselves. The correct URL will be provided in the HAL links of another API response, in the _links object with a key like ref:teams:0. # List referenced users Source: https://developer.upsun.com/api-reference/references/list-referenced-users https://meta.upsun.com/openapi-spec get /ref/users Retrieves a list of users referenced by a trusted service. Clients cannot construct the URL themselves. The correct URL will be provided in the HAL links of another API response, in the _links object with a key like ref:users:0. # Get region Source: https://developer.upsun.com/api-reference/regions/get-region https://meta.upsun.com/openapi-spec get /regions/{region_id} Retrieves the specified region. # List regions Source: https://developer.upsun.com/api-reference/regions/list-regions https://meta.upsun.com/openapi-spec get /regions Retrieves a list of available regions. # Get a blob object Source: https://developer.upsun.com/api-reference/repository/get-a-blob-object https://meta.upsun.com/openapi-spec get /projects/{projectId}/git/blobs/{repositoryBlobId} Retrieve, by hash, an object representing a blob in the repository backing a project. This endpoint allows direct read-only access to the contents of files in a repo. It returns the file in the `content` field of the response object, encoded according to the format in the `encoding` field, e.g. `base64`. # Get a commit object Source: https://developer.upsun.com/api-reference/repository/get-a-commit-object https://meta.upsun.com/openapi-spec get /projects/{projectId}/git/commits/{repositoryCommitId} Retrieve, by hash, an object representing a commit in the repository backing a project. This endpoint functions similarly to `git cat-file -p `. The returned object contains the hash of the Git tree that it belongs to, as well as the ID of parent commits. The commit represented by a parent ID can be retrieved using this endpoint, while the tree state represented by this commit can be retrieved using the [Get a tree object](#tag/Git-Repo%2Fpaths%2F~1projects~1%7BprojectId%7D~1git~1trees~1%7BrepositoryTreeId%7D%2Fget) endpoint. # Get a ref object Source: https://developer.upsun.com/api-reference/repository/get-a-ref-object https://meta.upsun.com/openapi-spec get /projects/{projectId}/git/refs/{repositoryRefId} Retrieve the details of a single `refs` object in the repository backing a project. This endpoint functions similarly to `git show-ref `, although the pattern must be a full ref `id`, rather than a matching pattern. *NOTE: The `{repositoryRefId}` must be properly escaped.* That is, the ref `refs/heads/master` is accessible via `/projects/{projectId}/git/refs/heads%2Fmaster`. # Get a tree object Source: https://developer.upsun.com/api-reference/repository/get-a-tree-object https://meta.upsun.com/openapi-spec get /projects/{projectId}/git/trees/{repositoryTreeId} Retrieve, by hash, the tree state represented by a commit. The returned object's `tree` field contains a list of files and directories present in the tree. Directories in the tree can be recursively retrieved by this endpoint through their hashes. Files in the tree can be retrieved by the [Get a blob object](#tag/Git-Repo%2Fpaths%2F~1projects~1%7BprojectId%7D~1git~1blobs~1%7BrepositoryBlobId%7D%2Fget) endpoint. # Get list of repository refs Source: https://developer.upsun.com/api-reference/repository/get-list-of-repository-refs https://meta.upsun.com/openapi-spec get /projects/{projectId}/git/refs Retrieve a list of `refs/*` in the repository backing a project. This endpoint functions similarly to `git show-ref`, with each returned object containing a `ref` field with the ref's name, and an object containing the associated commit ID. The returned commit ID can be used with the [Get a commit object](#tag/Git-Repo%2Fpaths%2F~1projects~1%7BprojectId%7D~1git~1commits~1%7BrepositoryCommitId%7D%2Fget) endpoint to retrieve information about that specific commit. # Get resource metrics by service Source: https://developer.upsun.com/api-reference/resources/get-resource-metrics-by-service https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/observability/resources/service/{service} Returns time-series resource data for one service. Each timestamp contains per-instance metrics. Filter results using aggs[] (min, max, avg, stddev, p50, p95-p99) and types[] (cpu, memory, swap, disk, inodes, pressure metrics). Response grouped by timestamp then instance ID (e.g., "app.0"). All aggregations nullable when insufficient data exists. # Get resource metrics overview Source: https://developer.upsun.com/api-reference/resources/get-resource-metrics-overview https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/observability/resources/overview Returns time-series resource utilization data for all services. Each timestamp includes per-service metrics: CPU (cores), memory (bytes), swap (bytes), pressure indicators (0.0-1.0), and per-mountpoint disk/inode usage. All metrics include statistical aggregations: min, max, avg, stddev, and percentiles (p50, p95-p99). Service names and mountpoint paths are dynamic. Aggregation values are nullable when insufficient data exists. # Get resource metrics summary Source: https://developer.upsun.com/api-reference/resources/get-resource-metrics-summary https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/observability/resources/summary Returns per-instance resource statistics aggregated over the time range. Filter results using aggs[] (min, max, avg, stddev, p50, p95-p99) and types[] (cpu, memory, swap, disk, inodes, pressure metrics). Response grouped by service name then instance ID (e.g., "app.0", "database.1"). All aggregations nullable when insufficient data exists. # Get a route's info Source: https://developer.upsun.com/api-reference/routing/get-a-routes-info https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/routes/{routeId} Get details of a route from an environment using the `id` of the entry retrieved by the [Get environment routes list](#tag/Environment-Routes%2Fpaths%2F~1projects~1%7BprojectId%7D~1environments~1%7BenvironmentId%7D~1routes%2Fget) endpoint. # Get list of routes Source: https://developer.upsun.com/api-reference/routing/get-list-of-routes https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/routes Retrieve a list of objects containing route definitions for a specific environment. The definitions returned by this endpoint are those present in an environment's `.upsun/config.yaml` file. # Execute a runtime operation Source: https://developer.upsun.com/api-reference/runtime-operations/execute-a-runtime-operation https://meta.upsun.com/openapi-spec post /projects/{projectId}/environments/{environmentId}/deployments/{deploymentId}/operations Execute a runtime operation on a currently deployed environment. This allows you to run one-off commands, such as rebuilding static assets on demand, by defining an `operations` key in a project's `.upsun/config.yaml` configuration. More information on runtime operations is [available in our user documentation](https://docs.upsun.com/anchors/app/runtime-operations/). # List source operations Source: https://developer.upsun.com/api-reference/source-operations/list-source-operations https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/source-operations Lists all the source operations, defined in `.upsun/config.yaml`, that are available in an environment. More information on source code operations is [available in our user documentation](https://docs.upsun.com/anchors/app/reference/source/operations/). # Trigger a source operation Source: https://developer.upsun.com/api-reference/source-operations/trigger-a-source-operation https://meta.upsun.com/openapi-spec post /projects/{projectId}/environments/{environmentId}/source-operation This endpoint triggers a source code operation as defined in the `source.operations` key in a project's `.upsun/config.yaml` configuration. More information on source code operations is [available in our user documentation](https://docs.upsun.com/anchors/app/reference/source/operations/). # Add a new public SSH key to a user Source: https://developer.upsun.com/api-reference/ssh-keys/add-a-new-public-ssh-key-to-a-user https://meta.upsun.com/openapi-spec post /ssh_keys # Delete an SSH key Source: https://developer.upsun.com/api-reference/ssh-keys/delete-an-ssh-key https://meta.upsun.com/openapi-spec delete /ssh_keys/{key_id} # Get an SSH key Source: https://developer.upsun.com/api-reference/ssh-keys/get-an-ssh-key https://meta.upsun.com/openapi-spec get /ssh_keys/{key_id} # Checks if the user can afford the requested resources. Source: https://developer.upsun.com/api-reference/subscriptions/checks-if-the-user-can-afford-the-requested-resources https://meta.upsun.com/openapi-spec post /subscriptions/{subscriptionId}/can-afford # Checks if the user is able to create a new project. Source: https://developer.upsun.com/api-reference/subscriptions/checks-if-the-user-is-able-to-create-a-new-project https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/subscriptions/can-create # Checks if the user is able to update a project. Source: https://developer.upsun.com/api-reference/subscriptions/checks-if-the-user-is-able-to-update-a-project https://meta.upsun.com/openapi-spec get /subscriptions/{subscriptionId}/can-update # Create subscription Source: https://developer.upsun.com/api-reference/subscriptions/create-subscription https://meta.upsun.com/openapi-spec post /organizations/{organization_id}/subscriptions Creates a subscription for the specified organization. # Delete subscription Source: https://developer.upsun.com/api-reference/subscriptions/delete-subscription https://meta.upsun.com/openapi-spec delete /organizations/{organization_id}/subscriptions/{subscription_id} Deletes a subscription for the specified organization. # Estimate the price of a new subscription Source: https://developer.upsun.com/api-reference/subscriptions/estimate-the-price-of-a-new-subscription https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/subscriptions/estimate # Estimate the price of a subscription Source: https://developer.upsun.com/api-reference/subscriptions/estimate-the-price-of-a-subscription https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/subscriptions/{subscription_id}/estimate # Get current usage for a subscription Source: https://developer.upsun.com/api-reference/subscriptions/get-current-usage-for-a-subscription https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/subscriptions/{subscription_id}/current_usage # Get subscription Source: https://developer.upsun.com/api-reference/subscriptions/get-subscription https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/subscriptions/{subscription_id} Retrieves a subscription for the specified organization. # Get usage alerts Source: https://developer.upsun.com/api-reference/subscriptions/get-usage-alerts https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/alerts/subscriptions/{subscription_id}/usage Retrieves current and available usage alerts. # List addons for a subscription Source: https://developer.upsun.com/api-reference/subscriptions/list-addons-for-a-subscription https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/subscriptions/{subscription_id}/addons # List subscriptions Source: https://developer.upsun.com/api-reference/subscriptions/list-subscriptions https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/subscriptions Retrieves subscriptions for the specified organization. # Update subscription Source: https://developer.upsun.com/api-reference/subscriptions/update-subscription https://meta.upsun.com/openapi-spec patch /organizations/{organization_id}/subscriptions/{subscription_id} Updates a subscription for the specified organization. # Update usage alerts. Source: https://developer.upsun.com/api-reference/subscriptions/update-usage-alerts https://meta.upsun.com/openapi-spec patch /organizations/{organization_id}/alerts/subscriptions/{subscription_id}/usage Updates usage alerts for a subscription. # Create a new support ticket Source: https://developer.upsun.com/api-reference/support/create-a-new-support-ticket https://meta.upsun.com/openapi-spec post /tickets # List support ticket categories Source: https://developer.upsun.com/api-reference/support/list-support-ticket-categories https://meta.upsun.com/openapi-spec get /tickets/category # List support ticket priorities Source: https://developer.upsun.com/api-reference/support/list-support-ticket-priorities https://meta.upsun.com/openapi-spec get /tickets/priority # Update a ticket Source: https://developer.upsun.com/api-reference/support/update-a-ticket https://meta.upsun.com/openapi-spec patch /tickets/{ticket_id} # Get information about the Git server. Source: https://developer.upsun.com/api-reference/system-information/get-information-about-the-git-server https://meta.upsun.com/openapi-spec get /projects/{projectId}/system Output information for the project. # Restart the Git server Source: https://developer.upsun.com/api-reference/system-information/restart-the-git-server https://meta.upsun.com/openapi-spec post /projects/{projectId}/system/restart Force the Git server to restart. # Get projects environments tasks Source: https://developer.upsun.com/api-reference/task/get-projects-environments-tasks https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/tasks # Get projects environments tasks 1 Source: https://developer.upsun.com/api-reference/task/get-projects-environments-tasks-1 https://meta.upsun.com/openapi-spec get /projects/{projectId}/environments/{environmentId}/tasks/{taskId} # Post projects environments tasks run Source: https://developer.upsun.com/api-reference/task/post-projects-environments-tasks-run https://meta.upsun.com/openapi-spec post /projects/{projectId}/environments/{environmentId}/tasks/{taskId}/run # Get project access for a team Source: https://developer.upsun.com/api-reference/team-access/get-project-access-for-a-team https://meta.upsun.com/openapi-spec get /teams/{team_id}/project-access/{project_id} Retrieves the team's permissions for the current project. # Get team access for a project Source: https://developer.upsun.com/api-reference/team-access/get-team-access-for-a-project https://meta.upsun.com/openapi-spec get /projects/{project_id}/team-access/{team_id} Retrieves the team's permissions for the current project. # Grant project access to a team Source: https://developer.upsun.com/api-reference/team-access/grant-project-access-to-a-team https://meta.upsun.com/openapi-spec post /teams/{team_id}/project-access Adds the team to one or more specified projects. # Grant team access to a project Source: https://developer.upsun.com/api-reference/team-access/grant-team-access-to-a-project https://meta.upsun.com/openapi-spec post /projects/{project_id}/team-access Grants one or more team access to a specific project. # List project access for a team Source: https://developer.upsun.com/api-reference/team-access/list-project-access-for-a-team https://meta.upsun.com/openapi-spec get /teams/{team_id}/project-access Returns a list of items representing the team's project access. # List team access for a project Source: https://developer.upsun.com/api-reference/team-access/list-team-access-for-a-project https://meta.upsun.com/openapi-spec get /projects/{project_id}/team-access Returns a list of items representing the project access. # Remove project access for a team Source: https://developer.upsun.com/api-reference/team-access/remove-project-access-for-a-team https://meta.upsun.com/openapi-spec delete /teams/{team_id}/project-access/{project_id} Removes the team from the current project. # Remove team access for a project Source: https://developer.upsun.com/api-reference/team-access/remove-team-access-for-a-project https://meta.upsun.com/openapi-spec delete /projects/{project_id}/team-access/{team_id} Removes the team from the current project. # Create team Source: https://developer.upsun.com/api-reference/teams/create-team https://meta.upsun.com/openapi-spec post /teams Creates a new team. # Create team member Source: https://developer.upsun.com/api-reference/teams/create-team-member https://meta.upsun.com/openapi-spec post /teams/{team_id}/members Creates a new team member. # Delete team Source: https://developer.upsun.com/api-reference/teams/delete-team https://meta.upsun.com/openapi-spec delete /teams/{team_id} Deletes the specified team. # Delete team member Source: https://developer.upsun.com/api-reference/teams/delete-team-member https://meta.upsun.com/openapi-spec delete /teams/{team_id}/members/{user_id} Deletes the specified team member. # Get team Source: https://developer.upsun.com/api-reference/teams/get-team https://meta.upsun.com/openapi-spec get /teams/{team_id} Retrieves the specified team. # Get team member Source: https://developer.upsun.com/api-reference/teams/get-team-member https://meta.upsun.com/openapi-spec get /teams/{team_id}/members/{user_id} Retrieves the specified team member. # List team members Source: https://developer.upsun.com/api-reference/teams/list-team-members https://meta.upsun.com/openapi-spec get /teams/{team_id}/members Retrieves a list of users associated with a single team. # List teams Source: https://developer.upsun.com/api-reference/teams/list-teams https://meta.upsun.com/openapi-spec get /teams Retrieves a list of teams. # Update team Source: https://developer.upsun.com/api-reference/teams/update-team https://meta.upsun.com/openapi-spec patch /teams/{team_id} Updates the specified team. # User teams Source: https://developer.upsun.com/api-reference/teams/user-teams https://meta.upsun.com/openapi-spec get /users/{user_id}/teams Retrieves teams that the specified user is a member of. # Delete an existing third-party integration Source: https://developer.upsun.com/api-reference/third-party-integrations/delete-an-existing-third-party-integration https://meta.upsun.com/openapi-spec delete /projects/{projectId}/integrations/{integrationId} # Get information about an existing third-party integration Source: https://developer.upsun.com/api-reference/third-party-integrations/get-information-about-an-existing-third-party-integration https://meta.upsun.com/openapi-spec get /projects/{projectId}/integrations/{integrationId} # Get list of existing integrations for a project Source: https://developer.upsun.com/api-reference/third-party-integrations/get-list-of-existing-integrations-for-a-project https://meta.upsun.com/openapi-spec get /projects/{projectId}/integrations # Integrate project with a third-party service Source: https://developer.upsun.com/api-reference/third-party-integrations/integrate-project-with-a-third-party-service https://meta.upsun.com/openapi-spec post /projects/{projectId}/integrations # Update an existing third-party integration Source: https://developer.upsun.com/api-reference/third-party-integrations/update-an-existing-third-party-integration https://meta.upsun.com/openapi-spec patch /projects/{projectId}/integrations/{integrationId} # Get project access for a user Source: https://developer.upsun.com/api-reference/user-access/get-project-access-for-a-user https://meta.upsun.com/openapi-spec get /users/{user_id}/project-access/{project_id} Retrieves the user's permissions for the current project. # Get user access for a project Source: https://developer.upsun.com/api-reference/user-access/get-user-access-for-a-project https://meta.upsun.com/openapi-spec get /projects/{project_id}/user-access/{user_id} Retrieves the user's permissions for the current project. # Grant project access to a user Source: https://developer.upsun.com/api-reference/user-access/grant-project-access-to-a-user https://meta.upsun.com/openapi-spec post /users/{user_id}/project-access Adds the user to one or more specified projects. # Grant user access to a project Source: https://developer.upsun.com/api-reference/user-access/grant-user-access-to-a-project https://meta.upsun.com/openapi-spec post /projects/{project_id}/user-access Grants one or more users access to a specific project. # List project access for a user Source: https://developer.upsun.com/api-reference/user-access/list-project-access-for-a-user https://meta.upsun.com/openapi-spec get /users/{user_id}/project-access Returns a list of items representing the user's project access. # List user access for a project Source: https://developer.upsun.com/api-reference/user-access/list-user-access-for-a-project https://meta.upsun.com/openapi-spec get /projects/{project_id}/user-access Returns a list of items representing the project access. # Remove project access for a user Source: https://developer.upsun.com/api-reference/user-access/remove-project-access-for-a-user https://meta.upsun.com/openapi-spec delete /users/{user_id}/project-access/{project_id} Removes the user from the current project. # Remove user access for a project Source: https://developer.upsun.com/api-reference/user-access/remove-user-access-for-a-project https://meta.upsun.com/openapi-spec delete /projects/{project_id}/user-access/{user_id} Removes the user from the current project. # Update project access for a user Source: https://developer.upsun.com/api-reference/user-access/update-project-access-for-a-user https://meta.upsun.com/openapi-spec patch /users/{user_id}/project-access/{project_id} Updates the user's permissions for the current project. # Update user access for a project Source: https://developer.upsun.com/api-reference/user-access/update-user-access-for-a-project https://meta.upsun.com/openapi-spec patch /projects/{project_id}/user-access/{user_id} Updates the user's permissions for the current project. # Create a user profile picture Source: https://developer.upsun.com/api-reference/user-profiles/create-a-user-profile-picture https://meta.upsun.com/openapi-spec post /profile/{uuid}/picture # Delete a user profile picture Source: https://developer.upsun.com/api-reference/user-profiles/delete-a-user-profile-picture https://meta.upsun.com/openapi-spec delete /profile/{uuid}/picture # Get a single user profile Source: https://developer.upsun.com/api-reference/user-profiles/get-a-single-user-profile https://meta.upsun.com/openapi-spec get /profiles/{userId} # Get a user address Source: https://developer.upsun.com/api-reference/user-profiles/get-a-user-address https://meta.upsun.com/openapi-spec get /profiles/{userId}/address # List user profiles Source: https://developer.upsun.com/api-reference/user-profiles/list-user-profiles https://meta.upsun.com/openapi-spec get /profiles # Update a user address Source: https://developer.upsun.com/api-reference/user-profiles/update-a-user-address https://meta.upsun.com/openapi-spec patch /profiles/{userId}/address Update a user address, supplying one or more key/value pairs to to change. # Update a user profile Source: https://developer.upsun.com/api-reference/user-profiles/update-a-user-profile https://meta.upsun.com/openapi-spec patch /profiles/{userId} Update a user profile, supplying one or more key/value pairs to to change. # Check if phone verification is required Source: https://developer.upsun.com/api-reference/users/check-if-phone-verification-is-required https://meta.upsun.com/openapi-spec post /me/phone Find out if the current logged in user requires phone verification to create projects. # Check if verification is required Source: https://developer.upsun.com/api-reference/users/check-if-verification-is-required https://meta.upsun.com/openapi-spec post /me/verification Find out if the current logged in user requires verification (phone or staff) to create projects. # Get a user Source: https://developer.upsun.com/api-reference/users/get-a-user https://meta.upsun.com/openapi-spec get /users/{user_id} Retrieves the specified user. # Get a user by email Source: https://developer.upsun.com/api-reference/users/get-a-user-by-email https://meta.upsun.com/openapi-spec get /users/email={email} Retrieves a user matching the specified email address. # Get a user by username Source: https://developer.upsun.com/api-reference/users/get-a-user-by-username https://meta.upsun.com/openapi-spec get /users/username={username} Retrieves a user matching the specified username. # Get current logged-in user info Source: https://developer.upsun.com/api-reference/users/get-current-logged-in-user-info https://meta.upsun.com/openapi-spec get /me Retrieve information about the currently logged-in user (the user associated with the access token). # Get the current user Source: https://developer.upsun.com/api-reference/users/get-the-current-user https://meta.upsun.com/openapi-spec get /users/me Retrieves the current user, determined from the used access token. # Reset email address Source: https://developer.upsun.com/api-reference/users/reset-email-address https://meta.upsun.com/openapi-spec post /users/{user_id}/emailaddress Requests a reset of the user's email address. A confirmation email will be sent to the new address when the request is accepted. # Reset user password Source: https://developer.upsun.com/api-reference/users/reset-user-password https://meta.upsun.com/openapi-spec post /users/{user_id}/resetpassword Requests a reset of the user's password. A password reset email will be sent to the user when the request is accepted. # Update a user Source: https://developer.upsun.com/api-reference/users/update-a-user https://meta.upsun.com/openapi-spec patch /users/{user_id} Updates the specified user. # Apply voucher Source: https://developer.upsun.com/api-reference/vouchers/apply-voucher https://meta.upsun.com/openapi-spec post /organizations/{organization_id}/vouchers/apply Applies a voucher for the specified organization, and refreshes the currently open order. # List vouchers Source: https://developer.upsun.com/api-reference/vouchers/list-vouchers https://meta.upsun.com/openapi-spec get /organizations/{organization_id}/vouchers Retrieves vouchers for the specified organization. # Upsun Cloud API Source: https://developer.upsun.com/api/index Interact with the Upsun Cloud platform programmatically through the REST API or language-specific SDKs. Manage projects, environments, and resources programmatically. Automate deployments, configure infrastructure, and integrate Upsun Cloud into your toolchain. ## SDKs Official client libraries with typed methods and built-in authentication. Install with Composer and manage your Upsun Cloud projects from PHP applications and scripts. Install with `npm` and integrate Upsun Cloud into your Node.js applications, serverless functions, or build pipelines. ## REST API Full access to the Upsun Cloud platform over HTTP. Authenticate with API tokens and interact with any resource. API tokens and OAuth Error codes and best practices ## OpenAPI Reference Interactive documentation for every endpoint, generated from the Upsun Cloud OpenAPI spec. Try requests directly from the browser. Browse all available endpoints with request and response schemas, parameters, and example payloads. # Introduction Source: https://developer.upsun.com/api/introduction Example section for showcasing API endpoints If you're not looking to build API reference documentation, you can delete this section by removing the api-reference folder. ## Welcome There are two ways to build API documentation: [OpenAPI](https://mintlify.com/docs/api-playground/openapi/setup) and [MDX components](https://mintlify.com/docs/api-playground/mdx/configuration). For the starter kit, we are using the following OpenAPI specification. View the OpenAPI specification file ## Authentication All API endpoints are authenticated using Bearer tokens and picked up from the specification file. ```json theme={null} "security": [ { "bearerAuth": [] } ] ``` # Metadata Registry Explorer Source: https://developer.upsun.com/api/resources/meta/explorer Explore all versions of all components registered in the Upsun Trust Registry.