@hostinger/sdk 1.58.0 → 1.58.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api.ts +439 -9
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +272 -9
- package/dist/api.js +303 -9
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +272 -9
- package/dist/esm/api.js +303 -9
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/HostingGitApi.md +228 -0
- package/docs/HostingOrdersApi.md +1 -1
- package/docs/HostingV1GitDeployWebsiteGitRepositoryRequest.md +24 -0
- package/docs/HostingV1GitGitDeployOutputResource.md +23 -0
- package/docs/HostingV1GitGitSshKeyResource.md +21 -0
- package/docs/HostingV1GitWebsiteGitRepositoryResource.md +27 -0
- package/docs/HostingV1GitWebsiteGitRepositoryWebhookResource.md +27 -0
- package/docs/HostingWebsitesApi.md +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.58.
|
|
4
|
+
* API Version: 1.58.2
|
|
5
5
|
*
|
|
6
6
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
7
7
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -7342,6 +7342,31 @@ export interface HostingV1FilesUploadUrlResource {
|
|
|
7342
7342
|
*/
|
|
7343
7343
|
'rest_auth_key': string;
|
|
7344
7344
|
}
|
|
7345
|
+
/**
|
|
7346
|
+
*
|
|
7347
|
+
* @export
|
|
7348
|
+
* @interface HostingV1GitDeployWebsiteGitRepositoryRequest
|
|
7349
|
+
*/
|
|
7350
|
+
export interface HostingV1GitDeployWebsiteGitRepositoryRequest {
|
|
7351
|
+
/**
|
|
7352
|
+
* Clone URL of the repository on any Git host, SSH or HTTPS. Private repositories need an SSH URL and the account\'s Git SSH key added to the repository as a deploy key. An HTTP or HTTPS URL with a username or token, or any URL with a password, is rejected.
|
|
7353
|
+
* @type {string}
|
|
7354
|
+
* @memberof HostingV1GitDeployWebsiteGitRepositoryRequest
|
|
7355
|
+
*/
|
|
7356
|
+
'repository_url': string;
|
|
7357
|
+
/**
|
|
7358
|
+
* Branch to clone and pull
|
|
7359
|
+
* @type {string}
|
|
7360
|
+
* @memberof HostingV1GitDeployWebsiteGitRepositoryRequest
|
|
7361
|
+
*/
|
|
7362
|
+
'branch': string;
|
|
7363
|
+
/**
|
|
7364
|
+
* Directory under the website document root, exactly as `List website Git repositories` returns it for an existing repository. Empty, null or omitted means the document root.
|
|
7365
|
+
* @type {string}
|
|
7366
|
+
* @memberof HostingV1GitDeployWebsiteGitRepositoryRequest
|
|
7367
|
+
*/
|
|
7368
|
+
'directory': string | null;
|
|
7369
|
+
}
|
|
7345
7370
|
/**
|
|
7346
7371
|
* Every field is null when the website has no Git auto-deployment configured.
|
|
7347
7372
|
* @export
|
|
@@ -7429,6 +7454,25 @@ export interface HostingV1GitGitCommitResource {
|
|
|
7429
7454
|
*/
|
|
7430
7455
|
'author': HostingV1GitGitCommitAuthorResource;
|
|
7431
7456
|
}
|
|
7457
|
+
/**
|
|
7458
|
+
* Result of cloning or pulling a Git repository into the website
|
|
7459
|
+
* @export
|
|
7460
|
+
* @interface HostingV1GitGitDeployOutputResource
|
|
7461
|
+
*/
|
|
7462
|
+
export interface HostingV1GitGitDeployOutputResource {
|
|
7463
|
+
/**
|
|
7464
|
+
* Whether the clone or pull, and composer install when it ran, finished without errors
|
|
7465
|
+
* @type {boolean}
|
|
7466
|
+
* @memberof HostingV1GitGitDeployOutputResource
|
|
7467
|
+
*/
|
|
7468
|
+
'is_success': boolean;
|
|
7469
|
+
/**
|
|
7470
|
+
* Log of the deployment steps, and the Git or composer error when `is_success` is false
|
|
7471
|
+
* @type {string}
|
|
7472
|
+
* @memberof HostingV1GitGitDeployOutputResource
|
|
7473
|
+
*/
|
|
7474
|
+
'output': string;
|
|
7475
|
+
}
|
|
7432
7476
|
/**
|
|
7433
7477
|
*
|
|
7434
7478
|
* @export
|
|
@@ -7562,6 +7606,19 @@ export interface HostingV1GitGitRepositoryResource {
|
|
|
7562
7606
|
*/
|
|
7563
7607
|
'default_branch': string;
|
|
7564
7608
|
}
|
|
7609
|
+
/**
|
|
7610
|
+
* Public SSH key the hosting account uses to clone and pull Git repositories
|
|
7611
|
+
* @export
|
|
7612
|
+
* @interface HostingV1GitGitSshKeyResource
|
|
7613
|
+
*/
|
|
7614
|
+
export interface HostingV1GitGitSshKeyResource {
|
|
7615
|
+
/**
|
|
7616
|
+
* Public key to add as a deploy key on the Git host. Null when the account has no key yet.
|
|
7617
|
+
* @type {string}
|
|
7618
|
+
* @memberof HostingV1GitGitSshKeyResource
|
|
7619
|
+
*/
|
|
7620
|
+
'public_key': string | null;
|
|
7621
|
+
}
|
|
7565
7622
|
/**
|
|
7566
7623
|
*
|
|
7567
7624
|
* @export
|
|
@@ -7605,6 +7662,68 @@ export interface HostingV1GitUpdateGitAutoDeploymentSettingsRequest {
|
|
|
7605
7662
|
*/
|
|
7606
7663
|
'is_enabled': boolean;
|
|
7607
7664
|
}
|
|
7665
|
+
/**
|
|
7666
|
+
* Git repository linked to a directory of the website. A repository whose clone failed stays listed; deploying it again retries the clone.
|
|
7667
|
+
* @export
|
|
7668
|
+
* @interface HostingV1GitWebsiteGitRepositoryResource
|
|
7669
|
+
*/
|
|
7670
|
+
export interface HostingV1GitWebsiteGitRepositoryResource {
|
|
7671
|
+
/**
|
|
7672
|
+
* Clone URL of the repository. A username, password or token in an HTTP(S) URL, or a password in any URL, is shown as `***`.
|
|
7673
|
+
* @type {string}
|
|
7674
|
+
* @memberof HostingV1GitWebsiteGitRepositoryResource
|
|
7675
|
+
*/
|
|
7676
|
+
'repository_url': string;
|
|
7677
|
+
/**
|
|
7678
|
+
* Branch that is cloned and pulled
|
|
7679
|
+
* @type {string}
|
|
7680
|
+
* @memberof HostingV1GitWebsiteGitRepositoryResource
|
|
7681
|
+
*/
|
|
7682
|
+
'branch': string;
|
|
7683
|
+
/**
|
|
7684
|
+
* Directory under the website document root. Empty means the document root.
|
|
7685
|
+
* @type {string}
|
|
7686
|
+
* @memberof HostingV1GitWebsiteGitRepositoryResource
|
|
7687
|
+
*/
|
|
7688
|
+
'directory': string;
|
|
7689
|
+
/**
|
|
7690
|
+
*
|
|
7691
|
+
* @type {HostingV1GitWebsiteGitRepositoryWebhookResource}
|
|
7692
|
+
* @memberof HostingV1GitWebsiteGitRepositoryResource
|
|
7693
|
+
*/
|
|
7694
|
+
'webhook': HostingV1GitWebsiteGitRepositoryWebhookResource;
|
|
7695
|
+
}
|
|
7696
|
+
/**
|
|
7697
|
+
* Auto-deployment webhook of the repository, the same one the Git section of hPanel shows
|
|
7698
|
+
* @export
|
|
7699
|
+
* @interface HostingV1GitWebsiteGitRepositoryWebhookResource
|
|
7700
|
+
*/
|
|
7701
|
+
export interface HostingV1GitWebsiteGitRepositoryWebhookResource {
|
|
7702
|
+
/**
|
|
7703
|
+
* Webhook URL to add on the Git host for automatic deployment
|
|
7704
|
+
* @type {string}
|
|
7705
|
+
* @memberof HostingV1GitWebsiteGitRepositoryWebhookResource
|
|
7706
|
+
*/
|
|
7707
|
+
'url': string;
|
|
7708
|
+
/**
|
|
7709
|
+
* Git host detected from the repository URL. Null when it is not GitHub, GitLab or Bitbucket.
|
|
7710
|
+
* @type {string}
|
|
7711
|
+
* @memberof HostingV1GitWebsiteGitRepositoryWebhookResource
|
|
7712
|
+
*/
|
|
7713
|
+
'provider': string | null;
|
|
7714
|
+
/**
|
|
7715
|
+
* Page on the Git host where the webhook is added. Null when the host is not detected.
|
|
7716
|
+
* @type {string}
|
|
7717
|
+
* @memberof HostingV1GitWebsiteGitRepositoryWebhookResource
|
|
7718
|
+
*/
|
|
7719
|
+
'setup_url': string | null;
|
|
7720
|
+
/**
|
|
7721
|
+
* Git host guide for adding a webhook. Null when the host is not detected.
|
|
7722
|
+
* @type {string}
|
|
7723
|
+
* @memberof HostingV1GitWebsiteGitRepositoryWebhookResource
|
|
7724
|
+
*/
|
|
7725
|
+
'tutorial_url': string | null;
|
|
7726
|
+
}
|
|
7608
7727
|
/**
|
|
7609
7728
|
*
|
|
7610
7729
|
* @export
|
|
@@ -23928,6 +24047,24 @@ export declare const HostingGitApiAxiosParamCreator: (configuration?: Configurat
|
|
|
23928
24047
|
* @throws {RequiredError}
|
|
23929
24048
|
*/
|
|
23930
24049
|
deleteGitAutoDeploymentSettingsV1: (username: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24050
|
+
/**
|
|
24051
|
+
* Clones a Git repository into a directory of the website, or pulls it again. An empty or missing directory gets a clone of the branch. A directory that already holds this repository and branch is reset to its last commit and pulled: changes made on the server to files the repository tracks are discarded, files it does not track stay. A directory that holds other files, including another repository or another branch of this one, is rejected. `composer install` runs after the clone or pull when the repository has a `composer.json`. The call waits for the deployment and returns its log. `is_success` false means Git or composer failed and the log says why. A second call for the same directory is rejected while the first is still waiting for the server. If the request times out, the deployment may still finish on the server; calling again later with the same repository and branch pulls. Private repositories need an SSH URL and the account\'s Git SSH key from `Generate Git SSH key`, added to the repository as a deploy key.
|
|
24052
|
+
* @summary Deploy website Git repository
|
|
24053
|
+
* @param {string} username
|
|
24054
|
+
* @param {string} domain Domain name
|
|
24055
|
+
* @param {HostingV1GitDeployWebsiteGitRepositoryRequest} hostingV1GitDeployWebsiteGitRepositoryRequest
|
|
24056
|
+
* @param {*} [options] Override http request option.
|
|
24057
|
+
* @throws {RequiredError}
|
|
24058
|
+
*/
|
|
24059
|
+
deployWebsiteGitRepositoryV1: (username: string, domain: string, hostingV1GitDeployWebsiteGitRepositoryRequest: HostingV1GitDeployWebsiteGitRepositoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24060
|
+
/**
|
|
24061
|
+
* Creates the SSH key pair of the hosting account and returns the public key. When the account already has a key, returns that key unchanged. One key serves every website of the account; add the public key to a private repository as a deploy key before deploying it.
|
|
24062
|
+
* @summary Generate Git SSH key
|
|
24063
|
+
* @param {string} username
|
|
24064
|
+
* @param {*} [options] Override http request option.
|
|
24065
|
+
* @throws {RequiredError}
|
|
24066
|
+
*/
|
|
24067
|
+
generateGitSSHKeyV1: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23931
24068
|
/**
|
|
23932
24069
|
* Returns the Git auto-deployment settings of the website: which repository and branch deploy into which directory, and whether pushes trigger a deployment. `is_enabled` false keeps the repository link but ignores pushes. When the website has no auto-deployment configured every field is null. Save settings with `Update Git auto-deployment settings`.
|
|
23933
24070
|
* @summary Get Git auto-deployment settings
|
|
@@ -23937,6 +24074,14 @@ export declare const HostingGitApiAxiosParamCreator: (configuration?: Configurat
|
|
|
23937
24074
|
* @throws {RequiredError}
|
|
23938
24075
|
*/
|
|
23939
24076
|
getGitAutoDeploymentSettingsV1: (username: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24077
|
+
/**
|
|
24078
|
+
* Returns the public SSH key of the hosting account. `Deploy website Git repository` uses this key to clone and pull over SSH, so a private repository works once the key is added to it as a deploy key on the Git host. `public_key` is null when the account has no key yet.
|
|
24079
|
+
* @summary Get Git SSH public key
|
|
24080
|
+
* @param {string} username
|
|
24081
|
+
* @param {*} [options] Override http request option.
|
|
24082
|
+
* @throws {RequiredError}
|
|
24083
|
+
*/
|
|
24084
|
+
getGitSSHPublicKeyV1: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23940
24085
|
/**
|
|
23941
24086
|
* Lists the repositories the Git installation can access, read live from the provider. Works for github and gitlab installations. Use an active installation: a suspended or pending one is still queried and the call fails with whatever the provider answers. The list is cut at the first 500 repositories in the order the provider returns them; when the account has more, name the repository directly instead of searching this list. `owner`, `name` and a branch (`default_branch` or another one) go into `source_options` of `Start Node.js build` or into `Update Git auto-deployment settings`. Returns 404 when the installation does not belong to the customer. Limited to 10 calls per minute per API client (429 above that).
|
|
23942
24087
|
* @summary List Git installation repositories
|
|
@@ -23954,6 +24099,15 @@ export declare const HostingGitApiAxiosParamCreator: (configuration?: Configurat
|
|
|
23954
24099
|
* @throws {RequiredError}
|
|
23955
24100
|
*/
|
|
23956
24101
|
listGitInstallationsV1: (provider?: ListGitInstallationsV1ProviderEnum, status?: ListGitInstallationsV1StatusEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24102
|
+
/**
|
|
24103
|
+
* Lists the Git repositories linked to directories of the website, with `Deploy website Git repository` or in the Git section of hPanel: clone URL, branch and directory of each one. A repository whose clone failed stays listed; deploying it again retries the clone. GitHub and GitLab auto-deployments are not listed here; see `Get Git auto-deployment settings`.
|
|
24104
|
+
* @summary List website Git repositories
|
|
24105
|
+
* @param {string} username
|
|
24106
|
+
* @param {string} domain Domain name
|
|
24107
|
+
* @param {*} [options] Override http request option.
|
|
24108
|
+
* @throws {RequiredError}
|
|
24109
|
+
*/
|
|
24110
|
+
listWebsiteGitRepositoriesV1: (username: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23957
24111
|
/**
|
|
23958
24112
|
* Creates or replaces the Git auto-deployment settings of the website: repository, branch, the directory under the document root to deploy into, and `is_enabled`. Send the full set; `is_enabled` defaults to true and `directory` to the document root. `installation_uuid` must be an installation from `List Git installations` that belongs to the same customer as the website. For PHP and static websites, saving with `is_enabled` true deploys the branch right away and every later push to that branch deploys again. For Node.js and Website Builder websites saving does not clone anything. On a Node.js website start the first deploy with `Start Node.js build` using `source_type` `git`; pushes then trigger new builds with the build settings stored for the website.
|
|
23959
24113
|
* @summary Update Git auto-deployment settings
|
|
@@ -23979,6 +24133,24 @@ export declare const HostingGitApiFp: (configuration?: Configuration) => {
|
|
|
23979
24133
|
* @throws {RequiredError}
|
|
23980
24134
|
*/
|
|
23981
24135
|
deleteGitAutoDeploymentSettingsV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
24136
|
+
/**
|
|
24137
|
+
* Clones a Git repository into a directory of the website, or pulls it again. An empty or missing directory gets a clone of the branch. A directory that already holds this repository and branch is reset to its last commit and pulled: changes made on the server to files the repository tracks are discarded, files it does not track stay. A directory that holds other files, including another repository or another branch of this one, is rejected. `composer install` runs after the clone or pull when the repository has a `composer.json`. The call waits for the deployment and returns its log. `is_success` false means Git or composer failed and the log says why. A second call for the same directory is rejected while the first is still waiting for the server. If the request times out, the deployment may still finish on the server; calling again later with the same repository and branch pulls. Private repositories need an SSH URL and the account\'s Git SSH key from `Generate Git SSH key`, added to the repository as a deploy key.
|
|
24138
|
+
* @summary Deploy website Git repository
|
|
24139
|
+
* @param {string} username
|
|
24140
|
+
* @param {string} domain Domain name
|
|
24141
|
+
* @param {HostingV1GitDeployWebsiteGitRepositoryRequest} hostingV1GitDeployWebsiteGitRepositoryRequest
|
|
24142
|
+
* @param {*} [options] Override http request option.
|
|
24143
|
+
* @throws {RequiredError}
|
|
24144
|
+
*/
|
|
24145
|
+
deployWebsiteGitRepositoryV1(username: string, domain: string, hostingV1GitDeployWebsiteGitRepositoryRequest: HostingV1GitDeployWebsiteGitRepositoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1GitGitDeployOutputResource>>;
|
|
24146
|
+
/**
|
|
24147
|
+
* Creates the SSH key pair of the hosting account and returns the public key. When the account already has a key, returns that key unchanged. One key serves every website of the account; add the public key to a private repository as a deploy key before deploying it.
|
|
24148
|
+
* @summary Generate Git SSH key
|
|
24149
|
+
* @param {string} username
|
|
24150
|
+
* @param {*} [options] Override http request option.
|
|
24151
|
+
* @throws {RequiredError}
|
|
24152
|
+
*/
|
|
24153
|
+
generateGitSSHKeyV1(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1GitGitSshKeyResource>>;
|
|
23982
24154
|
/**
|
|
23983
24155
|
* Returns the Git auto-deployment settings of the website: which repository and branch deploy into which directory, and whether pushes trigger a deployment. `is_enabled` false keeps the repository link but ignores pushes. When the website has no auto-deployment configured every field is null. Save settings with `Update Git auto-deployment settings`.
|
|
23984
24156
|
* @summary Get Git auto-deployment settings
|
|
@@ -23988,6 +24160,14 @@ export declare const HostingGitApiFp: (configuration?: Configuration) => {
|
|
|
23988
24160
|
* @throws {RequiredError}
|
|
23989
24161
|
*/
|
|
23990
24162
|
getGitAutoDeploymentSettingsV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1GitGitAutoDeploymentSettingsResource>>;
|
|
24163
|
+
/**
|
|
24164
|
+
* Returns the public SSH key of the hosting account. `Deploy website Git repository` uses this key to clone and pull over SSH, so a private repository works once the key is added to it as a deploy key on the Git host. `public_key` is null when the account has no key yet.
|
|
24165
|
+
* @summary Get Git SSH public key
|
|
24166
|
+
* @param {string} username
|
|
24167
|
+
* @param {*} [options] Override http request option.
|
|
24168
|
+
* @throws {RequiredError}
|
|
24169
|
+
*/
|
|
24170
|
+
getGitSSHPublicKeyV1(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1GitGitSshKeyResource>>;
|
|
23991
24171
|
/**
|
|
23992
24172
|
* Lists the repositories the Git installation can access, read live from the provider. Works for github and gitlab installations. Use an active installation: a suspended or pending one is still queried and the call fails with whatever the provider answers. The list is cut at the first 500 repositories in the order the provider returns them; when the account has more, name the repository directly instead of searching this list. `owner`, `name` and a branch (`default_branch` or another one) go into `source_options` of `Start Node.js build` or into `Update Git auto-deployment settings`. Returns 404 when the installation does not belong to the customer. Limited to 10 calls per minute per API client (429 above that).
|
|
23993
24173
|
* @summary List Git installation repositories
|
|
@@ -24005,6 +24185,15 @@ export declare const HostingGitApiFp: (configuration?: Configuration) => {
|
|
|
24005
24185
|
* @throws {RequiredError}
|
|
24006
24186
|
*/
|
|
24007
24187
|
listGitInstallationsV1(provider?: ListGitInstallationsV1ProviderEnum, status?: ListGitInstallationsV1StatusEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<HostingV1GitGitInstallationResource>>>;
|
|
24188
|
+
/**
|
|
24189
|
+
* Lists the Git repositories linked to directories of the website, with `Deploy website Git repository` or in the Git section of hPanel: clone URL, branch and directory of each one. A repository whose clone failed stays listed; deploying it again retries the clone. GitHub and GitLab auto-deployments are not listed here; see `Get Git auto-deployment settings`.
|
|
24190
|
+
* @summary List website Git repositories
|
|
24191
|
+
* @param {string} username
|
|
24192
|
+
* @param {string} domain Domain name
|
|
24193
|
+
* @param {*} [options] Override http request option.
|
|
24194
|
+
* @throws {RequiredError}
|
|
24195
|
+
*/
|
|
24196
|
+
listWebsiteGitRepositoriesV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<HostingV1GitWebsiteGitRepositoryResource>>>;
|
|
24008
24197
|
/**
|
|
24009
24198
|
* Creates or replaces the Git auto-deployment settings of the website: repository, branch, the directory under the document root to deploy into, and `is_enabled`. Send the full set; `is_enabled` defaults to true and `directory` to the document root. `installation_uuid` must be an installation from `List Git installations` that belongs to the same customer as the website. For PHP and static websites, saving with `is_enabled` true deploys the branch right away and every later push to that branch deploys again. For Node.js and Website Builder websites saving does not clone anything. On a Node.js website start the first deploy with `Start Node.js build` using `source_type` `git`; pushes then trigger new builds with the build settings stored for the website.
|
|
24010
24199
|
* @summary Update Git auto-deployment settings
|
|
@@ -24030,6 +24219,24 @@ export declare const HostingGitApiFactory: (configuration?: Configuration, baseP
|
|
|
24030
24219
|
* @throws {RequiredError}
|
|
24031
24220
|
*/
|
|
24032
24221
|
deleteGitAutoDeploymentSettingsV1(username: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
24222
|
+
/**
|
|
24223
|
+
* Clones a Git repository into a directory of the website, or pulls it again. An empty or missing directory gets a clone of the branch. A directory that already holds this repository and branch is reset to its last commit and pulled: changes made on the server to files the repository tracks are discarded, files it does not track stay. A directory that holds other files, including another repository or another branch of this one, is rejected. `composer install` runs after the clone or pull when the repository has a `composer.json`. The call waits for the deployment and returns its log. `is_success` false means Git or composer failed and the log says why. A second call for the same directory is rejected while the first is still waiting for the server. If the request times out, the deployment may still finish on the server; calling again later with the same repository and branch pulls. Private repositories need an SSH URL and the account\'s Git SSH key from `Generate Git SSH key`, added to the repository as a deploy key.
|
|
24224
|
+
* @summary Deploy website Git repository
|
|
24225
|
+
* @param {string} username
|
|
24226
|
+
* @param {string} domain Domain name
|
|
24227
|
+
* @param {HostingV1GitDeployWebsiteGitRepositoryRequest} hostingV1GitDeployWebsiteGitRepositoryRequest
|
|
24228
|
+
* @param {*} [options] Override http request option.
|
|
24229
|
+
* @throws {RequiredError}
|
|
24230
|
+
*/
|
|
24231
|
+
deployWebsiteGitRepositoryV1(username: string, domain: string, hostingV1GitDeployWebsiteGitRepositoryRequest: HostingV1GitDeployWebsiteGitRepositoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1GitGitDeployOutputResource>;
|
|
24232
|
+
/**
|
|
24233
|
+
* Creates the SSH key pair of the hosting account and returns the public key. When the account already has a key, returns that key unchanged. One key serves every website of the account; add the public key to a private repository as a deploy key before deploying it.
|
|
24234
|
+
* @summary Generate Git SSH key
|
|
24235
|
+
* @param {string} username
|
|
24236
|
+
* @param {*} [options] Override http request option.
|
|
24237
|
+
* @throws {RequiredError}
|
|
24238
|
+
*/
|
|
24239
|
+
generateGitSSHKeyV1(username: string, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1GitGitSshKeyResource>;
|
|
24033
24240
|
/**
|
|
24034
24241
|
* Returns the Git auto-deployment settings of the website: which repository and branch deploy into which directory, and whether pushes trigger a deployment. `is_enabled` false keeps the repository link but ignores pushes. When the website has no auto-deployment configured every field is null. Save settings with `Update Git auto-deployment settings`.
|
|
24035
24242
|
* @summary Get Git auto-deployment settings
|
|
@@ -24039,6 +24246,14 @@ export declare const HostingGitApiFactory: (configuration?: Configuration, baseP
|
|
|
24039
24246
|
* @throws {RequiredError}
|
|
24040
24247
|
*/
|
|
24041
24248
|
getGitAutoDeploymentSettingsV1(username: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1GitGitAutoDeploymentSettingsResource>;
|
|
24249
|
+
/**
|
|
24250
|
+
* Returns the public SSH key of the hosting account. `Deploy website Git repository` uses this key to clone and pull over SSH, so a private repository works once the key is added to it as a deploy key on the Git host. `public_key` is null when the account has no key yet.
|
|
24251
|
+
* @summary Get Git SSH public key
|
|
24252
|
+
* @param {string} username
|
|
24253
|
+
* @param {*} [options] Override http request option.
|
|
24254
|
+
* @throws {RequiredError}
|
|
24255
|
+
*/
|
|
24256
|
+
getGitSSHPublicKeyV1(username: string, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1GitGitSshKeyResource>;
|
|
24042
24257
|
/**
|
|
24043
24258
|
* Lists the repositories the Git installation can access, read live from the provider. Works for github and gitlab installations. Use an active installation: a suspended or pending one is still queried and the call fails with whatever the provider answers. The list is cut at the first 500 repositories in the order the provider returns them; when the account has more, name the repository directly instead of searching this list. `owner`, `name` and a branch (`default_branch` or another one) go into `source_options` of `Start Node.js build` or into `Update Git auto-deployment settings`. Returns 404 when the installation does not belong to the customer. Limited to 10 calls per minute per API client (429 above that).
|
|
24044
24259
|
* @summary List Git installation repositories
|
|
@@ -24056,6 +24271,15 @@ export declare const HostingGitApiFactory: (configuration?: Configuration, baseP
|
|
|
24056
24271
|
* @throws {RequiredError}
|
|
24057
24272
|
*/
|
|
24058
24273
|
listGitInstallationsV1(provider?: ListGitInstallationsV1ProviderEnum, status?: ListGitInstallationsV1StatusEnum, options?: RawAxiosRequestConfig): AxiosPromise<Array<HostingV1GitGitInstallationResource>>;
|
|
24274
|
+
/**
|
|
24275
|
+
* Lists the Git repositories linked to directories of the website, with `Deploy website Git repository` or in the Git section of hPanel: clone URL, branch and directory of each one. A repository whose clone failed stays listed; deploying it again retries the clone. GitHub and GitLab auto-deployments are not listed here; see `Get Git auto-deployment settings`.
|
|
24276
|
+
* @summary List website Git repositories
|
|
24277
|
+
* @param {string} username
|
|
24278
|
+
* @param {string} domain Domain name
|
|
24279
|
+
* @param {*} [options] Override http request option.
|
|
24280
|
+
* @throws {RequiredError}
|
|
24281
|
+
*/
|
|
24282
|
+
listWebsiteGitRepositoriesV1(username: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<HostingV1GitWebsiteGitRepositoryResource>>;
|
|
24059
24283
|
/**
|
|
24060
24284
|
* Creates or replaces the Git auto-deployment settings of the website: repository, branch, the directory under the document root to deploy into, and `is_enabled`. Send the full set; `is_enabled` defaults to true and `directory` to the document root. `installation_uuid` must be an installation from `List Git installations` that belongs to the same customer as the website. For PHP and static websites, saving with `is_enabled` true deploys the branch right away and every later push to that branch deploys again. For Node.js and Website Builder websites saving does not clone anything. On a Node.js website start the first deploy with `Start Node.js build` using `source_type` `git`; pushes then trigger new builds with the build settings stored for the website.
|
|
24061
24285
|
* @summary Update Git auto-deployment settings
|
|
@@ -24084,6 +24308,26 @@ export declare class HostingGitApi extends BaseAPI {
|
|
|
24084
24308
|
* @memberof HostingGitApi
|
|
24085
24309
|
*/
|
|
24086
24310
|
deleteGitAutoDeploymentSettingsV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
24311
|
+
/**
|
|
24312
|
+
* Clones a Git repository into a directory of the website, or pulls it again. An empty or missing directory gets a clone of the branch. A directory that already holds this repository and branch is reset to its last commit and pulled: changes made on the server to files the repository tracks are discarded, files it does not track stay. A directory that holds other files, including another repository or another branch of this one, is rejected. `composer install` runs after the clone or pull when the repository has a `composer.json`. The call waits for the deployment and returns its log. `is_success` false means Git or composer failed and the log says why. A second call for the same directory is rejected while the first is still waiting for the server. If the request times out, the deployment may still finish on the server; calling again later with the same repository and branch pulls. Private repositories need an SSH URL and the account\'s Git SSH key from `Generate Git SSH key`, added to the repository as a deploy key.
|
|
24313
|
+
* @summary Deploy website Git repository
|
|
24314
|
+
* @param {string} username
|
|
24315
|
+
* @param {string} domain Domain name
|
|
24316
|
+
* @param {HostingV1GitDeployWebsiteGitRepositoryRequest} hostingV1GitDeployWebsiteGitRepositoryRequest
|
|
24317
|
+
* @param {*} [options] Override http request option.
|
|
24318
|
+
* @throws {RequiredError}
|
|
24319
|
+
* @memberof HostingGitApi
|
|
24320
|
+
*/
|
|
24321
|
+
deployWebsiteGitRepositoryV1(username: string, domain: string, hostingV1GitDeployWebsiteGitRepositoryRequest: HostingV1GitDeployWebsiteGitRepositoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1GitGitDeployOutputResource, any, {}, any>>;
|
|
24322
|
+
/**
|
|
24323
|
+
* Creates the SSH key pair of the hosting account and returns the public key. When the account already has a key, returns that key unchanged. One key serves every website of the account; add the public key to a private repository as a deploy key before deploying it.
|
|
24324
|
+
* @summary Generate Git SSH key
|
|
24325
|
+
* @param {string} username
|
|
24326
|
+
* @param {*} [options] Override http request option.
|
|
24327
|
+
* @throws {RequiredError}
|
|
24328
|
+
* @memberof HostingGitApi
|
|
24329
|
+
*/
|
|
24330
|
+
generateGitSSHKeyV1(username: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1GitGitSshKeyResource, any, {}, any>>;
|
|
24087
24331
|
/**
|
|
24088
24332
|
* Returns the Git auto-deployment settings of the website: which repository and branch deploy into which directory, and whether pushes trigger a deployment. `is_enabled` false keeps the repository link but ignores pushes. When the website has no auto-deployment configured every field is null. Save settings with `Update Git auto-deployment settings`.
|
|
24089
24333
|
* @summary Get Git auto-deployment settings
|
|
@@ -24094,6 +24338,15 @@ export declare class HostingGitApi extends BaseAPI {
|
|
|
24094
24338
|
* @memberof HostingGitApi
|
|
24095
24339
|
*/
|
|
24096
24340
|
getGitAutoDeploymentSettingsV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1GitGitAutoDeploymentSettingsResource, any, {}, any>>;
|
|
24341
|
+
/**
|
|
24342
|
+
* Returns the public SSH key of the hosting account. `Deploy website Git repository` uses this key to clone and pull over SSH, so a private repository works once the key is added to it as a deploy key on the Git host. `public_key` is null when the account has no key yet.
|
|
24343
|
+
* @summary Get Git SSH public key
|
|
24344
|
+
* @param {string} username
|
|
24345
|
+
* @param {*} [options] Override http request option.
|
|
24346
|
+
* @throws {RequiredError}
|
|
24347
|
+
* @memberof HostingGitApi
|
|
24348
|
+
*/
|
|
24349
|
+
getGitSSHPublicKeyV1(username: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1GitGitSshKeyResource, any, {}, any>>;
|
|
24097
24350
|
/**
|
|
24098
24351
|
* Lists the repositories the Git installation can access, read live from the provider. Works for github and gitlab installations. Use an active installation: a suspended or pending one is still queried and the call fails with whatever the provider answers. The list is cut at the first 500 repositories in the order the provider returns them; when the account has more, name the repository directly instead of searching this list. `owner`, `name` and a branch (`default_branch` or another one) go into `source_options` of `Start Node.js build` or into `Update Git auto-deployment settings`. Returns 404 when the installation does not belong to the customer. Limited to 10 calls per minute per API client (429 above that).
|
|
24099
24352
|
* @summary List Git installation repositories
|
|
@@ -24113,6 +24366,16 @@ export declare class HostingGitApi extends BaseAPI {
|
|
|
24113
24366
|
* @memberof HostingGitApi
|
|
24114
24367
|
*/
|
|
24115
24368
|
listGitInstallationsV1(provider?: ListGitInstallationsV1ProviderEnum, status?: ListGitInstallationsV1StatusEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1GitGitInstallationResource[], any, {}, any>>;
|
|
24369
|
+
/**
|
|
24370
|
+
* Lists the Git repositories linked to directories of the website, with `Deploy website Git repository` or in the Git section of hPanel: clone URL, branch and directory of each one. A repository whose clone failed stays listed; deploying it again retries the clone. GitHub and GitLab auto-deployments are not listed here; see `Get Git auto-deployment settings`.
|
|
24371
|
+
* @summary List website Git repositories
|
|
24372
|
+
* @param {string} username
|
|
24373
|
+
* @param {string} domain Domain name
|
|
24374
|
+
* @param {*} [options] Override http request option.
|
|
24375
|
+
* @throws {RequiredError}
|
|
24376
|
+
* @memberof HostingGitApi
|
|
24377
|
+
*/
|
|
24378
|
+
listWebsiteGitRepositoriesV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1GitWebsiteGitRepositoryResource[], any, {}, any>>;
|
|
24116
24379
|
/**
|
|
24117
24380
|
* Creates or replaces the Git auto-deployment settings of the website: repository, branch, the directory under the document root to deploy into, and `is_enabled`. Send the full set; `is_enabled` defaults to true and `directory` to the document root. `installation_uuid` must be an installation from `List Git installations` that belongs to the same customer as the website. For PHP and static websites, saving with `is_enabled` true deploys the branch right away and every later push to that branch deploys again. For Node.js and Website Builder websites saving does not clone anything. On a Node.js website start the first deploy with `Start Node.js build` using `source_type` `git`; pushes then trigger new builds with the build settings stored for the website.
|
|
24118
24381
|
* @summary Update Git auto-deployment settings
|
|
@@ -24841,7 +25104,7 @@ export type ListNodeJsVulnerabilitiesV1SeveritiesEnum = typeof ListNodeJsVulnera
|
|
|
24841
25104
|
*/
|
|
24842
25105
|
export declare const HostingOrdersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24843
25106
|
/**
|
|
24844
|
-
* Retrieve a paginated list of orders accessible to the authenticated client. This endpoint returns orders of your hosting accounts as well as orders of other client hosting accounts that have shared access with you. Use the available query parameters to filter results by order statuses or specific order IDs for more targeted results.
|
|
25107
|
+
* Retrieve a paginated list of orders accessible to the authenticated client. Only Web and Cloud hosting orders are listed. Agency Plan orders are listed by `GET /api/agency-hosting/v1/orders`. This endpoint returns orders of your hosting accounts as well as orders of other client hosting accounts that have shared access with you. Use the available query parameters to filter results by order statuses or specific order IDs for more targeted results.
|
|
24845
25108
|
* @summary List orders
|
|
24846
25109
|
* @param {number} [page] Page number
|
|
24847
25110
|
* @param {number} [perPage] Number of items per page
|
|
@@ -24858,7 +25121,7 @@ export declare const HostingOrdersApiAxiosParamCreator: (configuration?: Configu
|
|
|
24858
25121
|
*/
|
|
24859
25122
|
export declare const HostingOrdersApiFp: (configuration?: Configuration) => {
|
|
24860
25123
|
/**
|
|
24861
|
-
* Retrieve a paginated list of orders accessible to the authenticated client. This endpoint returns orders of your hosting accounts as well as orders of other client hosting accounts that have shared access with you. Use the available query parameters to filter results by order statuses or specific order IDs for more targeted results.
|
|
25124
|
+
* Retrieve a paginated list of orders accessible to the authenticated client. Only Web and Cloud hosting orders are listed. Agency Plan orders are listed by `GET /api/agency-hosting/v1/orders`. This endpoint returns orders of your hosting accounts as well as orders of other client hosting accounts that have shared access with you. Use the available query parameters to filter results by order statuses or specific order IDs for more targeted results.
|
|
24862
25125
|
* @summary List orders
|
|
24863
25126
|
* @param {number} [page] Page number
|
|
24864
25127
|
* @param {number} [perPage] Number of items per page
|
|
@@ -24875,7 +25138,7 @@ export declare const HostingOrdersApiFp: (configuration?: Configuration) => {
|
|
|
24875
25138
|
*/
|
|
24876
25139
|
export declare const HostingOrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
24877
25140
|
/**
|
|
24878
|
-
* Retrieve a paginated list of orders accessible to the authenticated client. This endpoint returns orders of your hosting accounts as well as orders of other client hosting accounts that have shared access with you. Use the available query parameters to filter results by order statuses or specific order IDs for more targeted results.
|
|
25141
|
+
* Retrieve a paginated list of orders accessible to the authenticated client. Only Web and Cloud hosting orders are listed. Agency Plan orders are listed by `GET /api/agency-hosting/v1/orders`. This endpoint returns orders of your hosting accounts as well as orders of other client hosting accounts that have shared access with you. Use the available query parameters to filter results by order statuses or specific order IDs for more targeted results.
|
|
24879
25142
|
* @summary List orders
|
|
24880
25143
|
* @param {number} [page] Page number
|
|
24881
25144
|
* @param {number} [perPage] Number of items per page
|
|
@@ -24894,7 +25157,7 @@ export declare const HostingOrdersApiFactory: (configuration?: Configuration, ba
|
|
|
24894
25157
|
*/
|
|
24895
25158
|
export declare class HostingOrdersApi extends BaseAPI {
|
|
24896
25159
|
/**
|
|
24897
|
-
* Retrieve a paginated list of orders accessible to the authenticated client. This endpoint returns orders of your hosting accounts as well as orders of other client hosting accounts that have shared access with you. Use the available query parameters to filter results by order statuses or specific order IDs for more targeted results.
|
|
25160
|
+
* Retrieve a paginated list of orders accessible to the authenticated client. Only Web and Cloud hosting orders are listed. Agency Plan orders are listed by `GET /api/agency-hosting/v1/orders`. This endpoint returns orders of your hosting accounts as well as orders of other client hosting accounts that have shared access with you. Use the available query parameters to filter results by order statuses or specific order IDs for more targeted results.
|
|
24898
25161
|
* @summary List orders
|
|
24899
25162
|
* @param {number} [page] Page number
|
|
24900
25163
|
* @param {number} [perPage] Number of items per page
|
|
@@ -25513,7 +25776,7 @@ export declare class HostingSSLApi extends BaseAPI {
|
|
|
25513
25776
|
*/
|
|
25514
25777
|
export declare const HostingWebsitesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
25515
25778
|
/**
|
|
25516
|
-
* Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation is asynchronous and takes up to a few minutes. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. While the setup is `running`, endpoints that operate on the website may respond with `404` or `409`. `is_enabled` on the websites list reflects suspension, not readiness.
|
|
25779
|
+
* Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. Only Web and Cloud hosting orders are accepted. To create a website on an Agency Plan order, use `POST /api/agency-hosting/v1/orders/{order_id}/websites/setups`. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation is asynchronous and takes up to a few minutes. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. While the setup is `running`, endpoints that operate on the website may respond with `404` or `409`. `is_enabled` on the websites list reflects suspension, not readiness.
|
|
25517
25780
|
* @summary Create website
|
|
25518
25781
|
* @param {HostingV1WebsitesCreateWebsiteRequest} hostingV1WebsitesCreateWebsiteRequest
|
|
25519
25782
|
* @param {*} [options] Override http request option.
|
|
@@ -25567,7 +25830,7 @@ export declare const HostingWebsitesApiAxiosParamCreator: (configuration?: Confi
|
|
|
25567
25830
|
*/
|
|
25568
25831
|
export declare const HostingWebsitesApiFp: (configuration?: Configuration) => {
|
|
25569
25832
|
/**
|
|
25570
|
-
* Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation is asynchronous and takes up to a few minutes. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. While the setup is `running`, endpoints that operate on the website may respond with `404` or `409`. `is_enabled` on the websites list reflects suspension, not readiness.
|
|
25833
|
+
* Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. Only Web and Cloud hosting orders are accepted. To create a website on an Agency Plan order, use `POST /api/agency-hosting/v1/orders/{order_id}/websites/setups`. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation is asynchronous and takes up to a few minutes. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. While the setup is `running`, endpoints that operate on the website may respond with `404` or `409`. `is_enabled` on the websites list reflects suspension, not readiness.
|
|
25571
25834
|
* @summary Create website
|
|
25572
25835
|
* @param {HostingV1WebsitesCreateWebsiteRequest} hostingV1WebsitesCreateWebsiteRequest
|
|
25573
25836
|
* @param {*} [options] Override http request option.
|
|
@@ -25621,7 +25884,7 @@ export declare const HostingWebsitesApiFp: (configuration?: Configuration) => {
|
|
|
25621
25884
|
*/
|
|
25622
25885
|
export declare const HostingWebsitesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
25623
25886
|
/**
|
|
25624
|
-
* Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation is asynchronous and takes up to a few minutes. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. While the setup is `running`, endpoints that operate on the website may respond with `404` or `409`. `is_enabled` on the websites list reflects suspension, not readiness.
|
|
25887
|
+
* Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. Only Web and Cloud hosting orders are accepted. To create a website on an Agency Plan order, use `POST /api/agency-hosting/v1/orders/{order_id}/websites/setups`. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation is asynchronous and takes up to a few minutes. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. While the setup is `running`, endpoints that operate on the website may respond with `404` or `409`. `is_enabled` on the websites list reflects suspension, not readiness.
|
|
25625
25888
|
* @summary Create website
|
|
25626
25889
|
* @param {HostingV1WebsitesCreateWebsiteRequest} hostingV1WebsitesCreateWebsiteRequest
|
|
25627
25890
|
* @param {*} [options] Override http request option.
|
|
@@ -25677,7 +25940,7 @@ export declare const HostingWebsitesApiFactory: (configuration?: Configuration,
|
|
|
25677
25940
|
*/
|
|
25678
25941
|
export declare class HostingWebsitesApi extends BaseAPI {
|
|
25679
25942
|
/**
|
|
25680
|
-
* Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation is asynchronous and takes up to a few minutes. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. While the setup is `running`, endpoints that operate on the website may respond with `404` or `409`. `is_enabled` on the websites list reflects suspension, not readiness.
|
|
25943
|
+
* Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. Only Web and Cloud hosting orders are accepted. To create a website on an Agency Plan order, use `POST /api/agency-hosting/v1/orders/{order_id}/websites/setups`. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation is asynchronous and takes up to a few minutes. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. While the setup is `running`, endpoints that operate on the website may respond with `404` or `409`. `is_enabled` on the websites list reflects suspension, not readiness.
|
|
25681
25944
|
* @summary Create website
|
|
25682
25945
|
* @param {HostingV1WebsitesCreateWebsiteRequest} hostingV1WebsitesCreateWebsiteRequest
|
|
25683
25946
|
* @param {*} [options] Override http request option.
|