CloudApiSdkPhp

Acquia Cloud API

Compatibility

Stability

The response for all resource endpoints includes an X-CloudAPI-Stability header that indicates what changes, if any, Acquia will make to the resource and how changes will be communicated.

There are three levels of stability:

prototype: A prototype resource is experimental and major changes are likely. A prototype resource may not reach production.
- Compatible and emergency changes may be made with no advance notice
- Disruptive changes may be made with one week notice
- Deprecated resources will remain available for at least one month after deprecation
development: A resource that is unlikely to change, but is still being worked on, will be marked as in development. These resources are very likely to reach production.
- Compatible and emergency changes may be made with no advance notice
- Disruptive changes may be made with one month notice
- Deprecated resources will remain available for at least six months after deprecation
production: A production resource will not introduce breaking changes within a version, and any breaking changes between versions will be communicated ahead of time.

Deprecation

Over time, endpoints may become obsolete and will be removed in the future. These endpoints will be marked with an X-CloudAPI-Deprecated header indicating the version in which they were deprecated and the reason for the deprecation. Deprecated endpoints may be removed in the next version of the resource.

Versioning

All resource endpoints are versioned within the API. Endpoints that have reached production will not introduce breaking changes between versions. Non-production endpoints will not version for changes.

A specific version of an endpoint can be requested via the Accept header:

Accept: application/json, version=2

If the version is not specified, the latest version of the endpoint will be used.

Starting with version 3, we will support the current version of an endpoint and the previous version. Version 1 of the API is provided elsewhere.

Errors

Some endpoints will return a 503 status when dependent services are unavailable:

application/json
{
    \"error\": \"system\",
    \"message\": \"This action is currently unavailable. Please try again later.\"
}

Authentication

All Acquia Cloud API calls require authentication to work properly.

Learn more: https://docs.acquia.com/acquia-cloud/develop/api/auth/

Example implementation

An example PHP script for making authenticated API requests can be found at https://docs.acquia.com/_downloads/api-v2-auth.php. This script uses the League/oauth2-client library, installed via Composer.

For more information, please visit https://www.acquia.com.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/CloudApiSdkPhp/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure OAuth2 access token for authorization: OAuth2
$config = Acquia\CloudApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Acquia\CloudApi\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$ssh_key_uuid = 981b7910-2fe9-11e9-b210-d663bd873d93; // string | The SSH key entity's universally unique identifier.

try {
    $result = $apiInstance->deleteAccountSshKey($ssh_key_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->deleteAccountSshKey: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://cloud.acquia.com/api

Class	Method	HTTP request	Description
AccountApi	deleteAccountSshKey	DELETE /account/ssh-keys/{sshKeyUuid}	Deletes an SSH key.
AccountApi	deleteAccountToken	DELETE /account/tokens/{tokenUuid}	Revokes an access token.
AccountApi	getAccount	GET /account	Returns details about your account.
AccountApi	getAccountApplicationHasPermission	GET /account/applications/{applicationUuid}/has-permission	Returns whether your account has access to a specific application permission.
AccountApi	getAccountApplicationIsAdministrator	GET /account/applications/{applicationUuid}/is-admin	Returns whether your account is an administrator for an application.
AccountApi	getAccountApplicationIsOwner	GET /account/applications/{applicationUuid}/is-owner	Returns whether your account is the owner for an application.
AccountApi	getAccountDrushAliasesDownload	GET /account/drush-aliases/download	Returns the drush aliases as a compressed archive download.
AccountApi	getAccountIdes	GET /account/ides	Returns a list of Cloud IDEs associated with the current user.
AccountApi	getAccountInvites	GET /account/invites	Gets a list of all organization admin and team invites that are pending for the current user.
AccountApi	getAccountMessages	GET /account/messages	Returns a list of messages associated with the current user.
AccountApi	getAccountOrganizationIsAdministrator	GET /account/organizations/{organizationUuid}/is-admin	Returns whether your account is an administrator for an organization.
AccountApi	getAccountOrganizationIsOwner	GET /account/organizations/{organizationUuid}/is-owner	Returns whether your account is the owner for an organization.
AccountApi	getAccountSshKey	GET /account/ssh-keys/{sshKeyUuid}	Get an SSH key associated with the currently-logged in user.
AccountApi	getAccountSshKeys	GET /account/ssh-keys	Gets a list of SSH keys associated with the current user.
AccountApi	getAccountSubscriptionIsAdministrator	GET /account/subscriptions/{subscriptionUuid}/is-admin	Returns whether your account is an administrator for a subscription.
AccountApi	getAccountSubscriptionIsOwner	GET /account/subscriptions/{subscriptionUuid}/is-owner	Returns whether your account is the owner for a subscription.
AccountApi	getAccountTeamHasPermission	GET /account/teams/{teamUuid}/has-permission	Returns whether your account has access to a specific team permission.
AccountApi	getAccountTeamIsAdministrator	GET /account/teams/{teamUuid}/is-admin	Returns whether your account is an administrator for a team.
AccountApi	getAccountTeamIsOwner	GET /account/teams/{teamUuid}/is-owner	Returns whether your account is the owner for a team.
AccountApi	getAccountToken	GET /account/tokens/{tokenUuid}	Return details about a specific token.
AccountApi	getAccountTokens	GET /account/tokens	Returns a list of metadata for API access tokens tied to your account.
AccountApi	postAccountApplicationMarkRecent	POST /account/applications/{applicationUuid}/actions/mark-recent	Marks an application as recently viewed.
AccountApi	postAccountApplicationStar	POST /account/applications/{applicationUuid}/actions/star	Stars an application.
AccountApi	postAccountApplicationUnstar	POST /account/applications/{applicationUuid}/actions/unstar	Removes an application from the user's starred list.
AccountApi	postAccountPassword	POST /account/password	Verifies that the supplied password matches the current user's password.
AccountApi	postAccountSshKeys	POST /account/ssh-keys	Installs a new SSH key for the current user.
AccountApi	postAccountTokens	POST /account/tokens	Creates an API access token tied to your account.
AgreementsApi	getAgreement	GET /agreements/{agreementUuid}	Return a specific agreement by a provided UUID.
AgreementsApi	getAgreements	GET /agreements	Return a list of agreements.
AgreementsApi	getInvitees	GET /agreements/{agreementUuid}/invitees	Returns a list of users invited to action this agreement.
AgreementsApi	postAcceptAgreement	POST /agreements/{agreementUuid}/actions/accept	Accepts a legal agreement by UUID.
AgreementsApi	postDeclineAgreement	POST /agreements/{agreementUuid}/actions/decline	Declines a legal agreement by UUID.
ApplicationPerformanceMonitoringServicesApi	getEnvironmentsApmSetting	GET /environments/{environmentId}/settings/apm	Returns a list of Application Performance Monitoring services associated with the environment.
ApplicationPerformanceMonitoringServicesApi	getSubscriptionApmType	GET /subscriptions/{subscriptionUuid}/apm/{apmType}	Returns the Application Performance Monitoring service type associated with the subscription.
ApplicationPerformanceMonitoringServicesApi	getSubscriptionApmTypes	GET /subscriptions/{subscriptionUuid}/apm	Returns a list of Application Performance Monitoring services associated with the subscription.
ApplicationPerformanceMonitoringServicesApi	postSubscriptionApmOptIn	POST /subscriptions/{subscriptionUuid}/apm/{apmType}/actions/opt-in	Enables New Relic Pro APM license for all applications on a subscription.
ApplicationPerformanceMonitoringServicesApi	putEnvironmentsApmSetting	PUT /environments/{environmentId}/settings/apm	Update configuration for an Application Performance Monitoring tool.
ApplicationsApi	deleteApplicationSearchConfigurationSet	DELETE /applications/{applicationUuid}/search/config-sets/{configurationSetId}	Removes and deletes a specific search configuration set from an application.
ApplicationsApi	deleteApplicationTags	DELETE /applications/{applicationUuid}/tags/{tagName}	Deletes an application tag.
ApplicationsApi	getApplicationByUuid	GET /applications/{applicationUuid}	Return details about a specific application.
ApplicationsApi	getApplicationDatabases	GET /applications/{applicationUuid}/databases	Returns a list database names for the application.
ApplicationsApi	getApplicationEmailDomains	GET /applications/{applicationUuid}/email/domains	Returns a list of email domains associated with the application.
ApplicationsApi	getApplicationEnvironments	GET /applications/{applicationUuid}/environments	Returns a list of environments within this application by its UUID.
ApplicationsApi	getApplicationFeatures	GET /applications/{applicationUuid}/features	Return application features.
ApplicationsApi	getApplicationHostingSettings	GET /applications/{applicationUuid}/settings/hosting	Returns the hosting settings for this application.
ApplicationsApi	getApplicationIdes	GET /applications/{applicationUuid}/ides	Returns a list of Cloud IDEs associated with this application.
ApplicationsApi	getApplicationLegacyProductKeysSettings	GET /applications/{applicationUuid}/settings/keys	Returns the legacy product keys for this application.
ApplicationsApi	getApplicationMessages	GET /applications/{applicationUuid}/messages	Returns a list of messages associated with this application.
ApplicationsApi	getApplicationNotificationByUuid	GET /applications/{applicationUuid}/notifications/{notificationUuid}	Returns a single notification.
ApplicationsApi	getApplicationNotifications	GET /applications/{applicationUuid}/notifications	Returns a list of notifications associated with this application by its UUID.
ApplicationsApi	getApplicationPermissions	GET /applications/{applicationUuid}/permissions	Returns a list of permissions the user has for this application by its UUID.
ApplicationsApi	getApplicationRemoteAdministrationSettings	GET /applications/{applicationUuid}/settings/ra	Returns the remote administration settings for this application.
ApplicationsApi	getApplicationSearchConfigurationSet	GET /applications/{applicationUuid}/search/config-sets/{configurationSetId}	Returns a search configuration set for an application
ApplicationsApi	getApplicationSearchConfigurationSets	GET /applications/{applicationUuid}/search/config-sets	Returns a collection of search configuration sets for an application
ApplicationsApi	getApplicationSearchList	GET /applications/{applicationUuid}/search	Returns a traversal endpoint for search entities for the application.
ApplicationsApi	getApplicationSecuritySettings	GET /applications/{applicationUuid}/settings/security	Returns the security policy settings for this application.
ApplicationsApi	getApplicationSettings	GET /applications/{applicationUuid}/settings	Returns available settings for this application.
ApplicationsApi	getApplicationTags	GET /applications/{applicationUuid}/tags	Returns a list of application tags associated with this application.
ApplicationsApi	getApplicationTasks	GET /applications/{applicationUuid}/tasks	Returns a list of tasks associated with this application by its UUID.
ApplicationsApi	getApplicationTeams	GET /applications/{applicationUuid}/teams	Returns a list of teams associated with this application.
ApplicationsApi	getApplications	GET /applications	Return a list of applications the current user has access to.
ApplicationsApi	getApplicationsUsageData	GET /applications/{applicationUuid}/metrics/usage/data	Retrieves aggregate usage data for an application, filterable by views or visits and by environment.
ApplicationsApi	getApplicationsUsageDataByEnvironment	GET /applications/{applicationUuid}/metrics/usage/data-by-environment	Retrieves usage data (views or visits) for an application, broken down by environment.
ApplicationsApi	getApplicationsUsageLinks	GET /applications/{applicationUuid}/metrics/usage	Retrieves traversal links for detailed metrics on usage (views and visits) of your application.
ApplicationsApi	getApplicationsUsageMetricData	GET /applications/{applicationUuid}/metrics/usage/{usageMetric}	Retrieves aggregate usage metric data (views or visits) for an application..
ApplicationsApi	getApplicationsUsageViewsDataByEnvironment	GET /applications/{applicationUuid}/metrics/usage/views-by-environment	Retrieves views data for an application, broken down by environment.
ApplicationsApi	getApplicationsUsageVisitsDataByEnvironment	GET /applications/{applicationUuid}/metrics/usage/visits-by-environment	Retrieves visits data for an application, broken down by environment.
ApplicationsApi	getArtifactByApplicationUuidAndId	GET /applications/{applicationUuid}/artifacts/{artifactId}	Return details about a specific artifact.
ApplicationsApi	getArtifactsByApplicationUuid	GET /applications/{applicationUuid}/artifacts	Return application artifacts.
ApplicationsApi	getCodeByApplicationUuid	GET /applications/{applicationUuid}/code	Return application branches and release tags.
ApplicationsApi	postApplicationAssociateEmailDomain	POST /applications/{applicationUuid}/email/domains/{domainRegistrationUuid}/actions/associate	Associates an email domain with an Application.
ApplicationsApi	postApplicationDatabaseCreate	POST /applications/{applicationUuid}/databases	Creates a database.
ApplicationsApi	postApplicationDatabaseDelete	DELETE /applications/{applicationUuid}/databases/{name}	Drops (deletes) a database.
ApplicationsApi	postApplicationDatabaseErase	POST /applications/{applicationUuid}/databases/{name}/actions/erase	Erases (truncates) a database.
ApplicationsApi	postApplicationDisassociateEmailDomain	POST /applications/{applicationUuid}/email/domains/{domainRegistrationUuid}/actions/disassociate	Disassociates an email domain with an Application.
ApplicationsApi	postApplicationEnvironments	POST /applications/{applicationUuid}/environments	Add a new continuous delivery environment to an application by the application UUID.
ApplicationsApi	postApplicationSearchConfigurationSets	POST /applications/{applicationUuid}/search/config-sets	Creates a search configuration set for an application.
ApplicationsApi	postApplicationsIde	POST /applications/{applicationUuid}/ides	Creates a new Cloud IDE.
ApplicationsApi	postApplicationsTags	POST /applications/{applicationUuid}/tags	Creates a new application tag.
ApplicationsApi	putApplicationByUuid	PUT /applications/{applicationUuid}	Renames an application.
ApplicationsApi	putApplicationRemoteAdministrationSettings	PUT /applications/{applicationUuid}/settings/ra	Modifies the remote administration settings for an application.
ApplicationsApi	putApplicationSecuritySettings	PUT /applications/{applicationUuid}/settings/security	Modifies the security policy settings for an application.
CloudIDEApi	deleteIde	DELETE /ides/{ideUuid}	De-provisions a specific Cloud IDE.
CloudIDEApi	getIde	GET /ides/{ideUuid}	Returns Cloud IDE info.
CurrentSystemHealthApi	getSystemHealthStatus	GET /	Return the current system health status.
DistributionsApi	getDistributionByName	GET /distributions/{name}	Return details about a specific Drupal distribution.
DistributionsApi	getDistributions	GET /distributions	Return a list of Drupal distributions.
EmailApi	getEmailStatus	GET /environments/{environmentId}/email	Returns the status of Platform Email for an Environment.
EnvironmentsApi	deleteCdnByEnvironmentId	DELETE /environments/{environmentId}/cdn	Disables a CDN for an environment.
EnvironmentsApi	deleteCertificate	DELETE /environments/{environmentId}/ssl/certificates/{certificateId}	Deletes a specific certificate by its ID.
EnvironmentsApi	deleteCertificateSigningRequest	DELETE /environments/{environmentId}/ssl/csrs/{certificateId}	Deletes the certificate signing request.
EnvironmentsApi	deleteEnvironment	DELETE /environments/{environmentId}	Deletes a CD environment.
EnvironmentsApi	deleteEnvironmentSearchIndex	DELETE /environments/{environmentId}/search/indexes/{indexId}	Removes and deletes a specific search index from an environment
EnvironmentsApi	deleteEnvironmentsDatabaseBackup	DELETE /environments/{environmentId}/databases/{databaseName}/backups/{backupId}	Deletes a database backup.
EnvironmentsApi	deleteEnvironmentsDomain	DELETE /environments/{environmentId}/domains/{domain}	Removes the domain from this environment.
EnvironmentsApi	deleteEnvironmentsLogForwardingDestination	DELETE /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}	Deletes the specified log forwarding destination.
EnvironmentsApi	deleteEnvironmentsVariable	DELETE /environments/{environmentId}/variables/{environmentVariableName}	Removes an environment variable from an environment.
EnvironmentsApi	getAvailableRuntimes	GET /environments/{environmentId}/available-runtimes	Return a list of runtimes.
EnvironmentsApi	getCdnByEnvironmentId	GET /environments/{environmentId}/cdn	Returns the CDN status for an environment.
EnvironmentsApi	getCertificate	GET /environments/{environmentId}/ssl/certificates/{certificateId}	Returns a specific certificate by certificate id.
EnvironmentsApi	getCertificateSigningRequest	GET /environments/{environmentId}/ssl/csrs/{certificateId}	Returns the certificate signing request for the certificate specified by id.
EnvironmentsApi	getCertificateSigningRequests	GET /environments/{environmentId}/ssl/csrs	Returns certificate signing requests.
EnvironmentsApi	getCertificates	GET /environments/{environmentId}/ssl/certificates	Return a list of SSL certificates.
EnvironmentsApi	getCron	GET /environments/{environmentId}/crons/{cronId}	Return details about a specific cron job.
EnvironmentsApi	getCronJobsByEnvironmentId	GET /environments/{environmentId}/crons	Return environment cron jobs.
EnvironmentsApi	getEIPs	GET /environments/{environmentId}/eips	Return a list of Web EIPs.
EnvironmentsApi	getEnvironment	GET /environments/{environmentId}	Return details about a specific environment.
EnvironmentsApi	getEnvironmentCloudActions	GET /environments/{environmentId}/cloud-actions	Returns a list of Cloud Actions.
EnvironmentsApi	getEnvironmentSearchIndex	GET /environments/{environmentId}/search/indexes/{indexId}	Returns a search configuration set for an application
EnvironmentsApi	getEnvironmentSearchIndexes	GET /environments/{environmentId}/search/indexes	Returns a collection of search indexes for an environment.
EnvironmentsApi	getEnvironmentSearchList	GET /environments/{environmentId}/search	Returns a traversal endpoint for search entities for the environment.
EnvironmentsApi	getEnvironmentsDatabase	GET /environments/{environmentId}/databases/{databaseName}	Return details about a specific database.
EnvironmentsApi	getEnvironmentsDatabaseBackup	GET /environments/{environmentId}/databases/{databaseName}/backups/{backupId}	Return details about a specific backup.
EnvironmentsApi	getEnvironmentsDatabaseBackups	GET /environments/{environmentId}/databases/{databaseName}/backups	Returns a list of backups.
EnvironmentsApi	getEnvironmentsDatabaseDownloadBackup	GET /environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/download	Downloads the database backup file.
EnvironmentsApi	getEnvironmentsDatabasePhpConfig	GET /environments/{environmentId}/databases/{databaseName}/php-config	Returns PHP configuration details for this database.
EnvironmentsApi	getEnvironmentsDatabases	GET /environments/{environmentId}/databases	Returns a list of databases.
EnvironmentsApi	getEnvironmentsDns	GET /environments/{environmentId}/dns	Returns DNS configuration details for an environment.
EnvironmentsApi	getEnvironmentsDomain	GET /environments/{environmentId}/domains/{domain}	Return details about a specific domain.
EnvironmentsApi	getEnvironmentsDomainStatus	GET /environments/{environmentId}/domains/{domain}/status	Returns details about the domain.
EnvironmentsApi	getEnvironmentsDomains	GET /environments/{environmentId}/domains	Returns a list of domains.
EnvironmentsApi	getEnvironmentsLog	GET /environments/{environmentId}/logs/{logType}	Downloads the log file.
EnvironmentsApi	getEnvironmentsLogForwardingDestination	GET /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}	Returns the specified log forwarding destination.
EnvironmentsApi	getEnvironmentsLogForwardingDestinations	GET /environments/{environmentId}/log-forwarding-destinations	Returns a collection of log forwarding destinations for this environment.
EnvironmentsApi	getEnvironmentsLogs	GET /environments/{environmentId}/logs	Returns a list of log files for this environment available for download.
EnvironmentsApi	getEnvironmentsLogstream	GET /environments/{environmentId}/logstream	Returns a logstream url and metadata.
EnvironmentsApi	getEnvironmentsMetrics	GET /environments/{environmentId}/metrics	Does not return any data. Allows traversal to metrics groups endpoints.
EnvironmentsApi	getEnvironmentsServer	GET /environments/{environmentId}/servers/{serverId}	Return details about a specific server.
EnvironmentsApi	getEnvironmentsServers	GET /environments/{environmentId}/servers	Returns a list of servers.
EnvironmentsApi	getEnvironmentsSettings	GET /environments/{environmentId}/settings	Provides links to environment settings.
EnvironmentsApi	getEnvironmentsStackMetrics	GET /environments/{environmentId}/metrics/stackmetrics	Does not return any data. Allows traversal to StackMetrics endpoints.
EnvironmentsApi	getEnvironmentsStackMetricsData	GET /environments/{environmentId}/metrics/stackmetrics/data	Returns StackMetrics data for the metrics specified in the filter paramater (e.g., apache-access, web-cpu).
EnvironmentsApi	getEnvironmentsUsageData	GET /environments/{environmentId}/metrics/usage/data	Retrieves usage data for an environment.
EnvironmentsApi	getEnvironmentsUsageLinks	GET /environments/{environmentId}/metrics/usage	Retrieves traversal links for an environment's usage data.
EnvironmentsApi	getEnvironmentsUsageMetricData	GET /environments/{environmentId}/metrics/usage/{usageMetric}	Retrieves usage metric data for an environment.
EnvironmentsApi	getEnvironmentsVariable	GET /environments/{environmentId}/variables/{environmentVariableName}	Get an environment variable associated with this environment.
EnvironmentsApi	getEnvironmentsVariables	GET /environments/{environmentId}/variables	Returns a list of environment variables associated with this environment.
EnvironmentsApi	getSsl	GET /environments/{environmentId}/ssl	Returns the SSL settings for this environment.
EnvironmentsApi	postActivateCertificate	POST /environments/{environmentId}/ssl/certificates/{certificateId}/actions/activate	Activates an SSL certificate.
EnvironmentsApi	postCdnByEnvironmentId	POST /environments/{environmentId}/cdn	Enables a CDN for an environment.
EnvironmentsApi	postCertificate	POST /environments/{environmentId}/ssl/certificates	Install an SSL certificate.
EnvironmentsApi	postCertificateSigningRequest	POST /environments/{environmentId}/ssl/csrs	Generates a certificate signing request (CSR) for one or more domains.
EnvironmentsApi	postChangeEnvironmentLabel	POST /environments/{environmentId}/actions/change-label	Change the label for an environment.
EnvironmentsApi	postDeactivateCertificate	POST /environments/{environmentId}/ssl/certificates/{certificateId}/actions/deactivate	Deactivates an active SSL certificate.
EnvironmentsApi	postDeployArtifact	POST /environments/{environmentId}/artifacts/actions/switch	Deploys an artifact to this environment.
EnvironmentsApi	postEnvironmentCloudActionsDisable	POST /environments/{environmentId}/cloud-actions/actions/disable	Disables Cloud Actions.
EnvironmentsApi	postEnvironmentCloudActionsEnable	POST /environments/{environmentId}/cloud-actions/actions/enable	Enables Cloud Actions.
EnvironmentsApi	postEnvironmentCloudActionsReset	POST /environments/{environmentId}/cloud-actions/actions/reset	Resets Cloud Actions.
EnvironmentsApi	postEnvironmentCronDelete	DELETE /environments/{environmentId}/crons/{cronId}	Deletes a cron job.
EnvironmentsApi	postEnvironmentCronDisable	POST /environments/{environmentId}/crons/{cronId}/actions/disable	Disables a cron job.
EnvironmentsApi	postEnvironmentCronEnable	POST /environments/{environmentId}/crons/{cronId}/actions/enable	Enables a cron job.
EnvironmentsApi	postEnvironmentCrons	POST /environments/{environmentId}/crons	Creates a scheduled job with cron.
EnvironmentsApi	postEnvironmentEmailDisable	POST /environments/{environmentId}/email/actions/disable	Disables email for an environment.
EnvironmentsApi	postEnvironmentEmailEnable	POST /environments/{environmentId}/email/actions/enable	Enables email for an environment.
EnvironmentsApi	postEnvironmentSearchIndexes	POST /environments/{environmentId}/search/indexes	Creates a search index for an environment.
EnvironmentsApi	postEnvironmentsClearCaches	POST /environments/{environmentId}/actions/clear-caches	Clears the caches for one or more domains attached to this environment.
EnvironmentsApi	postEnvironmentsDatabaseBackups	POST /environments/{environmentId}/databases/{databaseName}/backups	Create a backup.
EnvironmentsApi	postEnvironmentsDatabaseRestoreBackup	POST /environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/restore	Restores this backup to the appropriate environment's database.
EnvironmentsApi	postEnvironmentsDatabases	POST /environments/{environmentId}/databases	Copies a database to this environment.
EnvironmentsApi	postEnvironmentsDeployCode	POST /environments/{environmentId}/code	Deploys code to this environment.
EnvironmentsApi	postEnvironmentsDisableLiveDev	POST /environments/{environmentId}/livedev/actions/disable	Disable Live Development on this environment.
EnvironmentsApi	postEnvironmentsDisableLogForwardingDestination	POST /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/disable	Disables the specified log forwarding destination.
EnvironmentsApi	postEnvironmentsDisableProductionMode	POST /environments/{environmentId}/production-mode/actions/disable	Disables production mode for an environment.
EnvironmentsApi	postEnvironmentsDomainClearCaches	POST /environments/{environmentId}/domains/{domain}/actions/clear-caches	Clears the caches for the specified domain.
EnvironmentsApi	postEnvironmentsDomainClearVarnish	POST /environments/{environmentId}/domains/{domain}/actions/clear-varnish	Clears the Varnish cache for the specified domain.
EnvironmentsApi	postEnvironmentsDomains	POST /environments/{environmentId}/domains	Adds a domain to the environment.
EnvironmentsApi	postEnvironmentsDomainsClearVarnish	POST /environments/{environmentId}/domains/actions/clear-varnish	Clears the Varnish cache for one or more domains attached to this environment.
EnvironmentsApi	postEnvironmentsEnableLiveDev	POST /environments/{environmentId}/livedev/actions/enable	Enable Live Development on this environment.
EnvironmentsApi	postEnvironmentsEnableLogForwardingDestination	POST /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/enable	Enables the specified log forwarding destination.
EnvironmentsApi	postEnvironmentsEnableProductionMode	POST /environments/{environmentId}/production-mode/actions/enable	Enables production mode for an environment.
EnvironmentsApi	postEnvironmentsFiles	POST /environments/{environmentId}/files	Copies files to this environment.
EnvironmentsApi	postEnvironmentsImportSite	POST /environments/{environmentId}/code/actions/import	Imports a site to this environment.
EnvironmentsApi	postEnvironmentsLog	POST /environments/{environmentId}/logs/{logType}	Creates a log file snapshot.
EnvironmentsApi	postEnvironmentsLogForwardingDestinations	POST /environments/{environmentId}/log-forwarding-destinations	Creates a log forwarding destination.
EnvironmentsApi	postEnvironmentsServerReboot	POST /environments/{environmentId}/servers/{serverId}/actions/reboot	Reboots a server.
EnvironmentsApi	postEnvironmentsServerRelaunch	POST /environments/{environmentId}/servers/{serverId}/actions/relaunch	Relaunches a server.
EnvironmentsApi	postEnvironmentsServerSuspend	POST /environments/{environmentId}/servers/{serverId}/actions/suspend	Suspends a server.
EnvironmentsApi	postEnvironmentsServerUpgrade	POST /environments/{environmentId}/servers/{serverId}/actions/upgrade	Upgrades a server from "precise" to "xenial".
EnvironmentsApi	postEnvironmentsSwitchCode	POST /environments/{environmentId}/code/actions/switch	Switches code on this environment to a different branch or release tag.
EnvironmentsApi	postEnvironmentsVariables	POST /environments/{environmentId}/variables	Adds a new environment variable to an environment.
EnvironmentsApi	postMigrateEnvironment	POST /environments/{environmentId}/actions/migrate	Create a Migrate Environment using the provided environment as its source.
EnvironmentsApi	postPromoteEnvironment	POST /environments/{environmentId}/actions/promote	Promote a Migrate Environment.
EnvironmentsApi	postRefreshEnvironment	POST /environments/{environmentId}/actions/refresh	Refreshes a Migrate Environment.
EnvironmentsApi	putCron	PUT /environments/{environmentId}/crons/{cronId}	Modify an existing scheduled job.
EnvironmentsApi	putEnvironment	PUT /environments/{environmentId}	Modifies configuration settings for an environment.
EnvironmentsApi	putEnvironmentCloudActions	PUT /environments/{environmentId}/cloud-actions	Modifies an existing list of Cloud Actions.
EnvironmentsApi	putEnvironmentSearchIndex	PUT /environments/{environmentId}/search/indexes/{indexId}	Updates a search index on an environment.
EnvironmentsApi	putEnvironmentsLogForwardingDestination	PUT /environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}	Updates an environment's log forwarding destination.
EnvironmentsApi	putEnvironmentsServer	PUT /environments/{environmentId}/servers/{serverId}	Modifies configuration settings for a server.
EnvironmentsApi	putEnvironmentsVariable	PUT /environments/{environmentId}/variables/{environmentVariableName}	Updates an environment variable on an environment.
IdentityProvidersApi	deleteIdentityProvider	DELETE /identity-providers/{identityProviderUuid}	Deletes a specific identity provider by its UUID.
IdentityProvidersApi	getIdentityProvider	GET /identity-providers/{identityProviderUuid}	Returns a specific identity provider by UUID.
IdentityProvidersApi	getIdentityProviders	GET /identity-providers	Returns a list of identity providers for a user.
IdentityProvidersApi	postDisableIdentityProvider	POST /identity-providers/{identityProviderUuid}/actions/disable	Disables an identity provider by its UUID.
IdentityProvidersApi	postEnableIdentityProvider	POST /identity-providers/{identityProviderUuid}/actions/enable	Enables an identity provider by its UUID.
IdentityProvidersApi	putIdentityProvider	PUT /identity-providers/{identityProviderUuid}	Modifies an identity provider by its UUID.
InviteApi	getInviteByToken	GET /invites/{token}	Returns details about an invitation.
InviteApi	postInviteAcceptByToken	POST /invites/{token}/actions/accept	Accepts an invite.
InviteApi	postInviteCancel	DELETE /invites/{token}	Cancels an invitation.
InviteApi	postInviteDecline	POST /invites/{token}/actions/decline	Declines an invite.
InviteApi	postInviteResend	POST /invites/{token}/actions/resend	Resend an invite.
MessagesApi	getMessageFollow	GET /messages/{messageUuid}/actions/follow	Follows an in-product message link.
MessagesApi	postDismissMessage	POST /messages/{messageUuid}/actions/dismiss	Dismisses a message.
MigrateAcceleratorApi	postMigrateEnvironment	POST /environments/{environmentId}/actions/migrate	Create a Migrate Environment using the provided environment as its source.
MigrateAcceleratorApi	postPromoteEnvironment	POST /environments/{environmentId}/actions/promote	Promote a Migrate Environment.
MigrateAcceleratorApi	postRefreshEnvironment	POST /environments/{environmentId}/actions/refresh	Refreshes a Migrate Environment.
NotificationsApi	getNotificationByUuid	GET /notifications/{notificationUuid}	Returns a single notification.
OptionsApi	getCdeSizes	GET /options/cde-sizes	Displays the various CD Environment size options.
OptionsApi	getColors	GET /options/colors	Displays the various color options.
OptionsApi	getLogForwarding	GET /options/log-forwarding	Does not return any data. Allows traversal of options groups endpoints.
OptionsApi	getLogForwardingConsumers	GET /options/log-forwarding/consumers	Displays available log forwarding consumers.
OptionsApi	getLogForwardingSources	GET /options/log-forwarding/sources	Displays available log forwarding sources.
OptionsApi	getOptions	GET /options	Does not return any data. Allows traversal of options groups endpoints.
OrganizationsApi	deleteOrganization	DELETE /organizations/{organizationUuid}	Deletes a specific organization by its UUID.
OrganizationsApi	deleteOrganizationAdmin	DELETE /organizations/{organizationUuid}/admins/{userUuid}	Removes the user from the list of administrators for the organization.
OrganizationsApi	deleteOrganizationAvailableTags	DELETE /organizations/{organizationUuid}/available-tags	Deletes bulk tags from organization resources.
OrganizationsApi	getOrganizationAdmin	GET /organizations/{organizationUuid}/admins/{userUuid}	Returns the user profile of this organization administrator.
OrganizationsApi	getOrganizationAdminInvites	GET /organizations/{organizationUuid}/admin-invites	Gets a list of invitations of administrators for this organization.
OrganizationsApi	getOrganizationAdmins	GET /organizations/{organizationUuid}/admins	Returns a list of organization administrators.
OrganizationsApi	getOrganizationApplications	GET /organizations/{organizationUuid}/applications	Returns a list of applications that belong to the organization.
OrganizationsApi	getOrganizationAvailableTags	GET /organizations/{organizationUuid}/available-tags	Returns a list of all available application tags.
OrganizationsApi	getOrganizationByUuid	GET /organizations/{organizationUuid}	Return details about a specific organization.
OrganizationsApi	getOrganizationIdentityProvider	GET /organizations/{organizationUuid}/identity-provider	Returns an identity provider for an organization.
OrganizationsApi	getOrganizationMember	GET /organizations/{organizationUuid}/members/{userUuid}	Returns the user profile of this organization member.
OrganizationsApi	getOrganizationMemberApplications	GET /organizations/{organizationUuid}/members/{userUuid}/applications	Returns a list of applications that an organization member has access to.
OrganizationsApi	getOrganizationMembers	GET /organizations/{organizationUuid}/members	Returns a list of all organization members.
OrganizationsApi	getOrganizationNotifications	GET /organizations/{organizationUuid}/notifications	Returns a list of notifications associated with this organization by its UUID.
OrganizationsApi	getOrganizationRoles	GET /organizations/{organizationUuid}/roles	Returns a list of all the canonical roles within the organization.
OrganizationsApi	getOrganizationSubscriptions	GET /organizations/{organizationUuid}/subscriptions	Returns a list of subscriptions that belong to the organization.
OrganizationsApi	getOrganizationTeamInvites	GET /organizations/{organizationUuid}/team-invites	Gets a list of member invitations for all teams in this organization.
OrganizationsApi	getOrganizationTeams	GET /organizations/{organizationUuid}/teams	Returns a list of teams associated with the organization.
OrganizationsApi	getOrganizations	GET /organizations	Return a list of organizations.
OrganizationsApi	postChangeOrganizationOwner	POST /organizations/{organizationUuid}/actions/change-owner	Changes the organization owner.
OrganizationsApi	postLeaveOrganization	POST /organizations/{organizationUuid}/actions/leave	Removes your account from an organization.
OrganizationsApi	postOrganizationAdminInvite	POST /organizations/{organizationUuid}/admin-invites	Invites a user to be an administrator in this organization.
OrganizationsApi	postOrganizationAvailableTags	POST /organizations/{organizationUuid}/available-tags	Adds bulk tags to organization resources.
OrganizationsApi	postOrganizationMemberDelete	DELETE /organizations/{organizationUuid}/members/{userUuid}	Removes the member from the organization.
OrganizationsApi	postOrganizationRoles	POST /organizations/{organizationUuid}/roles	Creates a role.
OrganizationsApi	postOrganizationTeams	POST /organizations/{organizationUuid}/teams	Creates a team.
OrganizationsApi	postOrganizationsCreate	POST /organizations	Creates a new organization.
OrganizationsApi	putOrganization	PUT /organizations/{organizationUuid}	Renames an organization.
SubscriptionsApi	deleteShieldAcl	DELETE /subscriptions/{subscriptionUuid}/shield-acl/{shieldAclUuid}	Deletes a Shield ACL rule.
SubscriptionsApi	deleteSubscriptionDomainRegistration	DELETE /subscriptions/{subscriptionUuid}/domains/{domainRegistrationUuid}	Unregisters a Domain registered with this subscription.
SubscriptionsApi	getShieldAcl	GET /subscriptions/{subscriptionUuid}/shield-acl	Provides a list of Shield ACL rules.
SubscriptionsApi	getShieldAclRuleByUuid	GET /subscriptions/{subscriptionUuid}/shield-acl/{shieldAclUuid}	Returns the specified Shield ACL rule.
SubscriptionsApi	getSubscription	GET /subscriptions/{subscriptionUuid}	Return details about a specific subscription.
SubscriptionsApi	getSubscriptionApplications	GET /subscriptions/{subscriptionUuid}/applications	Provides a list of applications that are a part of the subscription.
SubscriptionsApi	getSubscriptionDomainRegistration	GET /subscriptions/{subscriptionUuid}/domains/{domainRegistrationUuid}	Returns a speicific Domain registered with this subscription.
SubscriptionsApi	getSubscriptionDomainRegistrations	GET /subscriptions/{subscriptionUuid}/domains	Returns a list of Domains registered with this subscription.
SubscriptionsApi	getSubscriptionEntitlements	GET /subscriptions/{subscriptionUuid}/entitlements	Provides a list of entitlements that are a part of the subscription.
SubscriptionsApi	getSubscriptionIdes	GET /subscriptions/{subscriptionUuid}/ides	Returns a list of Cloud IDEs associated with this subscription.
SubscriptionsApi	getSubscriptions	GET /subscriptions	Return a list of subscription.
SubscriptionsApi	getSubscriptionsUsageData	GET /subscriptions/{subscriptionUuid}/metrics/usage/data	Retrieves aggregate usage data for a subscription.
SubscriptionsApi	getSubscriptionsUsageDataByApplication	GET /subscriptions/{subscriptionUuid}/metrics/usage/data-by-application	Retrieves usage data for a subscription, broken down by application.
SubscriptionsApi	getSubscriptionsUsageLinks	GET /subscriptions/{subscriptionUuid}/metrics/usage	Retrieves traversal links for a subscription's usage data.
SubscriptionsApi	getSubscriptionsUsageMetricData	GET /subscriptions/{subscriptionUuid}/metrics/usage/{usageMetric}	Retrieves aggregate usage metric data for a subscription.
SubscriptionsApi	getSubscriptionsUsageViewsDataByApplication	GET /subscriptions/{subscriptionUuid}/metrics/usage/views-by-application	Retrieves views data for a subscription, broken down by application.
SubscriptionsApi	getSubscriptionsUsageVisitsDataByApplication	GET /subscriptions/{subscriptionUuid}/metrics/usage/visits-by-application	Retrieves visits data for a subscription, broken down by application.
SubscriptionsApi	postResetShieldAcl	POST /subscriptions/{subscriptionUuid}/shield-acl/actions/reset	Resets Shield ACL rules to default settings.
SubscriptionsApi	postShieldAcl	POST /subscriptions/{subscriptionUuid}/shield-acl	Creates a Shield ACL rule.
SubscriptionsApi	postSubscriptionDomainRegistration	POST /subscriptions/{subscriptionUuid}/domains	Registers a Domain with this subscription.
SubscriptionsApi	postSubscriptionVerifyDomainRegistration	POST /subscriptions/{subscriptionUuid}/domains/{domainRegistrationUuid}/actions/verify	Triggers re-verification and update to the domain verification status.
SubscriptionsApi	putShieldAcl	PUT /subscriptions/{subscriptionUuid}/shield-acl/{shieldAclUuid}	Updates a Shield ACL rule.
SubscriptionsApi	putSubscription	PUT /subscriptions/{subscriptionUuid}	Modifies a subscription.
TeamsAndPermissionsApi	deleteRole	DELETE /roles/{roleUuid}	Deletes a specific role by its UUID.
TeamsAndPermissionsApi	deleteTeam	DELETE /teams/{teamUuid}	Deletes a specific team by its UUID.
TeamsAndPermissionsApi	deleteTeamsRemoveApplication	DELETE /teams/{teamUuid}/applications/{applicationUuid}	Removes the application from this team.
TeamsAndPermissionsApi	deleteTeamsRemoveMember	DELETE /teams/{teamUuid}/members/{userUuid}	Remove a user from a team.
TeamsAndPermissionsApi	getPermissions	GET /permissions	Return a list of permissions.
TeamsAndPermissionsApi	getRole	GET /roles/{roleUuid}	Return details about a specific role.
TeamsAndPermissionsApi	getTeam	GET /teams/{teamUuid}	Return details about a specific team.
TeamsAndPermissionsApi	getTeamApplications	GET /teams/{teamUuid}/applications	Returns a list of applications this team has access to.
TeamsAndPermissionsApi	getTeamInvites	GET /teams/{teamUuid}/invites	Returns a list of invitations to this team.
TeamsAndPermissionsApi	getTeamMembers	GET /teams/{teamUuid}/members	Returns a list of team members.
TeamsAndPermissionsApi	getTeams	GET /teams	Return teams the current user has access to.
TeamsAndPermissionsApi	postLeaveTeam	POST /teams/{teamUuid}/actions/leave	Removes the current user from a team.
TeamsAndPermissionsApi	postTeamAddApplication	POST /teams/{teamUuid}/applications	Adds an application to this team.
TeamsAndPermissionsApi	postTeamsInviteUser	POST /teams/{teamUuid}/invites	Invites a user to join a team.
TeamsAndPermissionsApi	putRoleByUuid	PUT /roles/{roleUuid}	Updates a role.
TeamsAndPermissionsApi	putTeamsMember	PUT /teams/{teamUuid}/members/{userUuid}	Grant team roles to a member.
TeamsAndPermissionsApi	putTeamsName	PUT /teams/{teamUuid}	Change the name of a team.

Models

Authorization

Authentication schemes defined for the API:

OAuth2

Type: OAuth
Flow: application
Authorization URL: https://accounts.acquia.com/api/authorize
Scopes: N/A

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 2.0.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

To regenerate the SDK:

openapi-generator generate -i https://raw.githubusercontent.com/acquia/cli/main/assets/acquia-spec.yaml -g php -o . --package-name "CloudApiSdkPhp" --invoker-package "Acquia\CloudApi"

danepowell/cloud-api-sdk-php