Skip to content
/ enhance-sdk-php Public

Enhance.com PHP SDK automatically generated from the Enhance OpenAPI spec using OpenAPI Generator

License

Apache-2.0 license
0 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

upmind/enhance-sdk-php

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
.docker
.docker
 
 
.github/workflows
.github/workflows
 
 
.openapi-generator
.openapi-generator
 
 
OpenApi
OpenApi
 
 
bin
bin
 
 
docs
docs
 
 
src
src
 
 
test
test
 
 
.gitignore
.gitignore
 
 
.php-cs-fixer.dist.php
.php-cs-fixer.dist.php
 
 
.travis.yml
.travis.yml
 
 
CHANGELOG.md
CHANGELOG.md
 
 
CONTRIBUTING.md
CONTRIBUTING.md
 
 
LICENSE.md
LICENSE.md
 
 
Makefile
Makefile
 
 
README.md
README.md
 
 
composer.json
composer.json
 
 
docker-compose.yml.example
docker-compose.yml.example
 
 
generate.sh
generate.sh
 
 
generator-config.yml
generator-config.yml
 
 
open-api.yml
open-api.yml
 
 
phpstan.neon.dist
phpstan.neon.dist
 
 
phpunit.xml.dist
phpunit.xml.dist
 
 

Repository files navigation

Upmind - Enhance PHP SDK

Latest Version on Packagist

Enhance.com PHP SDK automatically generated from the Enhance OpenAPI spec using OpenAPI Generator v7.11.0.

This package's versioning corresponds to the version of the Enhance orchd OpenAPI spec used to generate the SDK.

Installation & Usage

Requirements

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

Composer

To install the package via Composer, run the following install command:

composer require upmind/enhance-sdk

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/upmind/enhance-sdk/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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




$apiInstance = new Upmind\EnhanceSdk\Api\AppsApi(
    // 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()
);
$org_id = 'org_id_example'; // string | The id of the organization.
$website_id = 'website_id_example'; // string | The id of the website.
$new_website_app = new \Upmind\EnhanceSdk\Model\NewWebsiteApp(); // \Upmind\EnhanceSdk\Model\NewWebsiteApp

try {
    $result = $apiInstance->createWebsiteApp($org_id, $website_id, $new_website_app);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppsApi->createWebsiteApp: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AppsApi createWebsiteApp POST /orgs/{org_id}/websites/{website_id}/apps Create website applications
AppsApi deleteWebsiteApp DELETE /orgs/{org_id}/websites/{website_id}/apps/{app_id} Delete website app
AppsApi getGlobalInstallableApps GET /utils/installable-apps Get all installable applications
AppsApi getInstallableApps GET /orgs/{org_id}/subscriptions/{subscription_id}/installable-apps Get installable website applications
AppsApi getWebsiteApps GET /orgs/{org_id}/websites/{website_id}/apps Get website applications
BackupsApi backupWebsite POST /orgs/{org_id}/websites/{website_id}/backups Create a website backup
BackupsApi deleteWebsiteBackup DELETE /orgs/{org_id}/websites/{website_id}/backups/{backup_id} Delete a backup
BackupsApi getWebsiteBackup GET /orgs/{org_id}/websites/{website_id}/backups/{backup_id} Get detailed metadata of the website backup
BackupsApi getWebsiteBackups GET /orgs/{org_id}/websites/{website_id}/backups Get all website backups metadata
BackupsApi getWebsiteRestoreStatus GET /orgs/{org_id}/websites/{website_id}/backups/{backup_id}/restore_status Get the last detailed metadata of the restored website backup.
BackupsApi restoreWebsite PUT /orgs/{org_id}/websites/{website_id}/backups/{backup_id} Restore website from a backup
BrandingApi createBrandingSettings POST /orgs/{org_id}/branding/settings Create branding settings
BrandingApi createNameServerDomain POST /orgs/{org_id}/name-servers Create reseller name server domain
BrandingApi deleteBrandFavicon DELETE /orgs/{org_id}/branding/favicon Delete brand favicon
BrandingApi deleteBrandInverseIcon DELETE /orgs/{org_id}/branding/inverse-icon Delete brand inverse icon
BrandingApi deleteBrandLoginImage DELETE /orgs/{org_id}/branding/login-image Delete brand login image
BrandingApi deleteBrandLogo DELETE /orgs/{org_id}/branding/logo Delete brand logo
BrandingApi deleteBrandingSetting DELETE /orgs/{org_id}/branding/settings/{name} Remove the specified setting
BrandingApi deleteInverseBrandLogo DELETE /orgs/{org_id}/branding/inverse-logo Delete brand inverse logo
BrandingApi deleteNameServerDomain DELETE /orgs/{org_id}/name-servers/{domain} Delete reseller name server domain name
BrandingApi getBranding GET /branding Get default branding
BrandingApi getBrandingSetting GET /orgs/{org_id}/branding/settings/{name} Get the specified setting
BrandingApi getBrandingSettings GET /orgs/{org_id}/branding/settings Get all current settings
BrandingApi getStagingDomain GET /orgs/{org_id}/staging-domain Fetches the staging domain which is currently set
BrandingApi setBrandFavicon PUT /orgs/{org_id}/branding/favicon Set brand favicon
BrandingApi setBrandInverseIcon PUT /orgs/{org_id}/branding/inverse-icon Set brand inverse icon
BrandingApi setBrandInverseLogo PUT /orgs/{org_id}/branding/inverse-logo Set brand inverse logo
BrandingApi setBrandLoginImage PUT /orgs/{org_id}/branding/login-image Set brand login image
BrandingApi setBrandLogo PUT /orgs/{org_id}/branding/logo Set brand logo
BrandingApi setStagingDomain POST /orgs/{org_id}/staging-domain Set or update domain suffix for staging websites created by customers
BrandingApi updateBrandingSetting PUT /orgs/{org_id}/branding/settings/{name} Create or update the specified setting
BrandingApi updateNameServerDomain PATCH /orgs/{org_id}/name-servers/{domain} Update reseller name server domain name
CustomersApi createCustomer POST /orgs/{org_id}/customers Create a customer organization
CustomersApi createCustomerSubscription POST /orgs/{org_id}/customers/{customer_org_id}/subscriptions Create a subscriptions for a customer
CustomersApi getCustomerSubscriptions GET /orgs/{org_id}/customers/{customer_org_id}/subscriptions Get customer subscriptions
CustomersApi getOrgCustomers GET /orgs/{org_id}/customers Get organization customers
DnsApi createDefaultDnsRecord POST /v2/settings/dns/default-records Create a default DNS record
DnsApi createDnsThirdPartyProvider POST /dns/third-party-providers Create new third party provider.
DnsApi createWebsiteDomainDnsZoneRecord POST /orgs/{org_id}/websites/{website_id}/domains/{domain_id}/dns-zone/records Create a new dns record for website domain
DnsApi deleteDefaultDnsRecord DELETE /v2/settings/dns/default-records/{record_id} Delete a default DNS record
DnsApi deleteDnsThirdPartyProvider DELETE /dns/third-party-providers/{provider_id} Deletes a third party dns provider.
DnsApi deleteWebsiteDomainDnsZoneRecord DELETE /orgs/{org_id}/websites/{website_id}/domains/{domain_id}/dns-zone/records/{record_id} Delete dns zone record
DnsApi disableDomainDnsSec DELETE /orgs/{org_id}/websites/{website_id}/domains/{domain_id}/dns-zone/dnssec Disable DNSSEC on this domain
DnsApi enableDomainDnsSec POST /orgs/{org_id}/websites/{website_id}/domains/{domain_id}/dns-zone/dnssec Enable DNSSEC on this domain
DnsApi getDnsThirdPartyProviders GET /dns/third-party-providers Lists all third party providers.
DnsApi getWebsiteDomainDnsZone GET /orgs/{org_id}/websites/{website_id}/domains/{domain_id}/dns-zone Get a dns zone for given domain
DnsApi listDefaultDnsRecords GET /v2/settings/dns/default-records List default DNS records
DnsApi updateDefaultDnsRecord PATCH /v2/settings/dns/default-records/{record_id} Update a default DNS record
DnsApi updateWebsiteDomainDnsZone PATCH /orgs/{org_id}/websites/{website_id}/domains/{domain_id}/dns-zone Updates a dns zone SOA for website domain
DnsApi updateWebsiteDomainDnsZoneRecord PATCH /orgs/{org_id}/websites/{website_id}/domains/{domain_id}/dns-zone/records/{record_id} Updates a dns record for given domain
DomainsApi checkDomain POST /orgs/{org_id}/domains/check Check if a domain can be created
DomainsApi createWebsiteDomainLetsencryptCerts POST /v2/domains/{domain_id}/letsencrypt Generate and setup letsencrypt ssl certificates for website's domain
DomainsApi createWebsiteMailDomainLetsencryptCerts POST /v2/domains/{domain_id}/letsencrypt_mail Generate and setup letsencrypt ssl certificates for website's domain with mail. prefix.
DomainsApi createWebsiteMappedDomain POST /orgs/{org_id}/websites/{website_id}/domains Create website mapped domain
DomainsApi deleteCloudflareApiKeyId DELETE /orgs/{org_id}/domains/{domain_id}/cloudflare Delete CloudFlare API key, domain level
DomainsApi deleteDomain DELETE /orgs/{org_id}/domains/{domain_id} Delete domain
DomainsApi deleteWebsiteDomainMapping DELETE /orgs/{org_id}/websites/{website_id}/domains/{domain_id} Delete website domain mapping
DomainsApi deleteWebsiteDomainVhost DELETE /v2/domains/{domain_id}/vhost Deletes domain's custom vhost file if any
DomainsApi getCloudflareApiKeyDomain GET /orgs/{org_id}/domains/{domain_id}/cloudflare Get CloudFlare API key, domain level
DomainsApi getCloudflareNameServers GET /orgs/{org_id}/domains/{domain_id}/cloudflare/nameservers Get CloudFlare name servers
DomainsApi getDomainAuthNs GET /orgs/{org_id}/domains/{domain_id}/auth-ns Get authoritative nameservers for domain.
DomainsApi getDomains GET /orgs/{org_id}/domains Get domains
DomainsApi getWebsiteDomainDnsQuery GET /orgs/{org_id}/websites/{website_id}/domains/{domain_id}/dns-query Recursively query Dns servers for given domain
DomainsApi getWebsiteDomainMapping GET /orgs/{org_id}/websites/{website_id}/domains/{domain_id} Returns website domain mapping
DomainsApi getWebsiteDomainMappingDnsStatus GET /orgs/{org_id}/websites/{website_id}/domains/{domain_id}/dns-status Returns website domain mapping DNS status
DomainsApi getWebsiteDomainMappings GET /orgs/{org_id}/websites/{website_id}/domains Get website's mapped domains
DomainsApi getWebsiteDomainModSecStatus GET /v2/domains/{domain_id}/modsec_status Get mod security status for a single domain
DomainsApi getWebsiteDomainVhost GET /v2/domains/{domain_id}/vhost Get domain's custom vhost file, if the file does not exist return empty string
DomainsApi performLetsEncryptPreflightCheck POST /v2/domains/{domain_id}/letsencrypt_preflight Perform the LetsEncrypt preflight check
DomainsApi setCloudflareApiKeyId PUT /orgs/{org_id}/domains/{domain_id}/cloudflare Set CloudFlare API key, domain level
DomainsApi setWebsiteDomainModSecStatus PUT /v2/domains/{domain_id}/modsec_status Set mod security status on a single domain
DomainsApi setWebsiteDomainVhost PUT /v2/domains/{domain_id}/vhost Set a custom vhost file
DomainsApi updateWebsiteDomainMapping PATCH /orgs/{org_id}/websites/{website_id}/domains/{domain_id} Update website domain mapping
DomainsApi updateWebsitePrimaryDomain PUT /orgs/{org_id}/websites/{website_id}/domains/primary Update primary domain mapping
EmailClientApi createEmailAutoresponder POST /email-client/autoresponders Create new email autoresponder
EmailClientApi deleteEmailAutoresponder DELETE /email-client/autoresponders/{autoresponder_id} Delete email autoresponder
EmailClientApi getEmailAutoresponders GET /email-client/autoresponders Get email account autoresponder
EmailClientApi getEmailForwarders GET /email-client/forwarders Returns email account's forwarders
EmailClientApi getEmailPublicIp GET /email-client/public-ip Returns public Ip Address of the email server
EmailClientApi updateEmailAutoresponder PUT /email-client/autoresponders/{autoresponder_id} Update email autoresponder
EmailClientApi updateEmailForwarders PUT /email-client/forwarders Updates email account's forwarders
EmailClientApi updateEmailPassword PUT /email-client/password Updates email account's password
EmailsApi createWebsiteEmail POST /orgs/{org_id}/websites/{website_id}/domains/{domain_id}/emails Create an email under website's domain
EmailsApi createWebsiteEmailAutoresponder POST /orgs/{org_id}/websites/{website_id}/emails/{email_id}/autoresponder Create new website email autoresponder
EmailsApi deleteWebsiteEmail DELETE /orgs/{org_id}/websites/{website_id}/emails/{email_id} Delete website email
EmailsApi deleteWebsiteEmailAutoresponder DELETE /orgs/{org_id}/websites/{website_id}/emails/{email_id}/autoresponder Delete website email autoresponder
EmailsApi getDomainEmailAuth GET /orgs/{org_id}/domains/{domain_id}/email-auth Get email authentication preferences
EmailsApi getDomainLocalRemote GET /orgs/{org_id}/websites/{website_id}/domains/{domain_id}/local_remote Get the current local/remote status
EmailsApi getEmailSpamThresholds GET /emails/{email_id}/spam_thresholds Get spam thresholds for an email address
EmailsApi getEmails GET /orgs/{org_id}/emails Get org emails
EmailsApi getWebsiteEmail GET /orgs/{org_id}/websites/{website_id}/emails/{email_id} Get website email
EmailsApi getWebsiteEmailAutoresponder GET /orgs/{org_id}/websites/{website_id}/emails/{email_id}/autoresponder Get website email autoresponder
EmailsApi getWebsiteEmailClientConf GET /orgs/{org_id}/websites/{website_id}/emails/{email_id}/client-conf Get website email client configuration
EmailsApi getWebsiteEmails GET /orgs/{org_id}/websites/{website_id}/emails Get website emails
EmailsApi setDomainLocalRemote PUT /orgs/{org_id}/websites/{website_id}/domains/{domain_id}/local_remote Update email local/remote status
EmailsApi setEmailSpamThresholds PUT /emails/{email_id}/spam_thresholds Set spam thresholds for an email address
EmailsApi updateDomainEmailAuth PUT /orgs/{org_id}/domains/{domain_id}/email-auth Update email authentication preferences
EmailsApi updateWebsiteEmail PATCH /orgs/{org_id}/websites/{website_id}/emails/{email_id} Update website email
EmailsApi validateDomainEmailAuth GET /orgs/{org_id}/domains/{domain_id}/email-auth/validate Validate email authentication DNS records
FtpApi createFtpUser POST /orgs/{org_id}/websites/{website_id}/ftp/users Creates a new FTP user for a given website
FtpApi deleteFtpUser DELETE /orgs/{org_id}/websites/{website_id}/ftp/users/{username} Deletes given FTP user
FtpApi getFtpUsers GET /orgs/{org_id}/websites/{website_id}/ftp/users Returns all ftp users data for a given website
FtpApi updateFtpUser PATCH /orgs/{org_id}/websites/{website_id}/ftp/users/{username} Update given FTP user
ImportersApi analyzeImportMigration POST /v2/orgs/{org_id}/import/{import_migration_id}/analyze Analyze imported migration
ImportersApi checkImportMigrationResources POST /v2/orgs/{org_id}/import/{import_migration_id}/resource Check if all resources from the imported migration could be created.
ImportersApi createImportMigration POST /v2/orgs/{org_id}/import/{import_migration_id} Create a new import migration.
ImportersApi createImportServerSettings POST /orgs/{org_id}/import/server/settings Create settings for the server import
ImportersApi deleteImportMigration DELETE /v2/orgs/{org_id}/import/{import_migration_id} Delete single migration
ImportersApi deleteImportServerSettings DELETE /orgs/{org_id}/import/server/{server_id}/settings Delete settings for the server import
ImportersApi getImportMigration GET /v2/orgs/{org_id}/import/{import_migration_id} Fetches single migration details
ImportersApi getImportMigrationData GET /v2/orgs/{org_id}/import/{import_migration_id}/analyze Get import migration information
ImportersApi getImportMigrationLog GET /v2/orgs/{org_id}/import/{import_migration_id}/log Get the log for an import migration
ImportersApi getImportMigrations GET /v2/orgs/{org_id}/import List all import migrations
ImportersApi getImportServerDomainsCached GET /orgs/{org_id}/import/server/{server_id}/cached-domains Returns cached domains
ImportersApi getImportServerPullDomains GET /orgs/{org_id}/import/server/{server_id}/pull-domains Pull domains form the remote server.
ImportersApi getImportServerSettings GET /orgs/{org_id}/import/server/{server_id}/settings Get settings for the server import
ImportersApi listImportServerSettings GET /orgs/{org_id}/import/server/settings List all server import settings
ImportersApi scanImportMigrations GET /v2/import/scan Scan for manually uploaded cPanel backups.
ImportersApi transferCPanelUserAccount POST /orgs/{org_id}/import/server/{server_id}/account/{user_id} Transfer user account from remote cPanel server
ImportersApi transferPleskDomain POST /orgs/{org_id}/import/plesk-server/{server_id}/domain Transfer user account from remote cPanel server
ImportersApi updateImportServerSettings PATCH /orgs/{org_id}/import/server/{server_id}/settings Update settings for the server import
ImportersApi uploadImportMigration POST /v2/orgs/{org_id}/import/upload/{import_migration_kind} Upload file for analyzing and processing.
InstallApi orchdStatus GET /status Get the readiness status of the orchd service
InstallApi orchdVersion GET /version Get the SemVer of the API service
InvitesApi acceptInvite POST /invites/{invite_id} Accept invite
InvitesApi createInvite POST /orgs/{org_id}/invites Create invite
InvitesApi validateInvite POST /invites/{invite_id}/validate Validate invite
LetsencryptApi createWebsiteDomainLetsencryptCerts POST /v2/domains/{domain_id}/letsencrypt Generate and setup letsencrypt ssl certificates for website's domain
LetsencryptApi createWebsiteMailDomainLetsencryptCerts POST /v2/domains/{domain_id}/letsencrypt_mail Generate and setup letsencrypt ssl certificates for website's domain with mail. prefix.
LetsencryptApi performLetsEncryptPreflightCheck POST /v2/domains/{domain_id}/letsencrypt_preflight Perform the LetsEncrypt preflight check
LicenceApi getLicenceInfo GET /licence Get current licence status
LicenceApi refreshLicence PUT /licence Updates licence key if provided, and refresh licence status by calling home servers. NOTE: calling without any licence_key body, only refreshes the current licence status
LoginsApi createLogin POST /logins Create a new login
LoginsApi createOtpSession GET /login/sessions/sso Create a new session for login with a one-time-password
LoginsApi createSession POST /login/sessions Create a new session for login
LoginsApi deleteCurrentSession DELETE /login/sessions/current Delete current session
LoginsApi deleteLoginAvatar DELETE /login/avatar Remove login avatar
LoginsApi deleteSession DELETE /login/sessions/{session_id} Delete current session
LoginsApi deleteSessions DELETE /login/sessions Delete sessions
LoginsApi finishPasswordRecovery POST /login/password-recovery Finish a password recovery
LoginsApi getCustomerLogins GET /v2/orgs/{org_id}/customers/logins List customer logins for org
LoginsApi getLogin GET /login Get login info
LoginsApi getLoginMemberships GET /login/memberships Get login memberships
LoginsApi getLogins GET /logins Query all logins
LoginsApi getOrgLogins GET /orgs/{org_id}/logins Query logins belonging to organization
LoginsApi getSessions GET /login/sessions Get all login sessions
LoginsApi getUiPreferences GET /logins/ui-preferences Get UI prefereces for login
LoginsApi resendPin POST /login/2fa/resend-pin Resends 2FA sign-in code.
LoginsApi setCustomerLoginPassword PUT /v2/logins/{login_id}/password Set password for login
LoginsApi setLoginAvatar PUT /login/avatar Set login avatar
LoginsApi setUiPreferences POST /logins/ui-preferences Set new UI prefereces for login
LoginsApi startPasswordRecovery PUT /login/password-recovery Start a new password recovery for login
LoginsApi updateLoginInfo PATCH /login Update login info
LoginsApi updateUiPreferences PATCH /logins/ui-preferences Update UI prefereces for login
LoginsApi validatePasswordRecovery POST /login/password-recovery/validate Validate a password recovery secret
LoginsApi verify2FA POST /login/2fa Verifies 2FA sign-in code.
MembersApi createAccessToken POST /orgs/{org_id}/access_tokens Create organisation access token
MembersApi createMember POST /orgs/{org_id}/members Create organization member
MembersApi deleteAccessToken DELETE /orgs/{org_id}/access_tokens/{token_id} Delete access token member
MembersApi deleteMember DELETE /orgs/{org_id}/members/{member_id} Delete organization member
MembersApi deleteOwner DELETE /orgs/{org_id}/owner Delete organization owner
MembersApi getAccessTokens GET /orgs/{org_id}/access_tokens Get access token members
MembersApi getMember GET /orgs/{org_id}/members/{member_id} Get organization member
MembersApi getMembers GET /orgs/{org_id}/members Get organization members
MembersApi getOrgMemberLogin GET /orgs/{org_id}/members/{member_id}/sso Get a One-Time-Password link for the member
MembersApi updateMember PUT /orgs/{org_id}/members/{member_id} Overwrite organization member settings
MembersApi updateOwner PUT /orgs/{org_id}/owner Update organization owner
MetricsApi getWebsiteMetrics GET /orgs/{org_id}/websites/{website_id}/metrics Get website metrics
MigrationsApi createMigration POST /migrations Create website role migration
MigrationsApi createMigrationSession POST /migrations/sessions Create bulk website role migrations
MigrationsApi getMigration GET /migrations/{migrationId} Get a single migration
MigrationsApi getMigrationLog GET /migrations/{migrationId}/log Get the log for a migration
MigrationsApi getMigrationSessions GET /migrations/sessions Get website role migration sessions
MigrationsApi getMigrations GET /migrations Get website role migrations
MysqlApi createWebsiteMySQLDB POST /orgs/{org_id}/websites/{website_id}/mysql-dbs Create a MySQL database for website
MysqlApi createWebsiteMySQLUser POST /orgs/{org_id}/websites/{website_id}/mysql-users Create website MySQL database user
MysqlApi createWebsiteMySQLUserAccessHosts POST /orgs/{org_id}/websites/{website_id}/mysql-users/{username}/access-hosts Create website MySQL database user access hosts
MysqlApi deleteWebsiteMySQLDB DELETE /orgs/{org_id}/websites/{website_id}/mysql-dbs/{db_name} Delete website MySQL database
MysqlApi deleteWebsiteMySQLUser DELETE /orgs/{org_id}/websites/{website_id}/mysql-users/{username} Delete website MySQL database user
MysqlApi deleteWebsiteMySQLUserAccessHosts DELETE /orgs/{org_id}/websites/{website_id}/mysql-users/{username}/access-hosts Delete website MySQL database user access hosts
MysqlApi downloadSql GET /orgs/{org_id}/websites/{website_id}/mysql-dbs/{db_name}/sql Takes a backup of given database and returns it gziped
MysqlApi getPhpMyAdminSSOUrl GET /orgs/{org_id}/websites/{website_id}/mysql-dbs/{db_name}/sso Get phpMyAdmin SSO URL
MysqlApi getWebsiteMySQLDBs GET /orgs/{org_id}/websites/{website_id}/mysql-dbs Get website MySQL databases
MysqlApi getWebsiteMySQLUsers GET /orgs/{org_id}/websites/{website_id}/mysql-users Get website MySQL database users
MysqlApi setWebsiteMySQLUserPrivileges PUT /orgs/{org_id}/websites/{website_id}/mysql-users/{username}/privileges Create website MySQL database user privileges
MysqlApi updateWebsiteMySQLUser PUT /orgs/{org_id}/websites/{website_id}/mysql-users/{username} Update website MySQL database user
MysqlApi uploadSql POST /v2/websites/{websiteId}/mysql/{db_id}/sql Uploads sql file and executes it against db
OrgsApi createAccessToken POST /orgs/{org_id}/access_tokens Create organisation access token
OrgsApi createCloudflareApiKey POST /orgs/{org_id}/cloudflare Set CloudFlare API key, org level
OrgsApi createCustomer POST /orgs/{org_id}/customers Create a customer organization
OrgsApi createMember POST /orgs/{org_id}/members Create organization member
OrgsApi createPlan POST /orgs/{org_id}/plans Create plan
OrgsApi createPlanAllowances POST /orgs/{org_id}/plans/{plan_id}/allowances Create plan allowances
OrgsApi createPlanResources POST /orgs/{org_id}/plans/{plan_id}/resources Create plan resources
OrgsApi createPlanSelections POST /orgs/{org_id}/plans/{plan_id}/selections Create plan selections
OrgsApi createTag POST /orgs/{org_id}/tags Create tag
OrgsApi deleteCloudflareApiKey DELETE /orgs/{org_id}/cloudflare/{cloudflare_key} Delete CloudFlare API key, org level
OrgsApi deleteMember DELETE /orgs/{org_id}/members/{member_id} Delete organization member
OrgsApi deleteOrg DELETE /orgs/{org_id} Delete organization
OrgsApi deleteOrgAvatar DELETE /orgs/{org_id}/avatar Remove org avatar
OrgsApi deleteOwner DELETE /orgs/{org_id}/owner Delete organization owner
OrgsApi deletePlan DELETE /orgs/{org_id}/plans/{plan_id} Delete plan
OrgsApi deletePlanAllowance DELETE /orgs/{org_id}/plans/{plan_id}/allowances/{name} Delete plan allowance
OrgsApi deleteWebsiteMySQLUserAccessHosts DELETE /orgs/{org_id}/websites/{website_id}/mysql-users/{username}/access-hosts Delete website MySQL database user access hosts
OrgsApi getCloudFlareKeyAffectedDomains GET /orgs/{org_id}/cloudflare/{cloudflare_key} Get affected domains for a CloudFlare key
OrgsApi getCloudflareApiKeys GET /orgs/{org_id}/cloudflare Get CloudFlare API keys, org level
OrgsApi getCustomersAdded GET /orgs/{org_id}/stats/customers/added Get customers added over a given time period
OrgsApi getEmails GET /orgs/{org_id}/emails Get org emails
OrgsApi getMember GET /orgs/{org_id}/members/{member_id} Get organization member
OrgsApi getMembers GET /orgs/{org_id}/members Get organization members
OrgsApi getOrg GET /orgs/{org_id} Get organization info
OrgsApi getOrgActivities GET /v2/orgs/{org_id}/activities Get organization's activity log.
OrgsApi getOrgMemberLogin GET /orgs/{org_id}/members/{member_id}/sso Get a One-Time-Password link for the member
OrgsApi getPlan GET /orgs/{org_id}/plans/{plan_id} Get plan
OrgsApi getPlans GET /orgs/{org_id}/plans Get plans
OrgsApi getTags GET /orgs/{org_id}/tags Get tags
OrgsApi getWebsiteDomainSslCert GET /v2/domains/{domain_id}/ssl Returns the SSL for this website domain
OrgsApi getWebsiteMailDomainSslCert GET /v2/domains/{domain_id}/mail_ssl Returns the SSL for this website domain with the mail.prefix
OrgsApi getWebsitesAdded GET /orgs/{org_id}/stats/websites/added Get websites added over a given time period
OrgsApi setOrgAvatar PUT /orgs/{org_id}/avatar Set org avatar
OrgsApi setWebsiteDomainForceSsl PUT /v2/domains/{domain_id}/ssl/force_ssl Set &quot;force ssl&quot; status for domain mapping
OrgsApi updateCloudflareApiKey PUT /orgs/{org_id}/cloudflare/{cloudflare_key} Update CloudFlare API key
OrgsApi updateMember PUT /orgs/{org_id}/members/{member_id} Overwrite organization member settings
OrgsApi updateOrg PATCH /orgs/{org_id} Update organization
OrgsApi updateOwner PUT /orgs/{org_id}/owner Update organization owner
OrgsApi updatePlan PATCH /orgs/{org_id}/plans/{plan_id} Update plan name
OrgsApi updatePlanAllowance PUT /orgs/{org_id}/plans/{plan_id}/allowances/{name} Update plan allowance
OrgsApi updatePlanResource PUT /orgs/{org_id}/plans/{plan_id}/resources/{name} Update plan resource
OrgsApi updatePlanSelection PUT /orgs/{org_id}/plans/{plan_id}/selections/{name} Update plan selection
OrgsApi uploadWebsiteDomainSslCert POST /v2/domains/{domain_id}/ssl Upload custom ssl certificate, key and optional fullchain for a given website
OrgsApi uploadWebsiteMailDomainSslCert POST /v2/domains/{domain_id}/mail_ssl Upload SSL for mail.customerdomain.
OwnerApi deleteOwner DELETE /orgs/{org_id}/owner Delete organization owner
OwnerApi updateOwner PUT /orgs/{org_id}/owner Update organization owner
PlansApi createPlan POST /orgs/{org_id}/plans Create plan
PlansApi createPlanAllowances POST /orgs/{org_id}/plans/{plan_id}/allowances Create plan allowances
PlansApi createPlanResources POST /orgs/{org_id}/plans/{plan_id}/resources Create plan resources
PlansApi createPlanSelections POST /orgs/{org_id}/plans/{plan_id}/selections Create plan selections
PlansApi deletePlan DELETE /orgs/{org_id}/plans/{plan_id} Delete plan
PlansApi deletePlanAllowance DELETE /orgs/{org_id}/plans/{plan_id}/allowances/{name} Delete plan allowance
PlansApi getPlan GET /orgs/{org_id}/plans/{plan_id} Get plan
PlansApi getPlans GET /orgs/{org_id}/plans Get plans
PlansApi updatePlan PATCH /orgs/{org_id}/plans/{plan_id} Update plan name
PlansApi updatePlanAllowance PUT /orgs/{org_id}/plans/{plan_id}/allowances/{name} Update plan allowance
PlansApi updatePlanResource PUT /orgs/{org_id}/plans/{plan_id}/resources/{name} Update plan resource
PlansApi updatePlanSelection PUT /orgs/{org_id}/plans/{plan_id}/selections/{name} Update plan selection
ReportsApi getLoginPolicyBlockedIps GET /reports/orchd/login-policy/blocked-ips Get blocked ips
ReportsApi getLoginPolicyBlockedLogins GET /reports/orchd/login-policy/blocked-logins Get blocked logins
ServersApi addSpamIpWhitelist POST /servers/{server_id}/spam/ip_whitelist Add to the IP whitelist
ServersApi configureServer PATCH /servers/{server_id} Configure a server
ServersApi createServerDomain POST /servers/{server_id}/domains Create a domain which is mapped to a server
ServersApi createServerGroup POST /servers/groups Creates a new server group
ServersApi createServerNetworkInterfaceIp POST /servers/{server_id}/interfaces/{interface}/ips Create server network interface secondary IP
ServersApi createSlave POST /servers/slaves Create a slave node
ServersApi deleteFromSpamIpWhitelist DELETE /servers/{server_id}/spam/ip_whitelist Delete from the IP whitelist
ServersApi deleteServerDomain DELETE /servers/{server_id}/domains/{domain_id} Delete a mapped server domain
ServersApi deleteServerFromGroup DELETE /servers/{server_id}/group Delete server from group
ServersApi deleteServerGroup DELETE /servers/groups/{group_id} Deletes an existing server group
ServersApi deleteServerNetworkInterfaceIp DELETE /servers/{server_id}/interfaces/{interface}/ips/{ip} Delete server network interface secondary IP
ServersApi deleteServerPrimaryIpv6 DELETE /v2/servers/{server_id}/primary-ipv6 Deletes/unsets the primary IPv6 address for a server.
ServersApi deleteServiceSetting DELETE /servers/{server_id}/settings/{setting_kind}/{setting_key} Delete a single override setting
ServersApi deleteSlave DELETE /servers/{server_id} Delete a (slave) server
ServersApi enableFsQuotaLimits POST /servers/{server_id}/fs-quota-limits Enable FS quota limits on the server
ServersApi getAppcdScreenshotConfig GET /servers/{server_id}/appcd/screenshot/config Get the screenshot config of the running appcd
ServersApi getAppcdVersion GET /servers/{server_id}/appcd/version Get the version of the running appcd
ServersApi getClientIp GET /client_ip Reflect back the IP of the API consumer
ServersApi getDatabaseRoleMysqlKind GET /v2/servers/{server_id}/database-role Gets the MySQL kind for a given server.
ServersApi getDnsPoolIps GET /v2/servers/dns_pool Get DNS pool IPs
ServersApi getEmailServerHostnameOverride GET /servers/{server_id}/email/hostname_override Get the hostname override for the email server (postfix) if set
ServersApi getFsQuotaStatus GET /servers/{server_id}/fs-quota-limits Get whether FS quota was enabled on the server
ServersApi getHttpdStatus GET /servers/{server_id}/roles/{role}/httpd_status Get status of a running httpd server.
ServersApi getInstallCmd GET /servers/install-cmd Get slave installation command
ServersApi getMysqlMyCnf GET /v2/servers/{server_id}/my-cnf Download my.cnf for a given server
ServersApi getOutboundSpamScanningSettings GET /servers/{server_id}/email/spam/outbound_scanning Get the status of outbound spam scanning
ServersApi getOwaspRulesVersion GET /v2/servers/{server_id}/owasp Get the current and available version of the OWASP rules
ServersApi getRegistrationKey GET /servers/registration-key Get slave registration key
ServersApi getServerDiskUsage GET /servers/{server_id}/disk-usage Get server disk usage
ServersApi getServerFpmSettings GET /servers/{server_id}/php/fpm Get php-fpm config for all the websites on a server
ServersApi getServerGroups GET /servers/groups Returns all server groups
ServersApi getServerHostnameWebsite GET /servers/{server_id}/domains Get domains which are mapped to a server
ServersApi getServerInfo GET /servers/{server_id} Get server info
ServersApi getServerIowait GET /servers/{server_id}/iowait Get server iowait
ServersApi getServerLoad GET /servers/{server_id}/load Get server system load
ServersApi getServerMemoryUsage GET /servers/{server_id}/memory-usage Get server memory usage
ServersApi getServerModSecurityConfig GET /v2/servers/{server_id}/modsec_conf Get mod security config
ServersApi getServerModSecurityStatus GET /v2/servers/{server_id}/modsec_status Get mod security status for a server
ServersApi getServerNetworkInterfaces GET /servers/{server_id}/interfaces Get server network interfaces
ServersApi getServerNetworkStats GET /servers/{server_id}/network-stats Get server network stats
ServersApi getServerRole GET /servers/{server_id}/roles/{role} Get server role info
ServersApi getServerRoles GET /servers/{server_id}/roles Get server roles info
ServersApi getServerStats GET /servers/{server_id}/historic-stats Get Server stats
ServersApi getServerStatus GET /servers/{server_id}/status Get server status
ServersApi getServerUptime GET /servers/{server_id}/uptime Get server uptime in seconds
ServersApi getServers GET /servers Get installed servers
ServersApi getServiceSetting GET /servers/{server_id}/settings/{setting_kind} Get the value for a particular setting
ServersApi getSmtpRateLimitHourly GET /servers/{server_id}/spam/smtp_rate_limit_hourly Get the hourly SMTP rate limit
ServersApi getSpamIpWhitelist GET /servers/{server_id}/spam/ip_whitelist Get the IP whitelist
ServersApi getSystemPackageUpdateInfo GET /servers/{server_id}/packages/update Returns a map of upgradable packages.
ServersApi getWebserverKind GET /servers/{server_id}/webserver Get web server
ServersApi getWebsiteFpmSettings GET /servers/{server_id}/php/fpm/{website_id} Get php-fpm config for the specified website
ServersApi getWebsiteGeneratedRateLimitHourly GET /servers/{server_id}/spam/website_generated_rate_limit_hourly Get the hourly website generated email rate limit
ServersApi installDatabaseRole PUT /v2/servers/{server_id}/database-role Enables the database role on a given ServerUuid
ServersApi installServerRole PUT /servers/{server_id}/roles/{role} Install server role
ServersApi resetServerModSecurityConfig DELETE /v2/servers/{server_id}/modsec_conf Delete custom mod_security config and reset to default
ServersApi resetWebServerConfig POST /servers/{server_id}/webserver/config/reset Reset the config for the web server to default.
ServersApi restartMysql POST /v2/servers/{server_id}/database-role/restart Restart MySQL gracefully
ServersApi saveMysqlMyCnf PUT /v2/servers/{server_id}/my-cnf Save a new my.cnf
ServersApi setEmailServerHostnameOverride PUT /servers/{server_id}/email/hostname_override Set the hostname override for the email server (postfix)
ServersApi setLiteSpeedAdminPassword POST /servers/{server_id}/webserver/litespeed/password Set a new LiteSpeed admin password.
ServersApi setOutboundSpamScanningSettings PUT /servers/{server_id}/email/spam/outbound_scanning Set the settings for outbound spam scanning
ServersApi setServerDecommissioned PUT /servers/{server_id}/decommissioned Set server to decommissioned
ServersApi setServerModSecurityConfig PUT /v2/servers/{server_id}/modsec_conf Set mod security config
ServersApi setServerModSecurityStatus PUT /v2/servers/{server_id}/modsec_status Set mod security status for a server
ServersApi setServerStatus POST /servers/{server_id}/status Set the status of one server.
ServersApi setServiceSetting PUT /servers/{server_id}/settings/{setting_kind}/{setting_key} Set a single service setting
ServersApi setSmtpRateLimitHourly PUT /servers/{server_id}/spam/smtp_rate_limit_hourly Set the hourly SMTP rate limit
ServersApi setWebserverKind PUT /servers/{server_id}/webserver Set the web server kind for one server.
ServersApi setWebsiteGeneratedRateLimitHourly PUT /servers/{server_id}/spam/website_generated_rate_limit_hourly Set the hourly SMTP rate limit
ServersApi uninstallServerRole DELETE /servers/{server_id}/roles/{role} Uninstall a server role
ServersApi updateAppcdScreenshotConfig PATCH /servers/{server_id}/appcd/screenshot/config Update the screenshot config of the running appcd
ServersApi updateOwaspRules POST /v2/servers/{server_id}/owasp Upgrade OWASP rules
ServersApi updateServerGroup PUT /servers/groups/{group_id} Updates an existing server group's name
ServersApi updateServerPrimaryIp PUT /servers/{server_id}/primary-ip Updates the primary IP of the server in the database and in-memory metadata. This operation will not affect the IP used for service communication until the next restart of orchd. The new IP will be used for creation of new resources such as websites on this server but existing websites will not have their IP changed.
ServersApi updateServerPrimaryIpv6 PUT /v2/servers/{server_id}/primary-ipv6 Updates or sets the primary ipv6 address of the server. This endpoint will not change existing websites' DNS but the new record will be applied to all future zones.
ServersApi updateServerRole PATCH /servers/{server_id}/roles/{role} Update server role
ServersApi updateSystemPackage PUT /servers/{server_id}/packages/update Updates a system package to its latest version.
ServersApi validateRegistrationKey POST /servers/registration-key/validate Validate slave registration key
SettingsApi addOrchdLoginPolicyEmailBlacklist PUT /settings/orchd/login-policy/email-blacklist Set the orchd login policy email blacklist as a whole
SettingsApi addOrchdLoginPolicyEmailWhitelist PUT /settings/orchd/login-policy/email-whitelist Set the orchd login policy email whitelist as a whole
SettingsApi addOrchdLoginPolicyIpBlacklist PUT /settings/orchd/login-policy/ip-blacklist Set the orchd login policy ip blacklist as a whole
SettingsApi addOrchdLoginPolicyIpWhitelist PUT /settings/orchd/login-policy/ip-whitelist Set the orchd login policy ip whitelist as a whole
SettingsApi addOrchdLoginPolicySettings PUT /settings/orchd/login-policy/settings Set a single orchd login policy setting
SettingsApi createBackupRemoteStorageS3 POST /v2/settings/backup/remote_storage/s3 Create S3 object storage settings at platform level.
SettingsApi createSettings POST /settings Create settings
SettingsApi deleteBackupRemoteStorageS3 DELETE /v2/settings/backup/remote_storage/s3 Delete S3 object storage settings at platform level.
SettingsApi deleteGlobalServiceSetting DELETE /settings/service/{setting_kind}/{setting_key} Delete a single global service setting
SettingsApi deleteOrchdLoginPolicyEmailBlacklist DELETE /settings/orchd/login-policy/email-blacklist Delete an orchd login policy email blacklist
SettingsApi deleteOrchdLoginPolicyEmailWhitelist DELETE /settings/orchd/login-policy/email-whitelist Delete an orchd login policy email whitelist
SettingsApi deleteOrchdLoginPolicyIpBlacklist DELETE /settings/orchd/login-policy/ip-blacklist Delete an orchd login policy ip blacklist
SettingsApi deleteOrchdLoginPolicyIpWhitelist DELETE /settings/orchd/login-policy/ip-whitelist Delete an orchd login policy ip whitelist
SettingsApi deleteSetting DELETE /settings/{name} Remove the specified setting
SettingsApi getBackupRemoteStorageS3 GET /v2/settings/backup/remote_storage/s3 Get S3 object storage settings at platform level.
SettingsApi getDemoMode GET /v2/settings/demo_mode Get the demo mode status of the orchd service
SettingsApi getGlobalServiceSetting GET /settings/service/{setting_kind} Get the value for a particular global service setting
SettingsApi getOrchdLogSettings GET /settings/orchd/logs Get the orchd log settings
SettingsApi getOrchdLoginPolicyEmailBlacklist GET /settings/orchd/login-policy/email-blacklist Get the orchd login policy email blacklist
SettingsApi getOrchdLoginPolicyEmailWhitelist GET /settings/orchd/login-policy/email-whitelist Get the orchd login policy email whitelist
SettingsApi getOrchdLoginPolicyIpBlacklist GET /settings/orchd/login-policy/ip-blacklist Get the orchd login policy ip blacklist
SettingsApi getOrchdLoginPolicyIpWhitelist GET /settings/orchd/login-policy/ip-whitelist Get the orchd login policy ip whitelist
SettingsApi getOrchdLoginPolicySettings GET /settings/orchd/login-policy/settings Get the orchd login policy settings
SettingsApi getProhibitedDomains GET /settings/orchd/prohibited_domains Get the platform level prohibited domains as a newline separated list
SettingsApi getSetting GET /settings/{name} Get the specified setting
SettingsApi getSettings GET /settings Get all current settings
SettingsApi setGlobalServiceSetting PUT /settings/service/{setting_kind}/{setting_key} Set a single global service setting
SettingsApi setOrchdLogSettings PUT /settings/orchd/logs Set the orchd log settings
SettingsApi setProhibitedDomains PUT /settings/orchd/prohibited_domains Set the platform level prohibited domains
SettingsApi updateBackupRemoteStorageS3 PATCH /v2/settings/backup/remote_storage/s3 Update S3 object storage settings at platform level.
SettingsApi updateSetting PUT /settings/{name} Create or update the specified setting
SslApi getWebsiteDomainSslCert GET /v2/domains/{domain_id}/ssl Returns the SSL for this website domain
SslApi getWebsiteMailDomainSslCert GET /v2/domains/{domain_id}/mail_ssl Returns the SSL for this website domain with the mail.prefix
SslApi setWebsiteDomainForceSsl PUT /v2/domains/{domain_id}/ssl/force_ssl Set &quot;force ssl&quot; status for domain mapping
SslApi uploadWebsiteDomainSslCert POST /v2/domains/{domain_id}/ssl Upload custom ssl certificate, key and optional fullchain for a given website
SslApi uploadWebsiteMailDomainSslCert POST /v2/domains/{domain_id}/mail_ssl Upload SSL for mail.customerdomain.
SubscriptionsApi calculateResourceUsage PUT /orgs/{org_id}/subscriptions/{subscription_id}/calculate-resource-usage Re-Calculates all subscription resources
SubscriptionsApi createCustomerSubscription POST /orgs/{org_id}/customers/{customer_org_id}/subscriptions Create a subscriptions for a customer
SubscriptionsApi deleteSubscription DELETE /orgs/{org_id}/subscriptions/{subscription_id} Delete subscription
SubscriptionsApi getCustomerSubscriptions GET /orgs/{org_id}/customers/{customer_org_id}/subscriptions Get customer subscriptions
SubscriptionsApi getSubscription GET /orgs/{org_id}/subscriptions/{subscription_id} Get subscription
SubscriptionsApi getSubscriptionBandwidthUsage GET /orgs/{org_id}/subscriptions/{subscription_id}/bandwidth Get subscription bandwidth
SubscriptionsApi getSubscriptionsToParent GET /orgs/{org_id}/subscriptions Get subscriptions to parent
SubscriptionsApi updateSubscription PATCH /orgs/{org_id}/subscriptions/{subscription_id} Update subscription
TagsApi createTag POST /orgs/{org_id}/tags Create tag
TagsApi getTags GET /orgs/{org_id}/tags Get tags
WebsitesApi addDomainNginxFastCgiExcludedPath POST /v2/domains/{domain_id}/nginx_fastcgi_excluded_paths Add Nginx FastCGI excluded path
WebsitesApi authorizeWebsiteSshKey POST /orgs/{org_id}/websites/{website_id}/ssh/keys Authorize a new SSH key.
WebsitesApi authorizeWebsiteSshPassword POST /orgs/{org_id}/websites/{website_id}/ssh/password Authorize a new SSH password for website.
WebsitesApi clearDomainNginxFastCgi DELETE /v2/domains/{domain_id}/nginx_fastcgi Clear FastCGI cache for domain
WebsitesApi cloneWebsite POST /orgs/{org_id}/websites/clone Clone website or push live
WebsitesApi createFtpUser POST /orgs/{org_id}/websites/{website_id}/ftp/users Creates a new FTP user for a given website
WebsitesApi createPreviewDomain POST /orgs/{org_id}/websites/{website_id}/preview Create a preview domain
WebsitesApi createWebsite POST /orgs/{org_id}/websites Create a new website or clone an existing one.
WebsitesApi createWebsiteDomainLetsencryptCerts POST /v2/domains/{domain_id}/letsencrypt Generate and setup letsencrypt ssl certificates for website's domain
WebsitesApi createWebsiteMailDomainLetsencryptCerts POST /v2/domains/{domain_id}/letsencrypt_mail Generate and setup letsencrypt ssl certificates for website's domain with mail. prefix.
WebsitesApi createWebsiteMappedDomain POST /orgs/{org_id}/websites/{website_id}/domains Create website mapped domain
WebsitesApi createWebsiteMySQLDB POST /orgs/{org_id}/websites/{website_id}/mysql-dbs Create a MySQL database for website
WebsitesApi deleteDomainNginxFastCgiExcludedPath DELETE /v2/domains/{domain_id}/nginx_fastcgi_excluded_paths Delete Nginx FastCGI excluded path
WebsitesApi deleteDomainWebserverRewrite DELETE /v2/domains/{domain_id}/webserver_rewrites Delete web server rewrite
WebsitesApi deleteFtpUser DELETE /orgs/{org_id}/websites/{website_id}/ftp/users/{username} Deletes given FTP user
WebsitesApi deleteUserCrontab DELETE /orgs/{org_id}/websites/{website_id}/crontab Delete user's crontab
WebsitesApi deleteWebsite DELETE /orgs/{org_id}/websites/{website_id} Delete website
WebsitesApi deleteWebsiteDomainMapping DELETE /orgs/{org_id}/websites/{website_id}/domains/{domain_id} Delete website domain mapping
WebsitesApi deleteWebsiteDomainVhost DELETE /v2/domains/{domain_id}/vhost Deletes domain's custom vhost file if any
WebsitesApi deleteWebsiteSetting DELETE /orgs/{org_id}/websites/{website_id}/settings/{setting_kind}/{setting_key} Delete a single override setting
WebsitesApi deleteWebsites DELETE /orgs/{org_id}/websites Delete websites
WebsitesApi disableWebsitePhpExtension DELETE /websites/{website_id}/php_extensions Disable a PHP extension
WebsitesApi enableWebsitePhpExtension POST /websites/{website_id}/php_extensions Enable a PHP extension
WebsitesApi getDomainNginxFastCgi GET /v2/domains/{domain_id}/nginx_fastcgi Get status of Nginx FastCGI enablement
WebsitesApi getDomainNginxFastCgiExcludedPaths GET /v2/domains/{domain_id}/nginx_fastcgi_excluded_paths Get Nginx FastCGI excluded paths
WebsitesApi getDomainWebserverRewrites GET /v2/domains/{domain_id}/webserver_rewrites Get web server rewrites for specified domain
WebsitesApi getFtpUsers GET /orgs/{org_id}/websites/{website_id}/ftp/users Returns all ftp users data for a given website
WebsitesApi getScreenshotTimestamp GET /orgs/{org_id}/websites/{website_id}/domains/{domain_id}/screenshot/timestamp Get last screeshot file's Timestamp
WebsitesApi getSiteAccessToken POST /orgs/{org_id}/websites/{website_id}/access-tokens Get an access token for the given website
WebsitesApi getUserCrontab GET /orgs/{org_id}/websites/{website_id}/crontab Get user's crontab
WebsitesApi getWebsite GET /orgs/{org_id}/websites/{website_id} Get website
WebsitesApi getWebsiteAvailablePhpExtensions GET /websites/{website_id}/available_php_extensions Get available PHP extensions for a website
WebsitesApi getWebsiteBackupStatus GET /orgs/{org_id}/websites/{website_id}/status/backup Get the status of an ongoing website backup operation
WebsitesApi getWebsiteCgroupLimits GET /orgs/{org_id}/websites/{website_id}/cgroup_limits Get the active cgroup limits for a website
WebsitesApi getWebsiteClone GET /orgs/{org_id}/websites/clone/{clone_id} Get's detail about a single push live
WebsitesApi getWebsiteCloneLog GET /orgs/{org_id}/websites/clone/{clone_id}/log Get the log for a given clone id..
WebsitesApi getWebsiteClones GET /orgs/{org_id}/websites/clone List website clones for given OrgId
WebsitesApi getWebsiteDomainDnsQuery GET /orgs/{org_id}/websites/{website_id}/domains/{domain_id}/dns-query Recursively query Dns servers for given domain
WebsitesApi getWebsiteDomainMapping GET /orgs/{org_id}/websites/{website_id}/domains/{domain_id} Returns website domain mapping
WebsitesApi getWebsiteDomainMappingDnsStatus GET /orgs/{org_id}/websites/{website_id}/domains/{domain_id}/dns-status Returns website domain mapping DNS status
WebsitesApi getWebsiteDomainMappings GET /orgs/{org_id}/websites/{website_id}/domains Get website's mapped domains
WebsitesApi getWebsiteDomainModSecStatus GET /v2/domains/{domain_id}/modsec_status Get mod security status for a single domain
WebsitesApi getWebsiteDomainSslCert GET /v2/domains/{domain_id}/ssl Returns the SSL for this website domain
WebsitesApi getWebsiteDomainVhost GET /v2/domains/{domain_id}/vhost Get domain's custom vhost file, if the file does not exist return empty string
WebsitesApi getWebsiteEnabledPhpExtensions GET /websites/{website_id}/php_extensions Get enabled PHP extensions
WebsitesApi getWebsiteFsQuotaLimits GET /orgs/{org_id}/websites/{website_id}/fs_quota_limits Get the active FS quoa limits for a website
WebsitesApi getWebsiteHtaccessIpsRule GET /orgs/{org_id}/websites/{website_id}/htaccess/ips Returns current rules of blocked/whitelisted IPs
WebsitesApi getWebsiteHtaccessRewrites GET /orgs/{org_id}/websites/{website_id}/htaccess Reads chains of rewrite rules
WebsitesApi getWebsiteIoncubeStatus GET /v2/websites/{website_id}/ioncube Get ioncube status for an existing website
WebsitesApi getWebsiteMailDomainSslCert GET /v2/domains/{domain_id}/mail_ssl Returns the SSL for this website domain with the mail.prefix
WebsitesApi getWebsiteMetrics GET /orgs/{org_id}/websites/{website_id}/metrics Get website metrics
WebsitesApi getWebsiteMySQLDBs GET /orgs/{org_id}/websites/{website_id}/mysql-dbs Get website MySQL databases
WebsitesApi getWebsiteRedisState GET /v2/websites/{website_id}/redis Get redis state for a website
WebsitesApi getWebsiteServerDomains GET /orgs/{org_id}/websites/{website_id}/server_domains Fetch website server domains
WebsitesApi getWebsiteSetting GET /orgs/{org_id}/websites/{website_id}/settings/{setting_kind} Get the value for a particular setting
WebsitesApi getWebsiteSshKeys GET /orgs/{org_id}/websites/{website_id}/ssh/keys Get website's authorized SSH keys
WebsitesApi getWebsiteWebserverKind GET /v2/websites/{website_id}/webserver_kind Get web server kind for a given website
WebsitesApi getWebsites GET /orgs/{org_id}/websites Get websites
WebsitesApi performLetsEncryptPreflightCheck POST /v2/domains/{domain_id}/letsencrypt_preflight Perform the LetsEncrypt preflight check
WebsitesApi pushWebsiteLive POST /orgs/{org_id}/websites/{website_id}/push-live Making a staging website live
WebsitesApi restartWebsitePhp POST /v2/websites/{website_id}/restart_php Restart PHP container for a website
WebsitesApi setDomainNginxFastCgi PUT /v2/domains/{domain_id}/nginx_fastcgi Set Nginx FastCGI enablement
WebsitesApi setDomainWebserverRewrite PUT /v2/domains/{domain_id}/webserver_rewrites Set web server rewrite to file
WebsitesApi setWebsiteCgroupLimits PUT /orgs/{org_id}/websites/{website_id}/cgroup_limits Set the active cgroup limits for a website (Master org only)
WebsitesApi setWebsiteDomainForceSsl PUT /v2/domains/{domain_id}/ssl/force_ssl Set &quot;force ssl&quot; status for domain mapping
WebsitesApi setWebsiteDomainModSecStatus PUT /v2/domains/{domain_id}/modsec_status Set mod security status on a single domain
WebsitesApi setWebsiteDomainVhost PUT /v2/domains/{domain_id}/vhost Set a custom vhost file
WebsitesApi setWebsiteFsQuotaLimits PUT /orgs/{org_id}/websites/{website_id}/fs_quota_limits Set the active FS quota limits for a website (Master org only)
WebsitesApi setWebsiteIoncubeStatus PUT /v2/websites/{website_id}/ioncube Set ioncube status for an existing website
WebsitesApi setWebsiteRedisState PUT /v2/websites/{website_id}/redis Set Redis state for an existing website
WebsitesApi setWebsiteSetting PUT /orgs/{org_id}/websites/{website_id}/settings/{setting_kind}/{setting_key} Set a single override setting
WebsitesApi takeScreenshot POST /orgs/{org_id}/websites/{website_id}/domains/{domain_id}/screenshot/take Take website screenshot immediately
WebsitesApi unauthorizeWebsiteSshKey DELETE /orgs/{org_id}/websites/{website_id}/ssh/keys/{key_id} Unauthorize the public SSH key with the given ID.
WebsitesApi updateFtpUser PATCH /orgs/{org_id}/websites/{website_id}/ftp/users/{username} Update given FTP user
WebsitesApi updateUserCrontab PATCH /orgs/{org_id}/websites/{website_id}/crontab Update user's crontab
WebsitesApi updateWebsite PATCH /orgs/{org_id}/websites/{website_id} Update website
WebsitesApi updateWebsiteDomainMapping PATCH /orgs/{org_id}/websites/{website_id}/domains/{domain_id} Update website domain mapping
WebsitesApi updateWebsiteHtaccessIpsRule PUT /orgs/{org_id}/websites/{website_id}/htaccess/ips Sets a rule over provided ips - either block or allow
WebsitesApi updateWebsiteHtaccessRewrites PATCH /orgs/{org_id}/websites/{website_id}/htaccess Updates rewrite rules
WebsitesApi updateWebsitePrimaryDomain PUT /orgs/{org_id}/websites/{website_id}/domains/primary Update primary domain mapping
WebsitesApi updateWebsiteSshKey PATCH /orgs/{org_id}/websites/{website_id}/ssh/keys/{key_id} Update an existing website public SSH key.
WebsitesApi uploadWebsiteDomainSslCert POST /v2/domains/{domain_id}/ssl Upload custom ssl certificate, key and optional fullchain for a given website
WebsitesApi uploadWebsiteMailDomainSslCert POST /v2/domains/{domain_id}/mail_ssl Upload SSL for mail.customerdomain.
WebsitesApi validateWebsiteOperation POST /orgs/{org_id}/websites/{website_id}/validate-operation Validate whether a website operation is allowed
WordpressApi activateWordpressTheme POST /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/themes/{theme}/activate Activate a WordPress theme
WordpressApi createWordpressUser POST /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/users Create website WordPress user
WordpressApi deleteWordpressPlugin DELETE /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/plugins/{plugin} Delete website WordPress plugin
WordpressApi deleteWordpressTheme DELETE /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/themes/{theme} Delete a WordPress theme
WordpressApi deleteWordpressUser DELETE /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/users/{user_id} Delete WordPress user
WordpressApi getDefaultWpSsoUser GET /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/users/default
WordpressApi getWordPressMaintenanceMode GET /v2/apps/{app_id}/wordpress/maintenance-mode Gets the MaintenanceMode for a WordPress installation
WordpressApi getWordPressSiteurl GET /v2/apps/{app_id}/wordpress/url Fetches the site URL for a WordPress installation
WordpressApi getWordpressAppVersion GET /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/version Get WordPress version
WordpressApi getWordpressConfig GET /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/wp-config/{wp_option} Get the WP config value for a given option
WordpressApi getWordpressInstallations GET /orgs/{org_id}/websites/{website_id}/apps/wordpress Trigger discovery of WP installations
WordpressApi getWordpressLatestVersion GET /utils/wordpress/latest Get WordPress latest available version
WordpressApi getWordpressPlugins GET /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/plugins Get website WordPress plugins
WordpressApi getWordpressSettings GET /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress Get Wordpress application settings
WordpressApi getWordpressThemes GET /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/themes Get website WordPress themes
WordpressApi getWordpressUserSsoUrl GET /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/users/{user_id}/sso Get SSO URL for a WP user
WordpressApi getWordpressUsers GET /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/users
WordpressApi installWordpressPlugin POST /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/plugins Install a plugin
WordpressApi installWordpressTheme POST /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/themes Install a WordPress theme
WordpressApi setDefaultWpSsoUser PUT /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/users/default Set WP user as the default SSO user for that website.
WordpressApi setWordPressMaintenanceMode PUT /v2/apps/{app_id}/wordpress/maintenance-mode Sets the MaintenanceMode for a WordPress installation
WordpressApi setWordPressSiteurl PUT /v2/apps/{app_id}/wordpress/url Sets the site URL for a WordPress installation
WordpressApi setWordpressConfig PUT /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/wp-config Set a single value of a wp-config.php entry.
WordpressApi setWordpressThemeAutoUpdateStatus PATCH /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/themes/{theme}/auto_update Set WordPress theme auto-update status
WordpressApi updateWordpressAppVersion PATCH /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/version Update website WP app to specific version or latest
WordpressApi updateWordpressPluginSettings PATCH /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/plugins/{plugin} Updates website WordPress plugin settings
WordpressApi updateWordpressPluginToLatest PATCH /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/plugins/{plugin}/version Updates website WordPress plugin to latest version
WordpressApi updateWordpressSettings PATCH /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress Update Wordpress app settings
WordpressApi updateWordpressTheme POST /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/themes/{theme}/update Update a WordPress theme
WordpressApi updateWordpressUser PATCH /orgs/{org_id}/websites/{website_id}/apps/{app_id}/wordpress/users/{user_id} Update WordPress user

Models

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 corresponds to SDK package version
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

License

Apache License 2.0 (Apache-2.0). Please see License File for more information.

Upmind

Sell, manage and support web hosting, domain names, ssl certificates, website builders and more with Upmind.com - the ultimate web hosting billing and management solution.

About

Enhance.com PHP SDK automatically generated from the Enhance OpenAPI spec using OpenAPI Generator

Resources

Readme

License

Apache-2.0 license
Activity
Custom properties

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases 11

v12.0.0 Latest
Feb 19, 2025
+ 10 releases

Packages

No packages published

Languages