这是indexloc提供的服务，不要输入任何密码
Skip to content

upsun/upsun-sdk-php

BranchesTags

Repository files navigation

Caution

This project is currently in Beta, meaning features and APIs may evolve over time.

Please report bugs or request new features by creating a GitHub issue.

Upsun SDK PHP

The official Upsun SDK for PHP. This SDK provides a PHP interface that maps to the Upsun CLI commands. For more information, read the documentation.

Installation

Install the SDK via Composer:

composer require upsun/upsun-sdk-php

Then include Composer's autoloader in your PHP application:

require __DIR__ . '/vendor/autoload.php';

Authentication

You will need an Upsun API token to use this SDK. Store it securely, preferably in an environment variable.

use Upsun\UpsunConfig;
use Upsun\UpsunClient;

$config = new UpsunConfig(apiToken: getenv('UPSUN_API_TOKEN'));
$client = new UpsunClient($config);

Usage

Example: List organizations

$organizations = $client->organizations->list();

Example: List projects in an organization

$projects = $client->organizations->listProjects('<organizationId>');

Example: Get a project

$project = $client->projects->get('<projectId>');

Example: Create a project in a specific organization

$project = $client->projects->create(
    <organizationId>,
    [
        'projectTitle' => 'Project title',
        'projectRegion' => 'eu-5.platform.sh',
        'defaultBranch' => 'main',
    ]
);

Example: Update a project

$projectData = [
    'title' => 'title',
    'description' => 'description'
];
$response = $client->projects->update(<projectId>, $projectData);

Example: Delete a project

$client->projects->delete(<projectId>);

Development

Clone the repository and install dependencies:

git clone git@github.com:upsun/upsun-sdk-php.git
composer install

Architecture of this SDK

The SDK is built as follows:

Architecture of the SDK

Regenerating API & Model classes

API and Model classes are generated using openapi-generator-cli from the Upsun OpenAPI spec.

npm install @openapitools/openapi-generator-cli --save-dev
php templates/pre-processing/preprocess-schema.php
npx openapi-generator-cli generate -c templates/php/config.yaml
composer run fix
composer run rector

Contributing

Contributions are welcome!
Please open a pull request or an issue for any improvements, bug fixes, or new features.

API Endpoints

All URIs are relative to https://api.upsun.com

Class Method HTTP request Description Upsun API Doc
APITokensApi createApiToken POST /users/{user_id}/api-tokens Create an API token https://docs.upsun.com/api/#tag/API-Tokens/operation/create-api-token
APITokensApi deleteApiToken DELETE /users/{user_id}/api-tokens/{token_id} Delete an API token https://docs.upsun.com/api/#tag/API-Tokens/operation/delete-api-token
APITokensApi getApiToken GET /users/{user_id}/api-tokens/{token_id} Get an API token https://docs.upsun.com/api/#tag/API-Tokens/operation/get-api-token
APITokensApi listApiTokens GET /users/{user_id}/api-tokens List a user's API tokens https://docs.upsun.com/api/#tag/API-Tokens/operation/list-api-tokens
AddOnsApi getOrgAddons GET /organizations/{organization_id}/addons Get add-ons https://docs.upsun.com/api/#tag/Add-ons/operation/get-org-addons
AddOnsApi updateOrgAddons PATCH /organizations/{organization_id}/addons Update organization add-ons https://docs.upsun.com/api/#tag/Add-ons/operation/update-org-addons
AlertsApi getUsageAlerts GET /alerts/subscriptions/{subscriptionId}/usage Get usage alerts for a subscription https://docs.upsun.com/api/#tag/Alerts/operation/get-usage-alerts
AlertsApi updateUsageAlerts PATCH /alerts/subscriptions/{subscriptionId}/usage Update usage alerts. https://docs.upsun.com/api/#tag/Alerts/operation/update-usage-alerts
AutoscalingApi getAutoscalerSettings GET /projects/{projectId}/environments/{environmentId}/autoscaling/settings https://docs.upsun.com/api/#tag/Autoscaling/operation/get-autoscaler-settings
AutoscalingApi patchAutoscalerSettings PATCH /projects/{projectId}/environments/{environmentId}/autoscaling/settings https://docs.upsun.com/api/#tag/Autoscaling/operation/patch-autoscaler-settings
AutoscalingApi postAutoscalerAlert POST /projects/{projectId}/environments/{environmentId}/autoscaling/alerts https://docs.upsun.com/api/#tag/Autoscaling/operation/post-autoscaler-alert
AutoscalingApi postAutoscalerSettings POST /projects/{projectId}/environments/{environmentId}/autoscaling/settings https://docs.upsun.com/api/#tag/Autoscaling/operation/post-autoscaler-settings
CertManagementApi createProjectsCertificates POST /projects/{projectId}/certificates Add an SSL certificate https://docs.upsun.com/api/#tag/Cert-Management/operation/create-projects-certificates
CertManagementApi deleteProjectsCertificates DELETE /projects/{projectId}/certificates/{certificateId} Delete an SSL certificate https://docs.upsun.com/api/#tag/Cert-Management/operation/delete-projects-certificates
CertManagementApi getProjectsCertificates GET /projects/{projectId}/certificates/{certificateId} Get an SSL certificate https://docs.upsun.com/api/#tag/Cert-Management/operation/get-projects-certificates
CertManagementApi listProjectsCertificates GET /projects/{projectId}/certificates Get list of SSL certificates https://docs.upsun.com/api/#tag/Cert-Management/operation/list-projects-certificates
CertManagementApi updateProjectsCertificates PATCH /projects/{projectId}/certificates/{certificateId} Update an SSL certificate https://docs.upsun.com/api/#tag/Cert-Management/operation/update-projects-certificates
CertificateProvisionerApi getProjectsProvisioners GET /projects/{projectId}/provisioners/{certificateProvisionerDocumentId} https://docs.upsun.com/api/#tag/CertificateProvisioner/operation/get-projects-provisioners
CertificateProvisionerApi listProjectsProvisioners GET /projects/{projectId}/provisioners https://docs.upsun.com/api/#tag/CertificateProvisioner/operation/list-projects-provisioners
CertificateProvisionerApi updateProjectsProvisioners PATCH /projects/{projectId}/provisioners/{certificateProvisionerDocumentId} https://docs.upsun.com/api/#tag/CertificateProvisioner/operation/update-projects-provisioners
ConnectionsApi deleteLoginConnection DELETE /users/{user_id}/connections/{provider} Delete a federated login connection https://docs.upsun.com/api/#tag/Connections/operation/delete-login-connection
ConnectionsApi getLoginConnection GET /users/{user_id}/connections/{provider} Get a federated login connection https://docs.upsun.com/api/#tag/Connections/operation/get-login-connection
ConnectionsApi listLoginConnections GET /users/{user_id}/connections List federated login connections https://docs.upsun.com/api/#tag/Connections/operation/list-login-connections
DefaultApi listTickets GET /tickets List support tickets https://docs.upsun.com/api/#tag//operation/list-tickets
DefaultApi queryOrganiationCarbon GET /organizations/{organization_id}/metrics/carbon Query project carbon emissions metrics for an entire organization https://docs.upsun.com/api/#tag//operation/query-organiation-carbon
DeploymentApi getProjectsEnvironmentsDeployments GET /projects/{projectId}/environments/{environmentId}/deployments/{deploymentId} Get a single environment deployment https://docs.upsun.com/api/#tag/Deployment/operation/get-projects-environments-deployments
DeploymentApi listProjectsEnvironmentsDeployments GET /projects/{projectId}/environments/{environmentId}/deployments Get an environment's deployment information https://docs.upsun.com/api/#tag/Deployment/operation/list-projects-environments-deployments
DeploymentApi updateProjectsEnvironmentsDeploymentsNext PATCH /projects/{projectId}/environments/{environmentId}/deployments/next Update the next deployment https://docs.upsun.com/api/#tag/Deployment/operation/update-projects-environments-deployments-next
DeploymentTargetApi createProjectsDeployments POST /projects/{projectId}/deployments Create a project deployment target https://docs.upsun.com/api/#tag/Deployment-Target/operation/create-projects-deployments
DeploymentTargetApi deleteProjectsDeployments DELETE /projects/{projectId}/deployments/{deploymentTargetConfigurationId} Delete a single project deployment target https://docs.upsun.com/api/#tag/Deployment-Target/operation/delete-projects-deployments
DeploymentTargetApi getProjectsDeployments GET /projects/{projectId}/deployments/{deploymentTargetConfigurationId} Get a single project deployment target https://docs.upsun.com/api/#tag/Deployment-Target/operation/get-projects-deployments
DeploymentTargetApi listProjectsDeployments GET /projects/{projectId}/deployments Get project deployment target info https://docs.upsun.com/api/#tag/Deployment-Target/operation/list-projects-deployments
DeploymentTargetApi updateProjectsDeployments PATCH /projects/{projectId}/deployments/{deploymentTargetConfigurationId} Update a project deployment https://docs.upsun.com/api/#tag/Deployment-Target/operation/update-projects-deployments
DiscountsApi getDiscount GET /discounts/{id} Get an organization discount https://docs.upsun.com/api/#tag/Discounts/operation/get-discount
DiscountsApi getTypeAllowance GET /discounts/types/allowance Get the value of the First Project Incentive discount https://docs.upsun.com/api/#tag/Discounts/operation/get-type-allowance
DiscountsApi listOrgDiscounts GET /organizations/{organization_id}/discounts List organization discounts https://docs.upsun.com/api/#tag/Discounts/operation/list-org-discounts
DomainManagementApi createProjectsDomains POST /projects/{projectId}/domains Add a project domain https://docs.upsun.com/api/#tag/Domain-Management/operation/create-projects-domains
DomainManagementApi createProjectsEnvironmentsDomains POST /projects/{projectId}/environments/{environmentId}/domains Add an environment domain https://docs.upsun.com/api/#tag/Domain-Management/operation/create-projects-environments-domains
DomainManagementApi deleteProjectsDomains DELETE /projects/{projectId}/domains/{domainId} Delete a project domain https://docs.upsun.com/api/#tag/Domain-Management/operation/delete-projects-domains
DomainManagementApi deleteProjectsEnvironmentsDomains DELETE /projects/{projectId}/environments/{environmentId}/domains/{domainId} Delete an environment domain https://docs.upsun.com/api/#tag/Domain-Management/operation/delete-projects-environments-domains
DomainManagementApi getProjectsDomains GET /projects/{projectId}/domains/{domainId} Get a project domain https://docs.upsun.com/api/#tag/Domain-Management/operation/get-projects-domains
DomainManagementApi getProjectsEnvironmentsDomains GET /projects/{projectId}/environments/{environmentId}/domains/{domainId} Get an environment domain https://docs.upsun.com/api/#tag/Domain-Management/operation/get-projects-environments-domains
DomainManagementApi listProjectsDomains GET /projects/{projectId}/domains Get list of project domains https://docs.upsun.com/api/#tag/Domain-Management/operation/list-projects-domains
DomainManagementApi listProjectsEnvironmentsDomains GET /projects/{projectId}/environments/{environmentId}/domains Get a list of environment domains https://docs.upsun.com/api/#tag/Domain-Management/operation/list-projects-environments-domains
DomainManagementApi updateProjectsDomains PATCH /projects/{projectId}/domains/{domainId} Update a project domain https://docs.upsun.com/api/#tag/Domain-Management/operation/update-projects-domains
DomainManagementApi updateProjectsEnvironmentsDomains PATCH /projects/{projectId}/environments/{environmentId}/domains/{domainId} Update an environment domain https://docs.upsun.com/api/#tag/Domain-Management/operation/update-projects-environments-domains
EnvironmentApi activateEnvironment POST /projects/{projectId}/environments/{environmentId}/activate Activate an environment https://docs.upsun.com/api/#tag/Environment/operation/activate-environment
EnvironmentApi branchEnvironment POST /projects/{projectId}/environments/{environmentId}/branch Branch an environment https://docs.upsun.com/api/#tag/Environment/operation/branch-environment
EnvironmentApi createProjectsEnvironmentsVersions POST /projects/{projectId}/environments/{environmentId}/versions Create versions associated with the environment https://docs.upsun.com/api/#tag/Environment/operation/create-projects-environments-versions
EnvironmentApi deactivateEnvironment POST /projects/{projectId}/environments/{environmentId}/deactivate Deactivate an environment https://docs.upsun.com/api/#tag/Environment/operation/deactivate-environment
EnvironmentApi deleteEnvironment DELETE /projects/{projectId}/environments/{environmentId} Delete an environment https://docs.upsun.com/api/#tag/Environment/operation/delete-environment
EnvironmentApi deleteProjectsEnvironmentsVersions DELETE /projects/{projectId}/environments/{environmentId}/versions/{versionId} Delete the version https://docs.upsun.com/api/#tag/Environment/operation/delete-projects-environments-versions
EnvironmentApi deployEnvironment POST /projects/{projectId}/environments/{environmentId}/deploy Deploy an environment https://docs.upsun.com/api/#tag/Environment/operation/deploy-environment
EnvironmentApi getEnvironment GET /projects/{projectId}/environments/{environmentId} Get an environment https://docs.upsun.com/api/#tag/Environment/operation/get-environment
EnvironmentApi getProjectsEnvironmentsVersions GET /projects/{projectId}/environments/{environmentId}/versions/{versionId} List the version https://docs.upsun.com/api/#tag/Environment/operation/get-projects-environments-versions
EnvironmentApi initializeEnvironment POST /projects/{projectId}/environments/{environmentId}/initialize Initialize a new environment https://docs.upsun.com/api/#tag/Environment/operation/initialize-environment
EnvironmentApi listProjectsEnvironments GET /projects/{projectId}/environments Get list of project environments https://docs.upsun.com/api/#tag/Environment/operation/list-projects-environments
EnvironmentApi listProjectsEnvironmentsVersions GET /projects/{projectId}/environments/{environmentId}/versions List versions associated with the environment https://docs.upsun.com/api/#tag/Environment/operation/list-projects-environments-versions
EnvironmentApi mergeEnvironment POST /projects/{projectId}/environments/{environmentId}/merge Merge an environment https://docs.upsun.com/api/#tag/Environment/operation/merge-environment
EnvironmentApi pauseEnvironment POST /projects/{projectId}/environments/{environmentId}/pause Pause an environment https://docs.upsun.com/api/#tag/Environment/operation/pause-environment
EnvironmentApi redeployEnvironment POST /projects/{projectId}/environments/{environmentId}/redeploy Redeploy an environment https://docs.upsun.com/api/#tag/Environment/operation/redeploy-environment
EnvironmentApi resumeEnvironment POST /projects/{projectId}/environments/{environmentId}/resume Resume a paused environment https://docs.upsun.com/api/#tag/Environment/operation/resume-environment
EnvironmentApi synchronizeEnvironment POST /projects/{projectId}/environments/{environmentId}/synchronize Synchronize a child environment with its parent https://docs.upsun.com/api/#tag/Environment/operation/synchronize-environment
EnvironmentApi updateEnvironment PATCH /projects/{projectId}/environments/{environmentId} Update an environment https://docs.upsun.com/api/#tag/Environment/operation/update-environment
EnvironmentApi updateProjectsEnvironmentsVersions PATCH /projects/{projectId}/environments/{environmentId}/versions/{versionId} Update the version https://docs.upsun.com/api/#tag/Environment/operation/update-projects-environments-versions
EnvironmentActivityApi actionProjectsEnvironmentsActivitiesCancel POST /projects/{projectId}/environments/{environmentId}/activities/{activityId}/cancel Cancel an environment activity https://docs.upsun.com/api/#tag/Environment-Activity/operation/action-projects-environments-activities-cancel
EnvironmentActivityApi getProjectsEnvironmentsActivities GET /projects/{projectId}/environments/{environmentId}/activities/{activityId} Get an environment activity log entry https://docs.upsun.com/api/#tag/Environment-Activity/operation/get-projects-environments-activities
EnvironmentActivityApi listProjectsEnvironmentsActivities GET /projects/{projectId}/environments/{environmentId}/activities Get environment activity log https://docs.upsun.com/api/#tag/Environment-Activity/operation/list-projects-environments-activities
EnvironmentBackupsApi backupEnvironment POST /projects/{projectId}/environments/{environmentId}/backup Create backup of environment https://docs.upsun.com/api/#tag/Environment-Backups/operation/backup-environment
EnvironmentBackupsApi deleteProjectsEnvironmentsBackups DELETE /projects/{projectId}/environments/{environmentId}/backups/{backupId} Delete an environment backup https://docs.upsun.com/api/#tag/Environment-Backups/operation/delete-projects-environments-backups
EnvironmentBackupsApi getProjectsEnvironmentsBackups GET /projects/{projectId}/environments/{environmentId}/backups/{backupId} Get an environment backup's info https://docs.upsun.com/api/#tag/Environment-Backups/operation/get-projects-environments-backups
EnvironmentBackupsApi listProjectsEnvironmentsBackups GET /projects/{projectId}/environments/{environmentId}/backups Get an environment's backup list https://docs.upsun.com/api/#tag/Environment-Backups/operation/list-projects-environments-backups
EnvironmentBackupsApi restoreBackup POST /projects/{projectId}/environments/{environmentId}/backups/{backupId}/restore Restore an environment snapshot https://docs.upsun.com/api/#tag/Environment-Backups/operation/restore-backup
EnvironmentTypeApi getEnvironmentType GET /projects/{projectId}/environment-types/{environmentTypeId} Get environment type links https://docs.upsun.com/api/#tag/Environment-Type/operation/get-environment-type
EnvironmentTypeApi listProjectsEnvironmentTypes GET /projects/{projectId}/environment-types Get environment types https://docs.upsun.com/api/#tag/Environment-Type/operation/list-projects-environment-types
EnvironmentVariablesApi createProjectsEnvironmentsVariables POST /projects/{projectId}/environments/{environmentId}/variables Add an environment variable https://docs.upsun.com/api/#tag/Environment-Variables/operation/create-projects-environments-variables
EnvironmentVariablesApi deleteProjectsEnvironmentsVariables DELETE /projects/{projectId}/environments/{environmentId}/variables/{variableId} Delete an environment variable https://docs.upsun.com/api/#tag/Environment-Variables/operation/delete-projects-environments-variables
EnvironmentVariablesApi getProjectsEnvironmentsVariables GET /projects/{projectId}/environments/{environmentId}/variables/{variableId} Get an environment variable https://docs.upsun.com/api/#tag/Environment-Variables/operation/get-projects-environments-variables
EnvironmentVariablesApi listProjectsEnvironmentsVariables GET /projects/{projectId}/environments/{environmentId}/variables Get list of environment variables https://docs.upsun.com/api/#tag/Environment-Variables/operation/list-projects-environments-variables
EnvironmentVariablesApi updateProjectsEnvironmentsVariables PATCH /projects/{projectId}/environments/{environmentId}/variables/{variableId} Update an environment variable https://docs.upsun.com/api/#tag/Environment-Variables/operation/update-projects-environments-variables
GrantsApi listUserExtendedAccess GET /users/{user_id}/extended-access List extended access of a user https://docs.upsun.com/api/#tag/Grants/operation/list-user-extended-access
InvoicesApi getOrgInvoice GET /organizations/{organization_id}/invoices/{invoice_id} Get invoice https://docs.upsun.com/api/#tag/Invoices/operation/get-org-invoice
InvoicesApi listOrgInvoices GET /organizations/{organization_id}/invoices List invoices https://docs.upsun.com/api/#tag/Invoices/operation/list-org-invoices
MFAApi confirmTotpEnrollment POST /users/{user_id}/totp Confirm TOTP enrollment https://docs.upsun.com/api/#tag/MFA/operation/confirm-totp-enrollment
MFAApi disableOrgMfaEnforcement POST /organizations/{organization_id}/mfa-enforcement/disable Disable organization MFA enforcement https://docs.upsun.com/api/#tag/MFA/operation/disable-org-mfa-enforcement
MFAApi enableOrgMfaEnforcement POST /organizations/{organization_id}/mfa-enforcement/enable Enable organization MFA enforcement https://docs.upsun.com/api/#tag/MFA/operation/enable-org-mfa-enforcement
MFAApi getOrgMfaEnforcement GET /organizations/{organization_id}/mfa-enforcement Get organization MFA settings https://docs.upsun.com/api/#tag/MFA/operation/get-org-mfa-enforcement
MFAApi getTotpEnrollment GET /users/{user_id}/totp Get information about TOTP enrollment https://docs.upsun.com/api/#tag/MFA/operation/get-totp-enrollment
MFAApi recreateRecoveryCodes POST /users/{user_id}/codes Re-create recovery codes https://docs.upsun.com/api/#tag/MFA/operation/recreate-recovery-codes
MFAApi sendOrgMfaReminders POST /organizations/{organization_id}/mfa/remind Send MFA reminders to organization members https://docs.upsun.com/api/#tag/MFA/operation/send-org-mfa-reminders
MFAApi withdrawTotpEnrollment DELETE /users/{user_id}/totp Withdraw TOTP enrollment https://docs.upsun.com/api/#tag/MFA/operation/withdraw-totp-enrollment
OrdersApi createAuthorizationCredentials POST /organizations/{organization_id}/orders/{order_id}/authorize Create confirmation credentials for for 3D-Secure https://docs.upsun.com/api/#tag/Orders/operation/create-authorization-credentials
OrdersApi downloadInvoice GET /orders/download Download an invoice. https://docs.upsun.com/api/#tag/Orders/operation/download-invoice
OrdersApi getOrgOrder GET /organizations/{organization_id}/orders/{order_id} Get order https://docs.upsun.com/api/#tag/Orders/operation/get-org-order
OrdersApi listOrgOrders GET /organizations/{organization_id}/orders List orders https://docs.upsun.com/api/#tag/Orders/operation/list-org-orders
OrganizationInvitationsApi cancelOrgInvite DELETE /organizations/{organization_id}/invitations/{invitation_id} Cancel a pending invitation to an organization https://docs.upsun.com/api/#tag/Organization-Invitations/operation/cancel-org-invite
OrganizationInvitationsApi createOrgInvite POST /organizations/{organization_id}/invitations Invite user to an organization by email https://docs.upsun.com/api/#tag/Organization-Invitations/operation/create-org-invite
OrganizationInvitationsApi listOrgInvites GET /organizations/{organization_id}/invitations List invitations to an organization https://docs.upsun.com/api/#tag/Organization-Invitations/operation/list-org-invites
OrganizationManagementApi estimateOrg GET /organizations/{organization_id}/estimate Estimate total spend https://docs.upsun.com/api/#tag/Organization-Management/operation/estimate-org
OrganizationManagementApi getOrgBillingAlertConfig GET /organizations/{organization_id}/alerts/billing Get billing alert configuration https://docs.upsun.com/api/#tag/Organization-Management/operation/get-org-billing-alert-config
OrganizationManagementApi getOrgPrepaymentInfo GET /organizations/{organization_id}/prepayment Get organization prepayment information https://docs.upsun.com/api/#tag/Organization-Management/operation/get-org-prepayment-info
OrganizationManagementApi listOrgPrepaymentTransactions GET /organizations/{organization_id}/prepayment/transactions List organization prepayment transactions https://docs.upsun.com/api/#tag/Organization-Management/operation/list-org-prepayment-transactions
OrganizationManagementApi updateOrgBillingAlertConfig PATCH /organizations/{organization_id}/alerts/billing Update billing alert configuration https://docs.upsun.com/api/#tag/Organization-Management/operation/update-org-billing-alert-config
OrganizationMembersApi createOrgMember POST /organizations/{organization_id}/members Create organization member https://docs.upsun.com/api/#tag/Organization-Members/operation/create-org-member
OrganizationMembersApi deleteOrgMember DELETE /organizations/{organization_id}/members/{user_id} Delete organization member https://docs.upsun.com/api/#tag/Organization-Members/operation/delete-org-member
OrganizationMembersApi getOrgMember GET /organizations/{organization_id}/members/{user_id} Get organization member https://docs.upsun.com/api/#tag/Organization-Members/operation/get-org-member
OrganizationMembersApi listOrgMembers GET /organizations/{organization_id}/members List organization members https://docs.upsun.com/api/#tag/Organization-Members/operation/list-org-members
OrganizationMembersApi updateOrgMember PATCH /organizations/{organization_id}/members/{user_id} Update organization member https://docs.upsun.com/api/#tag/Organization-Members/operation/update-org-member
OrganizationProjectsApi createOrgProject POST /organizations/{organization_id}/projects Create project https://docs.upsun.com/api/#tag/Organization-Projects/operation/create-org-project
OrganizationProjectsApi deleteOrgProject DELETE /organizations/{organization_id}/projects/{project_id} Delete project https://docs.upsun.com/api/#tag/Organization-Projects/operation/delete-org-project
OrganizationProjectsApi getOrgProject GET /organizations/{organization_id}/projects/{project_id} Get project https://docs.upsun.com/api/#tag/Organization-Projects/operation/get-org-project
OrganizationProjectsApi listOrgProjects GET /organizations/{organization_id}/projects List projects https://docs.upsun.com/api/#tag/Organization-Projects/operation/list-org-projects
OrganizationProjectsApi queryProjectCarbon GET /organizations/{organization_id}/projects/{project_id}/metrics/carbon Query project carbon emissions metrics https://docs.upsun.com/api/#tag/Organization-Projects/operation/query-project-carbon
OrganizationProjectsApi updateOrgProject PATCH /organizations/{organization_id}/projects/{project_id} Update project https://docs.upsun.com/api/#tag/Organization-Projects/operation/update-org-project
OrganizationsApi createOrg POST /organizations Create organization https://docs.upsun.com/api/#tag/Organizations/operation/create-org
OrganizationsApi deleteOrg DELETE /organizations/{organization_id} Delete organization https://docs.upsun.com/api/#tag/Organizations/operation/delete-org
OrganizationsApi getOrg GET /organizations/{organization_id} Get organization https://docs.upsun.com/api/#tag/Organizations/operation/get-org
OrganizationsApi listOrgs GET /organizations List organizations https://docs.upsun.com/api/#tag/Organizations/operation/list-orgs
OrganizationsApi listUserOrgs GET /users/{user_id}/organizations User organizations https://docs.upsun.com/api/#tag/Organizations/operation/list-user-orgs
OrganizationsApi updateOrg PATCH /organizations/{organization_id} Update organization https://docs.upsun.com/api/#tag/Organizations/operation/update-org
PhoneNumberApi confirmPhoneNumber POST /users/{user_id}/phonenumber/{sid} Confirm phone number https://docs.upsun.com/api/#tag/PhoneNumber/operation/confirm-phone-number
PhoneNumberApi verifyPhoneNumber POST /users/{user_id}/phonenumber Verify phone number https://docs.upsun.com/api/#tag/PhoneNumber/operation/verify-phone-number
PlansApi listPlans GET /plans List available plans https://docs.upsun.com/api/#tag/Plans/operation/list-plans
ProfilesApi getOrgAddress GET /organizations/{organization_id}/address Get address https://docs.upsun.com/api/#tag/Profiles/operation/get-org-address
ProfilesApi getOrgProfile GET /organizations/{organization_id}/profile Get profile https://docs.upsun.com/api/#tag/Profiles/operation/get-org-profile
ProfilesApi updateOrgAddress PATCH /organizations/{organization_id}/address Update address https://docs.upsun.com/api/#tag/Profiles/operation/update-org-address
ProfilesApi updateOrgProfile PATCH /organizations/{organization_id}/profile Update profile https://docs.upsun.com/api/#tag/Profiles/operation/update-org-profile
ProjectApi actionProjectsClearBuildCache POST /projects/{projectId}/clear_build_cache Clear project build cache https://docs.upsun.com/api/#tag/Project/operation/action-projects-clear-build-cache
ProjectApi getProjects GET /projects/{projectId} Get a project https://docs.upsun.com/api/#tag/Project/operation/get-projects
ProjectApi getProjectsCapabilities GET /projects/{projectId}/capabilities Get a project's capabilities https://docs.upsun.com/api/#tag/Project/operation/get-projects-capabilities
ProjectApi updateProjects PATCH /projects/{projectId} Update a project https://docs.upsun.com/api/#tag/Project/operation/update-projects
ProjectActivityApi actionProjectsActivitiesCancel POST /projects/{projectId}/activities/{activityId}/cancel Cancel a project activity https://docs.upsun.com/api/#tag/Project-Activity/operation/action-projects-activities-cancel
ProjectActivityApi getProjectsActivities GET /projects/{projectId}/activities/{activityId} Get a project activity log entry https://docs.upsun.com/api/#tag/Project-Activity/operation/get-projects-activities
ProjectActivityApi listProjectsActivities GET /projects/{projectId}/activities Get project activity log https://docs.upsun.com/api/#tag/Project-Activity/operation/list-projects-activities
ProjectInvitationsApi cancelProjectInvite DELETE /projects/{project_id}/invitations/{invitation_id} Cancel a pending invitation to a project https://docs.upsun.com/api/#tag/Project-Invitations/operation/cancel-project-invite
ProjectInvitationsApi createProjectInvite POST /projects/{project_id}/invitations Invite user to a project by email https://docs.upsun.com/api/#tag/Project-Invitations/operation/create-project-invite
ProjectInvitationsApi listProjectInvites GET /projects/{project_id}/invitations List invitations to a project https://docs.upsun.com/api/#tag/Project-Invitations/operation/list-project-invites
ProjectSettingsApi getProjectsSettings GET /projects/{projectId}/settings Get list of project settings https://docs.upsun.com/api/#tag/Project-Settings/operation/get-projects-settings
ProjectSettingsApi updateProjectsSettings PATCH /projects/{projectId}/settings Update a project setting https://docs.upsun.com/api/#tag/Project-Settings/operation/update-projects-settings
ProjectVariablesApi createProjectsVariables POST /projects/{projectId}/variables Add a project variable https://docs.upsun.com/api/#tag/Project-Variables/operation/create-projects-variables
ProjectVariablesApi deleteProjectsVariables DELETE /projects/{projectId}/variables/{projectVariableId} Delete a project variable https://docs.upsun.com/api/#tag/Project-Variables/operation/delete-projects-variables
ProjectVariablesApi getProjectsVariables GET /projects/{projectId}/variables/{projectVariableId} Get a project variable https://docs.upsun.com/api/#tag/Project-Variables/operation/get-projects-variables
ProjectVariablesApi listProjectsVariables GET /projects/{projectId}/variables Get list of project variables https://docs.upsun.com/api/#tag/Project-Variables/operation/list-projects-variables
ProjectVariablesApi updateProjectsVariables PATCH /projects/{projectId}/variables/{projectVariableId} Update a project variable https://docs.upsun.com/api/#tag/Project-Variables/operation/update-projects-variables
RecordsApi listOrgPlanRecords GET /organizations/{organization_id}/records/plan List plan records https://docs.upsun.com/api/#tag/Records/operation/list-org-plan-records
RecordsApi listOrgUsageRecords GET /organizations/{organization_id}/records/usage List usage records https://docs.upsun.com/api/#tag/Records/operation/list-org-usage-records
ReferencesApi listReferencedOrgs GET /ref/organizations List referenced organizations https://docs.upsun.com/api/#tag/References/operation/list-referenced-orgs
ReferencesApi listReferencedProjects GET /ref/projects List referenced projects https://docs.upsun.com/api/#tag/References/operation/list-referenced-projects
ReferencesApi listReferencedRegions GET /ref/regions List referenced regions https://docs.upsun.com/api/#tag/References/operation/list-referenced-regions
ReferencesApi listReferencedTeams GET /ref/teams List referenced teams https://docs.upsun.com/api/#tag/References/operation/list-referenced-teams
ReferencesApi listReferencedUsers GET /ref/users List referenced users https://docs.upsun.com/api/#tag/References/operation/list-referenced-users
RegionsApi getRegion GET /regions/{region_id} Get region https://docs.upsun.com/api/#tag/Regions/operation/get-region
RegionsApi listRegions GET /regions List regions https://docs.upsun.com/api/#tag/Regions/operation/list-regions
RepositoryApi getProjectsGitBlobs GET /projects/{projectId}/git/blobs/{repositoryBlobId} Get a blob object https://docs.upsun.com/api/#tag/Repository/operation/get-projects-git-blobs
RepositoryApi getProjectsGitCommits GET /projects/{projectId}/git/commits/{repositoryCommitId} Get a commit object https://docs.upsun.com/api/#tag/Repository/operation/get-projects-git-commits
RepositoryApi getProjectsGitRefs GET /projects/{projectId}/git/refs/{repositoryRefId} Get a ref object https://docs.upsun.com/api/#tag/Repository/operation/get-projects-git-refs
RepositoryApi getProjectsGitTrees GET /projects/{projectId}/git/trees/{repositoryTreeId} Get a tree object https://docs.upsun.com/api/#tag/Repository/operation/get-projects-git-trees
RepositoryApi listProjectsGitRefs GET /projects/{projectId}/git/refs Get list of repository refs https://docs.upsun.com/api/#tag/Repository/operation/list-projects-git-refs
RoutingApi getProjectsEnvironmentsRoutes GET /projects/{projectId}/environments/{environmentId}/routes/{routeId} Get a route's info https://docs.upsun.com/api/#tag/Routing/operation/get-projects-environments-routes
RoutingApi listProjectsEnvironmentsRoutes GET /projects/{projectId}/environments/{environmentId}/routes Get list of routes https://docs.upsun.com/api/#tag/Routing/operation/list-projects-environments-routes
RuntimeOperationsApi runOperation POST /projects/{projectId}/environments/{environmentId}/deployments/{deploymentId}/operations Execute a runtime operation https://docs.upsun.com/api/#tag/Runtime-Operations/operation/run-operation
SSHKeysApi createSshKey POST /ssh_keys Add a new public SSH key to a user https://docs.upsun.com/api/#tag/SSH-Keys/operation/create-ssh-key
SSHKeysApi deleteSshKey DELETE /ssh_keys/{key_id} Delete an SSH key https://docs.upsun.com/api/#tag/SSH-Keys/operation/delete-ssh-key
SSHKeysApi getSshKey GET /ssh_keys/{key_id} Get an SSH key https://docs.upsun.com/api/#tag/SSH-Keys/operation/get-ssh-key
SourceOperationsApi listProjectsEnvironmentsSourceOperations GET /projects/{projectId}/environments/{environmentId}/source-operations List source operations https://docs.upsun.com/api/#tag/Source-Operations/operation/list-projects-environments-source-operations
SourceOperationsApi runSourceOperation POST /projects/{projectId}/environments/{environmentId}/source-operation Trigger a source operation https://docs.upsun.com/api/#tag/Source-Operations/operation/run-source-operation
SubscriptionsApi canCreateNewOrgSubscription GET /organizations/{organization_id}/subscriptions/can-create Checks if the user is able to create a new project. https://docs.upsun.com/api/#tag/Subscriptions/operation/can-create-new-org-subscription
SubscriptionsApi canUpdateSubscription GET /subscriptions/{subscriptionId}/can-update Checks if the user is able to update a project. https://docs.upsun.com/api/#tag/Subscriptions/operation/can-update-subscription
SubscriptionsApi createOrgSubscription POST /organizations/{organization_id}/subscriptions Create subscription https://docs.upsun.com/api/#tag/Subscriptions/operation/create-org-subscription
SubscriptionsApi deleteOrgSubscription DELETE /organizations/{organization_id}/subscriptions/{subscription_id} Delete subscription https://docs.upsun.com/api/#tag/Subscriptions/operation/delete-org-subscription
SubscriptionsApi estimateNewOrgSubscription GET /organizations/{organization_id}/subscriptions/estimate Estimate the price of a new subscription https://docs.upsun.com/api/#tag/Subscriptions/operation/estimate-new-org-subscription
SubscriptionsApi estimateOrgSubscription GET /organizations/{organization_id}/subscriptions/{subscription_id}/estimate Estimate the price of a subscription https://docs.upsun.com/api/#tag/Subscriptions/operation/estimate-org-subscription
SubscriptionsApi getOrgSubscription GET /organizations/{organization_id}/subscriptions/{subscription_id} Get subscription https://docs.upsun.com/api/#tag/Subscriptions/operation/get-org-subscription
SubscriptionsApi getOrgSubscriptionCurrentUsage GET /organizations/{organization_id}/subscriptions/{subscription_id}/current_usage Get current usage for a subscription https://docs.upsun.com/api/#tag/Subscriptions/operation/get-org-subscription-current-usage
SubscriptionsApi getSubscriptionUsageAlerts GET /organizations/{organization_id}/alerts/subscriptions/{subscription_id}/usage Get usage alerts https://docs.upsun.com/api/#tag/Subscriptions/operation/get-subscription-usage-alerts
SubscriptionsApi listOrgSubscriptions GET /organizations/{organization_id}/subscriptions List subscriptions https://docs.upsun.com/api/#tag/Subscriptions/operation/list-org-subscriptions
SubscriptionsApi listSubscriptionAddons GET /organizations/{organization_id}/subscriptions/{subscription_id}/addons List addons for a subscription https://docs.upsun.com/api/#tag/Subscriptions/operation/list-subscription-addons
SubscriptionsApi updateOrgSubscription PATCH /organizations/{organization_id}/subscriptions/{subscription_id} Update subscription https://docs.upsun.com/api/#tag/Subscriptions/operation/update-org-subscription
SubscriptionsApi updateSubscriptionUsageAlerts PATCH /organizations/{organization_id}/alerts/subscriptions/{subscription_id}/usage Update usage alerts. https://docs.upsun.com/api/#tag/Subscriptions/operation/update-subscription-usage-alerts
SupportApi createTicket POST /tickets Create a new support ticket https://docs.upsun.com/api/#tag/Support/operation/create-ticket
SupportApi listTicketCategories GET /tickets/category List support ticket categories https://docs.upsun.com/api/#tag/Support/operation/list-ticket-categories
SupportApi listTicketPriorities GET /tickets/priority List support ticket priorities https://docs.upsun.com/api/#tag/Support/operation/list-ticket-priorities
SupportApi updateTicket PATCH /tickets/{ticket_id} Update a ticket https://docs.upsun.com/api/#tag/Support/operation/update-ticket
SystemInformationApi actionProjectsSystemRestart POST /projects/{projectId}/system/restart Restart the Git server https://docs.upsun.com/api/#tag/System-Information/operation/action-projects-system-restart
SystemInformationApi getProjectsSystem GET /projects/{projectId}/system Get information about the Git server. https://docs.upsun.com/api/#tag/System-Information/operation/get-projects-system
TeamAccessApi getProjectTeamAccess GET /projects/{project_id}/team-access/{team_id} Get team access for a project https://docs.upsun.com/api/#tag/Team-Access/operation/get-project-team-access
TeamAccessApi getTeamProjectAccess GET /teams/{team_id}/project-access/{project_id} Get project access for a team https://docs.upsun.com/api/#tag/Team-Access/operation/get-team-project-access
TeamAccessApi grantProjectTeamAccess POST /projects/{project_id}/team-access Grant team access to a project https://docs.upsun.com/api/#tag/Team-Access/operation/grant-project-team-access
TeamAccessApi grantTeamProjectAccess POST /teams/{team_id}/project-access Grant project access to a team https://docs.upsun.com/api/#tag/Team-Access/operation/grant-team-project-access
TeamAccessApi listProjectTeamAccess GET /projects/{project_id}/team-access List team access for a project https://docs.upsun.com/api/#tag/Team-Access/operation/list-project-team-access
TeamAccessApi listTeamProjectAccess GET /teams/{team_id}/project-access List project access for a team https://docs.upsun.com/api/#tag/Team-Access/operation/list-team-project-access
TeamAccessApi removeProjectTeamAccess DELETE /projects/{project_id}/team-access/{team_id} Remove team access for a project https://docs.upsun.com/api/#tag/Team-Access/operation/remove-project-team-access
TeamAccessApi removeTeamProjectAccess DELETE /teams/{team_id}/project-access/{project_id} Remove project access for a team https://docs.upsun.com/api/#tag/Team-Access/operation/remove-team-project-access
TeamsApi createTeam POST /teams Create team https://docs.upsun.com/api/#tag/Teams/operation/create-team
TeamsApi createTeamMember POST /teams/{team_id}/members Create team member https://docs.upsun.com/api/#tag/Teams/operation/create-team-member
TeamsApi deleteTeam DELETE /teams/{team_id} Delete team https://docs.upsun.com/api/#tag/Teams/operation/delete-team
TeamsApi deleteTeamMember DELETE /teams/{team_id}/members/{user_id} Delete team member https://docs.upsun.com/api/#tag/Teams/operation/delete-team-member
TeamsApi getTeam GET /teams/{team_id} Get team https://docs.upsun.com/api/#tag/Teams/operation/get-team
TeamsApi getTeamMember GET /teams/{team_id}/members/{user_id} Get team member https://docs.upsun.com/api/#tag/Teams/operation/get-team-member
TeamsApi listTeamMembers GET /teams/{team_id}/members List team members https://docs.upsun.com/api/#tag/Teams/operation/list-team-members
TeamsApi listTeams GET /teams List teams https://docs.upsun.com/api/#tag/Teams/operation/list-teams
TeamsApi listUserTeams GET /users/{user_id}/teams User teams https://docs.upsun.com/api/#tag/Teams/operation/list-user-teams
TeamsApi updateTeam PATCH /teams/{team_id} Update team https://docs.upsun.com/api/#tag/Teams/operation/update-team
ThirdPartyIntegrationsApi createProjectsIntegrations POST /projects/{projectId}/integrations Integrate project with a third-party service https://docs.upsun.com/api/#tag/Third-Party-Integrations/operation/create-projects-integrations
ThirdPartyIntegrationsApi deleteProjectsIntegrations DELETE /projects/{projectId}/integrations/{integrationId} Delete an existing third-party integration https://docs.upsun.com/api/#tag/Third-Party-Integrations/operation/delete-projects-integrations
ThirdPartyIntegrationsApi getProjectsIntegrations GET /projects/{projectId}/integrations/{integrationId} Get information about an existing third-party integration https://docs.upsun.com/api/#tag/Third-Party-Integrations/operation/get-projects-integrations
ThirdPartyIntegrationsApi listProjectsIntegrations GET /projects/{projectId}/integrations Get list of existing integrations for a project https://docs.upsun.com/api/#tag/Third-Party-Integrations/operation/list-projects-integrations
ThirdPartyIntegrationsApi updateProjectsIntegrations PATCH /projects/{projectId}/integrations/{integrationId} Update an existing third-party integration https://docs.upsun.com/api/#tag/Third-Party-Integrations/operation/update-projects-integrations
UserAccessApi getProjectUserAccess GET /projects/{project_id}/user-access/{user_id} Get user access for a project https://docs.upsun.com/api/#tag/User-Access/operation/get-project-user-access
UserAccessApi getUserProjectAccess GET /users/{user_id}/project-access/{project_id} Get project access for a user https://docs.upsun.com/api/#tag/User-Access/operation/get-user-project-access
UserAccessApi grantProjectUserAccess POST /projects/{project_id}/user-access Grant user access to a project https://docs.upsun.com/api/#tag/User-Access/operation/grant-project-user-access
UserAccessApi grantUserProjectAccess POST /users/{user_id}/project-access Grant project access to a user https://docs.upsun.com/api/#tag/User-Access/operation/grant-user-project-access
UserAccessApi listProjectUserAccess GET /projects/{project_id}/user-access List user access for a project https://docs.upsun.com/api/#tag/User-Access/operation/list-project-user-access
UserAccessApi listUserProjectAccess GET /users/{user_id}/project-access List project access for a user https://docs.upsun.com/api/#tag/User-Access/operation/list-user-project-access
UserAccessApi removeProjectUserAccess DELETE /projects/{project_id}/user-access/{user_id} Remove user access for a project https://docs.upsun.com/api/#tag/User-Access/operation/remove-project-user-access
UserAccessApi removeUserProjectAccess DELETE /users/{user_id}/project-access/{project_id} Remove project access for a user https://docs.upsun.com/api/#tag/User-Access/operation/remove-user-project-access
UserAccessApi updateProjectUserAccess PATCH /projects/{project_id}/user-access/{user_id} Update user access for a project https://docs.upsun.com/api/#tag/User-Access/operation/update-project-user-access
UserAccessApi updateUserProjectAccess PATCH /users/{user_id}/project-access/{project_id} Update project access for a user https://docs.upsun.com/api/#tag/User-Access/operation/update-user-project-access
UserProfilesApi createProfilePicture POST /profile/{uuid}/picture Create a user profile picture https://docs.upsun.com/api/#tag/User-Profiles/operation/create-profile-picture
UserProfilesApi deleteProfilePicture DELETE /profile/{uuid}/picture Delete a user profile picture https://docs.upsun.com/api/#tag/User-Profiles/operation/delete-profile-picture
UserProfilesApi getAddress GET /profiles/{userId}/address Get a user address https://docs.upsun.com/api/#tag/User-Profiles/operation/get-address
UserProfilesApi getProfile GET /profiles/{userId} Get a single user profile https://docs.upsun.com/api/#tag/User-Profiles/operation/get-profile
UserProfilesApi listProfiles GET /profiles List user profiles https://docs.upsun.com/api/#tag/User-Profiles/operation/list-profiles
UserProfilesApi updateAddress PATCH /profiles/{userId}/address Update a user address https://docs.upsun.com/api/#tag/User-Profiles/operation/update-address
UserProfilesApi updateProfile PATCH /profiles/{userId} Update a user profile https://docs.upsun.com/api/#tag/User-Profiles/operation/update-profile
UsersApi getCurrentUser GET /users/me Get the current user https://docs.upsun.com/api/#tag/Users/operation/get-current-user
UsersApi getCurrentUserDeprecated GET /me Get current logged-in user info https://docs.upsun.com/api/#tag/Users/operation/get-current-user-deprecated
UsersApi getCurrentUserVerificationStatus POST /me/phone Check if phone verification is required https://docs.upsun.com/api/#tag/Users/operation/get-current-user-verification-status
UsersApi getCurrentUserVerificationStatusFull POST /me/verification Check if verification is required https://docs.upsun.com/api/#tag/Users/operation/get-current-user-verification-status-full
UsersApi getUser GET /users/{user_id} Get a user https://docs.upsun.com/api/#tag/Users/operation/get-user
UsersApi getUserByEmailAddress GET /users/email={email} Get a user by email https://docs.upsun.com/api/#tag/Users/operation/get-user-by-email-address
UsersApi getUserByUsername GET /users/username={username} Get a user by username https://docs.upsun.com/api/#tag/Users/operation/get-user-by-username
UsersApi resetEmailAddress POST /users/{user_id}/emailaddress Reset email address https://docs.upsun.com/api/#tag/Users/operation/reset-email-address
UsersApi resetPassword POST /users/{user_id}/resetpassword Reset user password https://docs.upsun.com/api/#tag/Users/operation/reset-password
UsersApi updateUser PATCH /users/{user_id} Update a user https://docs.upsun.com/api/#tag/Users/operation/update-user
VouchersApi applyOrgVoucher POST /organizations/{organization_id}/vouchers/apply Apply voucher https://docs.upsun.com/api/#tag/Vouchers/operation/apply-org-voucher
VouchersApi listOrgVouchers GET /organizations/{organization_id}/vouchers List vouchers https://docs.upsun.com/api/#tag/Vouchers/operation/list-org-vouchers

Models

Authorization

Authentication schemes defined for the API:

OAuth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://auth.api.platform.sh/oauth2/authorize
  • Scopes: N/A

OAuth2Admin

  • Type: OAuth
  • Flow: application
  • Authorization URL: ``
  • Scopes:
    • admin: administrative operations

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

License

This project is licensed under the Apache 2.0 License. See the LICENSE file for details.

About

Free and Open Source. SDK of Upsun. DISCLAIMER: This is a BETA version.

Topics

sdk php-library activation

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

5 stars

Watchers

9 watching

Forks

0 forks
Report repository

Releases 4

v0.1.0 Latest
Nov 4, 2025
+ 3 releases

Packages

No packages published

Contributors 6

Languages