# Upsun Developer: API

> Upsun Developer — documentation, guides, and more.

## API

- [Upsun API](https://developer.upsun.com/api/index.md): Interact with the Upsun platform programmatically through the REST API or language-specific SDKs.

### SDK

- [Overview](https://developer.upsun.com/api/sdk/overview.md): Official Upsun SDKs for PHP and Node.js.
- [Upsun SDK for PHP](https://developer.upsun.com/api/sdk/php.md): This section describes how to use Upsun SDK for PHP.
- [Upsun SDK for NodeJs](https://developer.upsun.com/api/sdk/js.md): This section describe how to use Upsun SDK for NodeJs.

### REST API

- [Overview](https://developer.upsun.com/api/rest/overview.md): This section provides an overview of the Upsun REST API.
- [Authentication](https://developer.upsun.com/api/rest/authentication.md): Authenticate with the Upsun REST API using OAuth2 API tokens.
- [Errors](https://developer.upsun.com/api/rest/errors.md): HTTP status codes and error handling for the Upsun REST API.
- [Endpoints](https://developer.upsun.com/api/rest/endpoints.md): Key API endpoints and resource overview for the Upsun REST API.

### OpenAPI Reference

#### API Reference

- [Query project carbon emissions metrics for an entire organization](https://developer.upsun.com/api-reference/query-project-carbon-emissions-metrics-for-an-entire-organization.md): Queries the carbon emission data for all projects owned by the specified organiation.
- [List support tickets](https://developer.upsun.com/api-reference/list-support-tickets.md)

#### Add-ons

- [Get add-ons](https://developer.upsun.com/api-reference/add-ons/get-add-ons.md): Retrieves information about the add-ons for an organization.

#### Alerts

- [Get usage alerts for a subscription](https://developer.upsun.com/api-reference/alerts/get-usage-alerts-for-a-subscription.md)
- [Update usage alerts.](https://developer.upsun.com/api-reference/alerts/update-usage-alerts.md)

#### API Tokens

- [List a user's API tokens](https://developer.upsun.com/api-reference/api-tokens/list-a-users-api-tokens.md): Retrieves a list of API tokens associated with a single user.
- [Create an API token](https://developer.upsun.com/api-reference/api-tokens/create-an-api-token.md): Creates an API token
- [Get an API token](https://developer.upsun.com/api-reference/api-tokens/get-an-api-token.md): Retrieves the specified API token.
- [Delete an API token](https://developer.upsun.com/api-reference/api-tokens/delete-an-api-token.md): Deletes an API token

#### Autoscaling

- [Retrieves Autoscaler settings](https://developer.upsun.com/api-reference/autoscaling/retrieves-autoscaler-settings.md): Retrieves Autoscaler settings
- [Updates Autoscaler settings](https://developer.upsun.com/api-reference/autoscaling/updates-autoscaler-settings.md): Updates Autoscaler settings
- [Modifies Autoscaler settings](https://developer.upsun.com/api-reference/autoscaling/modifies-autoscaler-settings.md): Modifies Autoscaler settings

#### Blackfire Monitoring

- [Get server cache metrics](https://developer.upsun.com/api-reference/blackfire-monitoring/get-server-cache-metrics.md): 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…
- [Get server monitoring overview](https://developer.upsun.com/api-reference/blackfire-monitoring/get-server-monitoring-overview.md): 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](https://developer.upsun.com/api-reference/blackfire-monitoring/get-server-transaction-breakdown.md): 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. Suppor…
- [Get top spans](https://developer.upsun.com/api-reference/blackfire-monitoring/get-top-spans.md): 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.

#### Blackfire Profiling

- [Get profile timeline data](https://developer.upsun.com/api-reference/blackfire-profiling/get-profile-timeline-data.md): Returns timeline visualization data for a Blackfire profile, showing the execution flow over time.
- [Get profile subprofiles](https://developer.upsun.com/api-reference/blackfire-profiling/get-profile-subprofiles.md): Returns subprofiles (child profiles) associated with a Blackfire profile.
- [Get profile details](https://developer.upsun.com/api-reference/blackfire-profiling/get-profile-details.md): Returns full profile data including metrics, metadata, and recommendations.
- [Get profile call graph](https://developer.upsun.com/api-reference/blackfire-profiling/get-profile-call-graph.md): Returns the call graph data for a Blackfire profile, showing function calls and their performance metrics.
- [Get recommendation statistics](https://developer.upsun.com/api-reference/blackfire-profiling/get-recommendation-statistics.md): 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](https://developer.upsun.com/api-reference/blackfire-profiling/list-profiling-results.md): Returns a paginated list of profiles for the environment, optionally filtered by transaction name. Proxied from the Blackfire API.

#### Cert Management

- [Get list of SSL certificates](https://developer.upsun.com/api-reference/cert-management/get-list-of-ssl-certificates.md): Retrieve a list of objects representing the SSL certificates associated with a project.
- [Add an SSL certificate](https://developer.upsun.com/api-reference/cert-management/add-an-ssl-certificate.md): Add a single SSL certificate to a project.
- [Get an SSL certificate](https://developer.upsun.com/api-reference/cert-management/get-an-ssl-certificate.md): Retrieve information about a single SSL certificate associated with a project.
- [Delete an SSL certificate](https://developer.upsun.com/api-reference/cert-management/delete-an-ssl-certificate.md): Delete a single SSL certificate associated with a project.
- [Update an SSL certificate](https://developer.upsun.com/api-reference/cert-management/update-an-ssl-certificate.md): Update a single SSL certificate associated with a project.
- [Get projects provisioners](https://developer.upsun.com/api-reference/cert-management/get-projects-provisioners.md)
- [Get projects provisioners 1](https://developer.upsun.com/api-reference/cert-management/get-projects-provisioners-1.md)
- [Patch projects provisioners](https://developer.upsun.com/api-reference/cert-management/patch-projects-provisioners.md)

#### Connections

- [List federated login connections](https://developer.upsun.com/api-reference/connections/list-federated-login-connections.md): Retrieves a list of connections associated with a single user.
- [Get a federated login connection](https://developer.upsun.com/api-reference/connections/get-a-federated-login-connection.md): Retrieves the specified connection.
- [Delete a federated login connection](https://developer.upsun.com/api-reference/connections/delete-a-federated-login-connection.md): Deletes the specified connection.

#### Continuous Profiling

- [List profiled applications](https://developer.upsun.com/api-reference/continuous-profiling/list-profiled-applications.md): 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
- [Get application timeline](https://developer.upsun.com/api-reference/continuous-profiling/get-application-timeline.md): 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](https://developer.upsun.com/api-reference/continuous-profiling/get-merged-profile.md): 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
- [Get application filter values](https://developer.upsun.com/api-reference/continuous-profiling/get-application-filter-values.md): 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

#### Deployment

- [Get an environment's deployment information](https://developer.upsun.com/api-reference/deployment/get-an-environments-deployment-information.md): Retrieve the read-only configuration of an environment's deployment. The returned information is everything required to recreate a project's current deployment.
- [Get a single environment deployment](https://developer.upsun.com/api-reference/deployment/get-a-single-environment-deployment.md): Retrieve a single deployment configuration with an id of `current`. This may be subject to change in the future. Only `current` can be queried.

#### Deployment Target

- [Get project deployment target info](https://developer.upsun.com/api-reference/deployment-target/get-project-deployment-target-info.md): The deployment target information for the project.
- [Create a project deployment target](https://developer.upsun.com/api-reference/deployment-target/create-a-project-deployment-target.md): Set the deployment target information for a project.
- [Get a single project deployment target](https://developer.upsun.com/api-reference/deployment-target/get-a-single-project-deployment-target.md): Get a single deployment target configuration of a project.
- [Delete a single project deployment target](https://developer.upsun.com/api-reference/deployment-target/delete-a-single-project-deployment-target.md): Delete a single deployment target configuration associated with a specific project.
- [Update a project deployment](https://developer.upsun.com/api-reference/deployment-target/update-a-project-deployment.md)

#### Diff

- [Get projects gitdiffs ](https://developer.upsun.com/api-reference/diff/get-projects-gitdiffs-.md)

#### Discounts

- [Get an organization discount](https://developer.upsun.com/api-reference/discounts/get-an-organization-discount.md)
- [Get the value of the First Project Incentive discount](https://developer.upsun.com/api-reference/discounts/get-the-value-of-the-first-project-incentive-discount.md)
- [List organization discounts](https://developer.upsun.com/api-reference/discounts/list-organization-discounts.md): Retrieves all applicable discounts granted to the specified organization.

#### Domain Claim

- [Get projects domain claims](https://developer.upsun.com/api-reference/domain-claim/get-projects-domain-claims.md)
- [Post projects domain claims](https://developer.upsun.com/api-reference/domain-claim/post-projects-domain-claims.md)
- [Get projects domain claims 1](https://developer.upsun.com/api-reference/domain-claim/get-projects-domain-claims-1.md)
- [Delete projects domain claims](https://developer.upsun.com/api-reference/domain-claim/delete-projects-domain-claims.md)
- [Patch projects domain claims](https://developer.upsun.com/api-reference/domain-claim/patch-projects-domain-claims.md)

#### Domain Management

- [Get list of project domains](https://developer.upsun.com/api-reference/domain-management/get-list-of-project-domains.md): 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.
- [Add a project domain](https://developer.upsun.com/api-reference/domain-management/add-a-project-domain.md): 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/)
- [Get a project domain](https://developer.upsun.com/api-reference/domain-management/get-a-project-domain.md): Retrieve information about a single user-specified domain associated with a project.
- [Delete a project domain](https://developer.upsun.com/api-reference/domain-management/delete-a-project-domain.md): Delete a single user-specified domain associated with a project.
- [Update a project domain](https://developer.upsun.com/api-reference/domain-management/update-a-project-domain.md): Update the information associated with a single user-specified domain associated with a project.
- [Get a list of environment domains](https://developer.upsun.com/api-reference/domain-management/get-a-list-of-environment-domains.md): 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.
- [Add an environment domain](https://developer.upsun.com/api-reference/domain-management/add-an-environment-domain.md): 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…
- [Get an environment domain](https://developer.upsun.com/api-reference/domain-management/get-an-environment-domain.md): Retrieve information about a single user-specified domain associated with an environment.
- [Delete an environment domain](https://developer.upsun.com/api-reference/domain-management/delete-an-environment-domain.md): Delete a single user-specified domain associated with an environment.
- [Update an environment domain](https://developer.upsun.com/api-reference/domain-management/update-an-environment-domain.md): Update the information associated with a single user-specified domain associated with an environment.

#### Entrypoint

- [Get observability entrypoint](https://developer.upsun.com/api-reference/entrypoint/get-observability-entrypoint.md): 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), enviro…

#### Environment

- [Get list of project environments](https://developer.upsun.com/api-reference/environment/get-list-of-project-environments.md): Retrieve a list of a project's existing environments and the information associated with each environment.
- [Get an environment](https://developer.upsun.com/api-reference/environment/get-an-environment.md): Retrieve the details of a single existing environment.
- [Delete an environment](https://developer.upsun.com/api-reference/environment/delete-an-environment.md): Delete a specified environment.
- [Update an environment](https://developer.upsun.com/api-reference/environment/update-an-environment.md): Update the details of a single existing environment.
- [Activate an environment](https://developer.upsun.com/api-reference/environment/activate-an-environment.md): Set the specified environment's status to active
- [Branch an environment](https://developer.upsun.com/api-reference/environment/branch-an-environment.md): Create a new environment as a branch of the current environment.
- [Deactivate an environment](https://developer.upsun.com/api-reference/environment/deactivate-an-environment.md): 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.
- [Deploy an environment](https://developer.upsun.com/api-reference/environment/deploy-an-environment.md): Trigger a controlled [manual deployment](https://docs.upsun.com/learn/overview/build-deploy.html#manual-deployment) to release all the staged changes
- [Initialize a new environment](https://developer.upsun.com/api-reference/environment/initialize-a-new-environment.md): Initialize and configure a new environment with an existing repository. The payload is the url of a git repository with a profile name:
- [Post projects environments maintenance redeploy](https://developer.upsun.com/api-reference/environment/post-projects-environments-maintenance-redeploy.md)
- [Merge an environment](https://developer.upsun.com/api-reference/environment/merge-an-environment.md): 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](https://developer.upsun.com/api-reference/environment/pause-an-environment.md): Pause an environment, stopping all services and applications (except the router).
- [Redeploy an environment](https://developer.upsun.com/api-reference/environment/redeploy-an-environment.md): Trigger the redeployment sequence of an environment.
- [Resume a paused environment](https://developer.upsun.com/api-reference/environment/resume-a-paused-environment.md): Resume a paused environment, restarting all services and applications.
- [Synchronize a child environment with its parent](https://developer.upsun.com/api-reference/environment/synchronize-a-child-environment-with-its-parent.md): 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.

#### Environment Activity

- [Get environment activity log](https://developer.upsun.com/api-reference/environment-activity/get-environment-activity-log.md): Retrieve an environment's activity log. This returns a list of object with records of actions such as:
- [Get an environment activity log entry](https://developer.upsun.com/api-reference/environment-activity/get-an-environment-activity-log-entry.md): 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 ab…
- [Cancel an environment activity](https://developer.upsun.com/api-reference/environment-activity/cancel-an-environment-activity.md): 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.

#### Environment Backups

- [Create backup of environment](https://developer.upsun.com/api-reference/environment-backups/create-backup-of-environment.md): 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.
- [Get an environment's backup list](https://developer.upsun.com/api-reference/environment-backups/get-an-environments-backup-list.md): Retrieve a list of objects representing backups of this environment.
- [Get an environment backup's info](https://developer.upsun.com/api-reference/environment-backups/get-an-environment-backups-info.md): 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.
- [Delete an environment backup](https://developer.upsun.com/api-reference/environment-backups/delete-an-environment-backup.md): 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.
- [Restore an environment snapshot](https://developer.upsun.com/api-reference/environment-backups/restore-an-environment-snapshot.md): 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.

#### Environment Type

- [Get environment types](https://developer.upsun.com/api-reference/environment-type/get-environment-types.md): List all available environment types
- [Get environment type links](https://developer.upsun.com/api-reference/environment-type/get-environment-type-links.md): Lists the endpoints used to retrieve info about the environment type.

#### Environment Variables

- [Get list of environment variables](https://developer.upsun.com/api-reference/environment-variables/get-list-of-environment-variables.md): Retrieve a list of objects representing the user-defined variables within an environment.
- [Add an environment variable](https://developer.upsun.com/api-reference/environment-variables/add-an-environment-variable.md): 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 V…
- [Get an environment variable](https://developer.upsun.com/api-reference/environment-variables/get-an-environment-variable.md): Retrieve a single user-defined environment variable.
- [Delete an environment variable](https://developer.upsun.com/api-reference/environment-variables/delete-an-environment-variable.md): Delete a single user-defined environment variable.
- [Update an environment variable](https://developer.upsun.com/api-reference/environment-variables/update-an-environment-variable.md): 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 t…

#### Grants

- [List extended access of a user](https://developer.upsun.com/api-reference/grants/list-extended-access-of-a-user.md): List extended access of the given user, which includes both individual and team access to project and organization.
- [Get access document by access ID](https://developer.upsun.com/api-reference/grants/get-access-document-by-access-id.md): Returns the full access document referenced by token claim `access_id`.

#### Http Traffic

- [Get HTTP traffic timeline by URL](https://developer.upsun.com/api-reference/http-traffic/get-http-traffic-timeline-by-url.md): 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_h…
- [Get HTTP traffic timeline by IP](https://developer.upsun.com/api-reference/http-traffic/get-http-traffic-timeline-by-ip.md): 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,…
- [Get HTTP traffic timeline by user agent](https://developer.upsun.com/api-reference/http-traffic/get-http-traffic-timeline-by-user-agent.md): 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 (defau…

#### Invoices

- [List invoices](https://developer.upsun.com/api-reference/invoices/list-invoices.md): Retrieves a list of invoices for the specified organization.
- [Get invoice](https://developer.upsun.com/api-reference/invoices/get-invoice.md): Retrieves an invoice for the specified organization.

#### MFA

- [Get information about TOTP enrollment](https://developer.upsun.com/api-reference/mfa/get-information-about-totp-enrollment.md): Retrieves TOTP enrollment information.
- [Confirm TOTP enrollment](https://developer.upsun.com/api-reference/mfa/confirm-totp-enrollment.md): Confirms the given TOTP enrollment.
- [Withdraw TOTP enrollment](https://developer.upsun.com/api-reference/mfa/withdraw-totp-enrollment.md): Withdraws from the TOTP enrollment.
- [Re-create recovery codes](https://developer.upsun.com/api-reference/mfa/re-create-recovery-codes.md): Re-creates recovery codes for the MFA enrollment.
- [Get organization MFA settings](https://developer.upsun.com/api-reference/mfa/get-organization-mfa-settings.md): Retrieves MFA settings for the specified organization.
- [Enable organization MFA enforcement](https://developer.upsun.com/api-reference/mfa/enable-organization-mfa-enforcement.md): Enables MFA enforcement for the specified organization.
- [Disable organization MFA enforcement](https://developer.upsun.com/api-reference/mfa/disable-organization-mfa-enforcement.md): Disables MFA enforcement for the specified organization.
- [Send MFA reminders to organization members](https://developer.upsun.com/api-reference/mfa/send-mfa-reminders-to-organization-members.md): Sends a reminder about setting up MFA to the specified organization members.

#### Orders

- [Download an invoice.](https://developer.upsun.com/api-reference/orders/download-an-invoice.md)
- [List orders](https://developer.upsun.com/api-reference/orders/list-orders.md): Retrieves orders for the specified organization.
- [Get order](https://developer.upsun.com/api-reference/orders/get-order.md): Retrieves an order for the specified organization.
- [Create confirmation credentials for for 3D-Secure](https://developer.upsun.com/api-reference/orders/create-confirmation-credentials-for-for-3d-secure.md): Creates confirmation credentials for payments that require online authorization

#### Organization Invitations

- [List invitations to an organization](https://developer.upsun.com/api-reference/organization-invitations/list-invitations-to-an-organization.md): Returns a list of invitations to an organization.
- [Invite user to an organization by email](https://developer.upsun.com/api-reference/organization-invitations/invite-user-to-an-organization-by-email.md): Creates an invitation to an organization for a user with the specified email address.
- [Cancel a pending invitation to an organization](https://developer.upsun.com/api-reference/organization-invitations/cancel-a-pending-invitation-to-an-organization.md): Cancels the specified invitation.

#### Organization Management

- [Estimate total spend](https://developer.upsun.com/api-reference/organization-management/estimate-total-spend.md): Estimates the total spend for the specified organization.
- [Get billing alert configuration](https://developer.upsun.com/api-reference/organization-management/get-billing-alert-configuration.md): Retrieves billing alert configuration for the specified organization.
- [Update billing alert configuration](https://developer.upsun.com/api-reference/organization-management/update-billing-alert-configuration.md): Updates billing alert configuration for the specified organization.
- [Get organization prepayment information](https://developer.upsun.com/api-reference/organization-management/get-organization-prepayment-information.md): Retrieves prepayment information for the specified organization, if applicable.
- [List organization prepayment transactions](https://developer.upsun.com/api-reference/organization-management/list-organization-prepayment-transactions.md): Retrieves a list of prepayment transactions for the specified organization, if applicable.

#### Organization Members

- [List organization members](https://developer.upsun.com/api-reference/organization-members/list-organization-members.md): Accessible to organization owners and members with the "manage members" permission.
- [Create organization member](https://developer.upsun.com/api-reference/organization-members/create-organization-member.md): Creates a new organization member.
- [Get organization member](https://developer.upsun.com/api-reference/organization-members/get-organization-member.md): Retrieves the specified organization member.
- [Delete organization member](https://developer.upsun.com/api-reference/organization-members/delete-organization-member.md): Deletes the specified organization member.
- [Update organization member](https://developer.upsun.com/api-reference/organization-members/update-organization-member.md): Updates the specified organization member.

#### Organization Projects

- [List projects](https://developer.upsun.com/api-reference/organization-projects/list-projects.md): Retrieves a list of projects for the specified organization.
- [Create project](https://developer.upsun.com/api-reference/organization-projects/create-project.md): Creates a new project in the specified organization.
- [Stream provisioning progress](https://developer.upsun.com/api-reference/organization-projects/stream-provisioning-progress.md): 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.
- [Get project](https://developer.upsun.com/api-reference/organization-projects/get-project.md): Retrieves the specified project.
- [Delete project](https://developer.upsun.com/api-reference/organization-projects/delete-project.md): Deletes the specified project.
- [Update project](https://developer.upsun.com/api-reference/organization-projects/update-project.md): Updates the specified project.
- [Query project carbon emissions metrics](https://developer.upsun.com/api-reference/organization-projects/query-project-carbon-emissions-metrics.md): Queries the carbon emission data for the specified project using the supplied parameters.

#### Organizations

- [User organizations](https://developer.upsun.com/api-reference/organizations/user-organizations.md): Retrieves organizations that the specified user is a member of.
- [List organizations](https://developer.upsun.com/api-reference/organizations/list-organizations.md): Non-admin users will only see organizations they are members of.
- [Create organization](https://developer.upsun.com/api-reference/organizations/create-organization.md): Creates a new organization.
- [Get organization](https://developer.upsun.com/api-reference/organizations/get-organization.md): Retrieves the specified organization.
- [Delete organization](https://developer.upsun.com/api-reference/organizations/delete-organization.md): Deletes the specified organization.
- [Update organization](https://developer.upsun.com/api-reference/organizations/update-organization.md): Updates the specified organization.

#### PhoneNumber

- [Verify phone number](https://developer.upsun.com/api-reference/phonenumber/verify-phone-number.md): Starts a phone number verification session.
- [Confirm phone number](https://developer.upsun.com/api-reference/phonenumber/confirm-phone-number.md): Confirms phone number using a verification code.

#### Profiles

- [Get address](https://developer.upsun.com/api-reference/profiles/get-address.md): Retrieves the address for the specified organization.
- [Update address](https://developer.upsun.com/api-reference/profiles/update-address.md): Updates the address for the specified organization.
- [Get profile](https://developer.upsun.com/api-reference/profiles/get-profile.md): Retrieves the profile for the specified organization.
- [Update profile](https://developer.upsun.com/api-reference/profiles/update-profile.md): Updates the profile for the specified organization.

#### Project

- [Get a project](https://developer.upsun.com/api-reference/project/get-a-project.md): Retrieve the details of a single project.
- [Get a project's capabilities](https://developer.upsun.com/api-reference/project/get-a-projects-capabilities.md): 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.
- [Clear project build cache](https://developer.upsun.com/api-reference/project/clear-project-build-cache.md): 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/)
- [Post projects maintenance redeploy](https://developer.upsun.com/api-reference/project/post-projects-maintenance-redeploy.md)

#### Project Activity

- [Get project activity log](https://developer.upsun.com/api-reference/project-activity/get-project-activity-log.md): 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:
- [Get a project activity log entry](https://developer.upsun.com/api-reference/project-activity/get-a-project-activity-log-entry.md): 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.
- [Cancel a project activity](https://developer.upsun.com/api-reference/project-activity/cancel-a-project-activity.md): 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.

#### Project Invitations

- [List invitations to a project](https://developer.upsun.com/api-reference/project-invitations/list-invitations-to-a-project.md): Returns a list of invitations to a project.
- [Invite user to a project by email](https://developer.upsun.com/api-reference/project-invitations/invite-user-to-a-project-by-email.md): Creates an invitation to a project for a user with the specified email address.
- [Cancel a pending invitation to a project](https://developer.upsun.com/api-reference/project-invitations/cancel-a-pending-invitation-to-a-project.md): Cancels the specified invitation.

#### Project Settings

- [Get list of project settings](https://developer.upsun.com/api-reference/project-settings/get-list-of-project-settings.md): Retrieve the global settings for a project.
- [Update a project setting](https://developer.upsun.com/api-reference/project-settings/update-a-project-setting.md): Update one or more project-level settings.

#### Project Variables

- [Get list of project variables](https://developer.upsun.com/api-reference/project-variables/get-list-of-project-variables.md): Retrieve a list of objects representing the user-defined variables within a project.
- [Add a project variable](https://developer.upsun.com/api-reference/project-variables/add-a-project-variable.md): 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.
- [Get a project variable](https://developer.upsun.com/api-reference/project-variables/get-a-project-variable.md): Retrieve a single user-defined project variable.
- [Delete a project variable](https://developer.upsun.com/api-reference/project-variables/delete-a-project-variable.md): Delete a single user-defined project variable.
- [Update a project variable](https://developer.upsun.com/api-reference/project-variables/update-a-project-variable.md): 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.

#### Projects

- [List project history](https://developer.upsun.com/api-reference/projects/list-project-history.md): Retrieves history records for the specified project, oldest first.

#### Records

- [List plan records](https://developer.upsun.com/api-reference/records/list-plan-records.md): Retrieves plan records for the specified organization.
- [List usage records](https://developer.upsun.com/api-reference/records/list-usage-records.md): Retrieves usage records for the specified organization.

#### References

- [List referenced users](https://developer.upsun.com/api-reference/references/list-referenced-users.md): 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 <code>_links</code> object with a key like <code>ref:users:0</code>.
- [List referenced teams](https://developer.upsun.com/api-reference/references/list-referenced-teams.md): 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 <code>_links</code> object with a key like <code>ref:teams:0</code>.
- [List referenced organizations](https://developer.upsun.com/api-reference/references/list-referenced-organizations.md): 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 <code>_links</code> object with a key like <code>ref:organizations:0</code>.
- [List referenced projects](https://developer.upsun.com/api-reference/references/list-referenced-projects.md): 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 <code>_links</code> object with a key like <code>ref:projects:0</code>.
- [List referenced regions](https://developer.upsun.com/api-reference/references/list-referenced-regions.md): 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 <code>_links</code> object with a key like <code>ref:regions:0</code>.

#### Regions

- [List regions](https://developer.upsun.com/api-reference/regions/list-regions.md): Retrieves a list of available regions.
- [Get region](https://developer.upsun.com/api-reference/regions/get-region.md): Retrieves the specified region.

#### Repository

- [Get a blob object](https://developer.upsun.com/api-reference/repository/get-a-blob-object.md): 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. `bas…
- [Get a commit object](https://developer.upsun.com/api-reference/repository/get-a-commit-object.md): Retrieve, by hash, an object representing a commit in the repository backing a project. This endpoint functions similarly to `git cat-file -p <commit-id>`. The returned object contains the hash of the Git tree that it belongs to, as well as the ID of parent commits.
- [Get list of repository refs](https://developer.upsun.com/api-reference/repository/get-list-of-repository-refs.md): 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.
- [Get a ref object](https://developer.upsun.com/api-reference/repository/get-a-ref-object.md): Retrieve the details of a single `refs` object in the repository backing a project. This endpoint functions similarly to `git show-ref <pattern>`, although the pattern must be a full ref `id`, rather than a matching pattern.
- [Get a tree object](https://developer.upsun.com/api-reference/repository/get-a-tree-object.md): 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.

#### Resources

- [Get resource metrics overview](https://developer.upsun.com/api-reference/resources/get-resource-metrics-overview.md): 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 percent…
- [Get resource metrics summary](https://developer.upsun.com/api-reference/resources/get-resource-metrics-summary.md): 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 aggregation…
- [Get resource metrics by service](https://developer.upsun.com/api-reference/resources/get-resource-metrics-by-service.md): 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 aggr…

#### Routing

- [Get list of routes](https://developer.upsun.com/api-reference/routing/get-list-of-routes.md): 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.
- [Get a route's info](https://developer.upsun.com/api-reference/routing/get-a-routes-info.md): 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.

#### Runtime Operations

- [Execute a runtime operation](https://developer.upsun.com/api-reference/runtime-operations/execute-a-runtime-operation.md): 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 do…

#### Source Operations

- [Trigger a source operation](https://developer.upsun.com/api-reference/source-operations/trigger-a-source-operation.md): 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/).
- [List source operations](https://developer.upsun.com/api-reference/source-operations/list-source-operations.md): 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/).

#### SSH Keys

- [Get an SSH key](https://developer.upsun.com/api-reference/ssh-keys/get-an-ssh-key.md)
- [Delete an SSH key](https://developer.upsun.com/api-reference/ssh-keys/delete-an-ssh-key.md)
- [Add a new public SSH key to a user](https://developer.upsun.com/api-reference/ssh-keys/add-a-new-public-ssh-key-to-a-user.md)

#### Subscriptions

- [Checks if the user is able to update a project.](https://developer.upsun.com/api-reference/subscriptions/checks-if-the-user-is-able-to-update-a-project.md)
- [Checks if the user can afford the requested resources.](https://developer.upsun.com/api-reference/subscriptions/checks-if-the-user-can-afford-the-requested-resources.md)
- [Estimate the price of a new subscription](https://developer.upsun.com/api-reference/subscriptions/estimate-the-price-of-a-new-subscription.md)
- [Checks if the user is able to create a new project.](https://developer.upsun.com/api-reference/subscriptions/checks-if-the-user-is-able-to-create-a-new-project.md)
- [Estimate the price of a subscription](https://developer.upsun.com/api-reference/subscriptions/estimate-the-price-of-a-subscription.md)
- [Get current usage for a subscription](https://developer.upsun.com/api-reference/subscriptions/get-current-usage-for-a-subscription.md)
- [List addons for a subscription](https://developer.upsun.com/api-reference/subscriptions/list-addons-for-a-subscription.md)
- [Get usage alerts](https://developer.upsun.com/api-reference/subscriptions/get-usage-alerts.md): Retrieves current and available usage alerts.
- [Update usage alerts.](https://developer.upsun.com/api-reference/subscriptions/update-usage-alerts.md): Updates usage alerts for a subscription.
- [List subscriptions](https://developer.upsun.com/api-reference/subscriptions/list-subscriptions.md): Retrieves subscriptions for the specified organization.
- [Create subscription](https://developer.upsun.com/api-reference/subscriptions/create-subscription.md): Creates a subscription for the specified organization.
- [Get subscription](https://developer.upsun.com/api-reference/subscriptions/get-subscription.md): Retrieves a subscription for the specified organization.
- [Delete subscription](https://developer.upsun.com/api-reference/subscriptions/delete-subscription.md): Deletes a subscription for the specified organization.
- [Update subscription](https://developer.upsun.com/api-reference/subscriptions/update-subscription.md): Updates a subscription for the specified organization.

#### Support

- [Create a new support ticket](https://developer.upsun.com/api-reference/support/create-a-new-support-ticket.md)
- [Update a ticket](https://developer.upsun.com/api-reference/support/update-a-ticket.md)
- [List support ticket priorities](https://developer.upsun.com/api-reference/support/list-support-ticket-priorities.md)
- [List support ticket categories](https://developer.upsun.com/api-reference/support/list-support-ticket-categories.md)

#### System Information

- [Get information about the Git server.](https://developer.upsun.com/api-reference/system-information/get-information-about-the-git-server.md): Output information for the project.
- [Restart the Git server](https://developer.upsun.com/api-reference/system-information/restart-the-git-server.md): Force the Git server to restart.

#### Task

- [Get projects environments tasks](https://developer.upsun.com/api-reference/task/get-projects-environments-tasks.md)
- [Get projects environments tasks 1](https://developer.upsun.com/api-reference/task/get-projects-environments-tasks-1.md)
- [Post projects environments tasks run](https://developer.upsun.com/api-reference/task/post-projects-environments-tasks-run.md)

#### Team Access

- [List team access for a project](https://developer.upsun.com/api-reference/team-access/list-team-access-for-a-project.md): Returns a list of items representing the project access.
- [Grant team access to a project](https://developer.upsun.com/api-reference/team-access/grant-team-access-to-a-project.md): Grants one or more team access to a specific project.
- [Get team access for a project](https://developer.upsun.com/api-reference/team-access/get-team-access-for-a-project.md): Retrieves the team's permissions for the current project.
- [Remove team access for a project](https://developer.upsun.com/api-reference/team-access/remove-team-access-for-a-project.md): Removes the team from the current project.
- [List project access for a team](https://developer.upsun.com/api-reference/team-access/list-project-access-for-a-team.md): Returns a list of items representing the team's project access.
- [Grant project access to a team](https://developer.upsun.com/api-reference/team-access/grant-project-access-to-a-team.md): Adds the team to one or more specified projects.
- [Get project access for a team](https://developer.upsun.com/api-reference/team-access/get-project-access-for-a-team.md): Retrieves the team's permissions for the current project.
- [Remove project access for a team](https://developer.upsun.com/api-reference/team-access/remove-project-access-for-a-team.md): Removes the team from the current project.

#### Teams

- [List teams](https://developer.upsun.com/api-reference/teams/list-teams.md): Retrieves a list of teams.
- [Create team](https://developer.upsun.com/api-reference/teams/create-team.md): Creates a new team.
- [Get team](https://developer.upsun.com/api-reference/teams/get-team.md): Retrieves the specified team.
- [Delete team](https://developer.upsun.com/api-reference/teams/delete-team.md): Deletes the specified team.
- [Update team](https://developer.upsun.com/api-reference/teams/update-team.md): Updates the specified team.
- [List team members](https://developer.upsun.com/api-reference/teams/list-team-members.md): Retrieves a list of users associated with a single team.
- [Create team member](https://developer.upsun.com/api-reference/teams/create-team-member.md): Creates a new team member.
- [Get team member](https://developer.upsun.com/api-reference/teams/get-team-member.md): Retrieves the specified team member.
- [Delete team member](https://developer.upsun.com/api-reference/teams/delete-team-member.md): Deletes the specified team member.
- [User teams](https://developer.upsun.com/api-reference/teams/user-teams.md): Retrieves teams that the specified user is a member of.

#### Third-Party Integrations

- [Get list of existing integrations for a project](https://developer.upsun.com/api-reference/third-party-integrations/get-list-of-existing-integrations-for-a-project.md)
- [Integrate project with a third-party service](https://developer.upsun.com/api-reference/third-party-integrations/integrate-project-with-a-third-party-service.md)
- [Get information about an existing third-party integration](https://developer.upsun.com/api-reference/third-party-integrations/get-information-about-an-existing-third-party-integration.md)
- [Delete an existing third-party integration](https://developer.upsun.com/api-reference/third-party-integrations/delete-an-existing-third-party-integration.md)
- [Update an existing third-party integration](https://developer.upsun.com/api-reference/third-party-integrations/update-an-existing-third-party-integration.md)

#### User Access

- [List user access for a project](https://developer.upsun.com/api-reference/user-access/list-user-access-for-a-project.md): Returns a list of items representing the project access.
- [Grant user access to a project](https://developer.upsun.com/api-reference/user-access/grant-user-access-to-a-project.md): Grants one or more users access to a specific project.
- [Get user access for a project](https://developer.upsun.com/api-reference/user-access/get-user-access-for-a-project.md): Retrieves the user's permissions for the current project.
- [Remove user access for a project](https://developer.upsun.com/api-reference/user-access/remove-user-access-for-a-project.md): Removes the user from the current project.
- [Update user access for a project](https://developer.upsun.com/api-reference/user-access/update-user-access-for-a-project.md): Updates the user's permissions for the current project.
- [List project access for a user](https://developer.upsun.com/api-reference/user-access/list-project-access-for-a-user.md): Returns a list of items representing the user's project access.
- [Grant project access to a user](https://developer.upsun.com/api-reference/user-access/grant-project-access-to-a-user.md): Adds the user to one or more specified projects.
- [Get project access for a user](https://developer.upsun.com/api-reference/user-access/get-project-access-for-a-user.md): Retrieves the user's permissions for the current project.
- [Remove project access for a user](https://developer.upsun.com/api-reference/user-access/remove-project-access-for-a-user.md): Removes the user from the current project.
- [Update project access for a user](https://developer.upsun.com/api-reference/user-access/update-project-access-for-a-user.md): Updates the user's permissions for the current project.

#### User Profiles

- [List user profiles](https://developer.upsun.com/api-reference/user-profiles/list-user-profiles.md)
- [Get a single user profile](https://developer.upsun.com/api-reference/user-profiles/get-a-single-user-profile.md)
- [Update a user profile](https://developer.upsun.com/api-reference/user-profiles/update-a-user-profile.md): Update a user profile, supplying one or more key/value pairs to to change.
- [Get a user address](https://developer.upsun.com/api-reference/user-profiles/get-a-user-address.md)
- [Update a user address](https://developer.upsun.com/api-reference/user-profiles/update-a-user-address.md): Update a user address, supplying one or more key/value pairs to to change.
- [Create a user profile picture](https://developer.upsun.com/api-reference/user-profiles/create-a-user-profile-picture.md)
- [Delete a user profile picture](https://developer.upsun.com/api-reference/user-profiles/delete-a-user-profile-picture.md)

#### Users

- [Get current logged-in user info](https://developer.upsun.com/api-reference/users/get-current-logged-in-user-info.md): Retrieve information about the currently logged-in user (the user associated with the access token).
- [Check if phone verification is required](https://developer.upsun.com/api-reference/users/check-if-phone-verification-is-required.md): Find out if the current logged in user requires phone verification to create projects.
- [Check if verification is required](https://developer.upsun.com/api-reference/users/check-if-verification-is-required.md): Find out if the current logged in user requires verification (phone or staff) to create projects.
- [Get the current user](https://developer.upsun.com/api-reference/users/get-the-current-user.md): Retrieves the current user, determined from the used access token.
- [Get a user by email](https://developer.upsun.com/api-reference/users/get-a-user-by-email.md): Retrieves a user matching the specified email address.
- [Get a user by username](https://developer.upsun.com/api-reference/users/get-a-user-by-username.md): Retrieves a user matching the specified username.
- [Get a user](https://developer.upsun.com/api-reference/users/get-a-user.md): Retrieves the specified user.
- [Update a user](https://developer.upsun.com/api-reference/users/update-a-user.md): Updates the specified user.
- [Reset email address](https://developer.upsun.com/api-reference/users/reset-email-address.md): 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](https://developer.upsun.com/api-reference/users/reset-user-password.md): Requests a reset of the user's password. A password reset email will be sent to the user when the request is accepted.

#### Vouchers

- [List vouchers](https://developer.upsun.com/api-reference/vouchers/list-vouchers.md): Retrieves vouchers for the specified organization.
- [Apply voucher](https://developer.upsun.com/api-reference/vouchers/apply-voucher.md): Applies a voucher for the specified organization, and refreshes the currently open order.

## OpenAPI Specs

- [openapi-spec](https://meta.upsun.com/openapi-spec)