hostinger-api-sdk 1.37.0 → 1.39.0
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 +1052 -17
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +678 -17
- package/dist/api.js +723 -19
- 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 +678 -17
- package/dist/esm/api.js +713 -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/AgencyHostingFilesApi.md +54 -0
- package/docs/HostingFilesApi.md +56 -0
- package/docs/HostingNodeJSApi.md +124 -1
- package/docs/HostingV1FilesGenerateUploadUrlRequest.md +22 -0
- package/docs/HostingV1FilesUploadUrlResource.md +24 -0
- package/docs/HostingV1NodeJsBuildSettingsResource.md +34 -0
- package/docs/HostingV1NodeJsGetBuildSettingsRequest.md +20 -0
- package/docs/HostingV1NodeJsStartBuildRequest.md +36 -0
- package/docs/HostingV1NodeJsStartBuildRequestSourceOptions.md +21 -0
- package/docs/HostingV1WebsitesDeployArchiveRequest.md +20 -0
- package/docs/HostingV1WebsitesWebsiteResource.md +8 -4
- package/docs/HostingWebsitesApi.md +63 -1
- package/docs/WordPressInstallationsApi.md +62 -0
- package/docs/WordPressPluginsApi.md +62 -0
- package/docs/WordPressThemesApi.md +62 -0
- package/docs/WordPressV1InstallationsImportWordPressRequest.md +22 -0
- package/docs/WordPressV1PluginsDeployPluginRequest.md +22 -0
- package/docs/WordPressV1ThemesDeployThemeRequest.md +24 -0
- 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.
|
|
4
|
+
* API Version: 1.41.0
|
|
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
|
|
@@ -5198,6 +5198,50 @@ export declare const HostingV1FilesFilesResourceItemsInnerTypeEnum: {
|
|
|
5198
5198
|
readonly Other: "other";
|
|
5199
5199
|
};
|
|
5200
5200
|
export type HostingV1FilesFilesResourceItemsInnerTypeEnum = typeof HostingV1FilesFilesResourceItemsInnerTypeEnum[keyof typeof HostingV1FilesFilesResourceItemsInnerTypeEnum];
|
|
5201
|
+
/**
|
|
5202
|
+
*
|
|
5203
|
+
* @export
|
|
5204
|
+
* @interface HostingV1FilesGenerateUploadUrlRequest
|
|
5205
|
+
*/
|
|
5206
|
+
export interface HostingV1FilesGenerateUploadUrlRequest {
|
|
5207
|
+
/**
|
|
5208
|
+
* Account username
|
|
5209
|
+
* @type {string}
|
|
5210
|
+
* @memberof HostingV1FilesGenerateUploadUrlRequest
|
|
5211
|
+
*/
|
|
5212
|
+
'username': string;
|
|
5213
|
+
/**
|
|
5214
|
+
* Website domain
|
|
5215
|
+
* @type {string}
|
|
5216
|
+
* @memberof HostingV1FilesGenerateUploadUrlRequest
|
|
5217
|
+
*/
|
|
5218
|
+
'domain': string;
|
|
5219
|
+
}
|
|
5220
|
+
/**
|
|
5221
|
+
*
|
|
5222
|
+
* @export
|
|
5223
|
+
* @interface HostingV1FilesUploadUrlResource
|
|
5224
|
+
*/
|
|
5225
|
+
export interface HostingV1FilesUploadUrlResource {
|
|
5226
|
+
/**
|
|
5227
|
+
* The TUS upload endpoint URL to send upload requests to
|
|
5228
|
+
* @type {string}
|
|
5229
|
+
* @memberof HostingV1FilesUploadUrlResource
|
|
5230
|
+
*/
|
|
5231
|
+
'url': string;
|
|
5232
|
+
/**
|
|
5233
|
+
* Authentication token to pass as the `X-Auth` header in TUS upload requests
|
|
5234
|
+
* @type {string}
|
|
5235
|
+
* @memberof HostingV1FilesUploadUrlResource
|
|
5236
|
+
*/
|
|
5237
|
+
'auth_key': string;
|
|
5238
|
+
/**
|
|
5239
|
+
* Authentication token to pass as the `X-Auth-Rest` header in TUS upload requests
|
|
5240
|
+
* @type {string}
|
|
5241
|
+
* @memberof HostingV1FilesUploadUrlResource
|
|
5242
|
+
*/
|
|
5243
|
+
'rest_auth_key': string;
|
|
5244
|
+
}
|
|
5201
5245
|
/**
|
|
5202
5246
|
*
|
|
5203
5247
|
* @export
|
|
@@ -5354,6 +5398,89 @@ export declare const HostingV1NodeJsBuildResourceStateEnum: {
|
|
|
5354
5398
|
readonly Failed: "failed";
|
|
5355
5399
|
};
|
|
5356
5400
|
export type HostingV1NodeJsBuildResourceStateEnum = typeof HostingV1NodeJsBuildResourceStateEnum[keyof typeof HostingV1NodeJsBuildResourceStateEnum];
|
|
5401
|
+
/**
|
|
5402
|
+
*
|
|
5403
|
+
* @export
|
|
5404
|
+
* @interface HostingV1NodeJsBuildSettingsResource
|
|
5405
|
+
*/
|
|
5406
|
+
export interface HostingV1NodeJsBuildSettingsResource {
|
|
5407
|
+
/**
|
|
5408
|
+
* Node.js application type
|
|
5409
|
+
* @type {string}
|
|
5410
|
+
* @memberof HostingV1NodeJsBuildSettingsResource
|
|
5411
|
+
*/
|
|
5412
|
+
'app_type': HostingV1NodeJsBuildSettingsResourceAppTypeEnum | null;
|
|
5413
|
+
/**
|
|
5414
|
+
* Node.js version
|
|
5415
|
+
* @type {number}
|
|
5416
|
+
* @memberof HostingV1NodeJsBuildSettingsResource
|
|
5417
|
+
*/
|
|
5418
|
+
'node_version': number | null;
|
|
5419
|
+
/**
|
|
5420
|
+
* Application root directory
|
|
5421
|
+
* @type {string}
|
|
5422
|
+
* @memberof HostingV1NodeJsBuildSettingsResource
|
|
5423
|
+
*/
|
|
5424
|
+
'root_directory': string | null;
|
|
5425
|
+
/**
|
|
5426
|
+
* Build output directory
|
|
5427
|
+
* @type {string}
|
|
5428
|
+
* @memberof HostingV1NodeJsBuildSettingsResource
|
|
5429
|
+
*/
|
|
5430
|
+
'output_directory': string | null;
|
|
5431
|
+
/**
|
|
5432
|
+
* The npm script to run to build the application
|
|
5433
|
+
* @type {string}
|
|
5434
|
+
* @memberof HostingV1NodeJsBuildSettingsResource
|
|
5435
|
+
*/
|
|
5436
|
+
'build_script': string | null;
|
|
5437
|
+
/**
|
|
5438
|
+
* The main entry point file for the application
|
|
5439
|
+
* @type {string}
|
|
5440
|
+
* @memberof HostingV1NodeJsBuildSettingsResource
|
|
5441
|
+
*/
|
|
5442
|
+
'entry_file': string | null;
|
|
5443
|
+
/**
|
|
5444
|
+
* Package manager
|
|
5445
|
+
* @type {string}
|
|
5446
|
+
* @memberof HostingV1NodeJsBuildSettingsResource
|
|
5447
|
+
*/
|
|
5448
|
+
'package_manager': HostingV1NodeJsBuildSettingsResourcePackageManagerEnum | null;
|
|
5449
|
+
/**
|
|
5450
|
+
* The scripts configured in the package.json file
|
|
5451
|
+
* @type {Array<string>}
|
|
5452
|
+
* @memberof HostingV1NodeJsBuildSettingsResource
|
|
5453
|
+
*/
|
|
5454
|
+
'available_scripts': Array<string>;
|
|
5455
|
+
}
|
|
5456
|
+
export declare const HostingV1NodeJsBuildSettingsResourceAppTypeEnum: {
|
|
5457
|
+
readonly CreateReactApp: "create-react-app";
|
|
5458
|
+
readonly Gatsby: "gatsby";
|
|
5459
|
+
readonly Vite: "vite";
|
|
5460
|
+
readonly Angular: "angular";
|
|
5461
|
+
readonly React: "react";
|
|
5462
|
+
readonly Vue: "vue";
|
|
5463
|
+
readonly Parcel: "parcel";
|
|
5464
|
+
readonly Next: "next";
|
|
5465
|
+
readonly Nuxt: "nuxt";
|
|
5466
|
+
readonly Nest: "nest";
|
|
5467
|
+
readonly Express: "express";
|
|
5468
|
+
readonly Fastify: "fastify";
|
|
5469
|
+
readonly Astro: "astro";
|
|
5470
|
+
readonly Svelte: "svelte";
|
|
5471
|
+
readonly SvelteKit: "svelte-kit";
|
|
5472
|
+
readonly Hono: "hono";
|
|
5473
|
+
readonly ReactRouter: "react-router";
|
|
5474
|
+
readonly Nitro: "nitro";
|
|
5475
|
+
readonly Other: "other";
|
|
5476
|
+
};
|
|
5477
|
+
export type HostingV1NodeJsBuildSettingsResourceAppTypeEnum = typeof HostingV1NodeJsBuildSettingsResourceAppTypeEnum[keyof typeof HostingV1NodeJsBuildSettingsResourceAppTypeEnum];
|
|
5478
|
+
export declare const HostingV1NodeJsBuildSettingsResourcePackageManagerEnum: {
|
|
5479
|
+
readonly Npm: "npm";
|
|
5480
|
+
readonly Yarn: "yarn";
|
|
5481
|
+
readonly Pnpm: "pnpm";
|
|
5482
|
+
};
|
|
5483
|
+
export type HostingV1NodeJsBuildSettingsResourcePackageManagerEnum = typeof HostingV1NodeJsBuildSettingsResourcePackageManagerEnum[keyof typeof HostingV1NodeJsBuildSettingsResourcePackageManagerEnum];
|
|
5357
5484
|
/**
|
|
5358
5485
|
*
|
|
5359
5486
|
* @export
|
|
@@ -5444,6 +5571,19 @@ export declare const HostingV1NodeJsCreateFromArchiveRequestPackageManagerEnum:
|
|
|
5444
5571
|
readonly Pnpm: "pnpm";
|
|
5445
5572
|
};
|
|
5446
5573
|
export type HostingV1NodeJsCreateFromArchiveRequestPackageManagerEnum = typeof HostingV1NodeJsCreateFromArchiveRequestPackageManagerEnum[keyof typeof HostingV1NodeJsCreateFromArchiveRequestPackageManagerEnum];
|
|
5574
|
+
/**
|
|
5575
|
+
*
|
|
5576
|
+
* @export
|
|
5577
|
+
* @interface HostingV1NodeJsGetBuildSettingsRequest
|
|
5578
|
+
*/
|
|
5579
|
+
export interface HostingV1NodeJsGetBuildSettingsRequest {
|
|
5580
|
+
/**
|
|
5581
|
+
* The path to the archive file relative to the document root of the vhost
|
|
5582
|
+
* @type {string}
|
|
5583
|
+
* @memberof HostingV1NodeJsGetBuildSettingsRequest
|
|
5584
|
+
*/
|
|
5585
|
+
'archive_path': string;
|
|
5586
|
+
}
|
|
5447
5587
|
/**
|
|
5448
5588
|
*
|
|
5449
5589
|
* @export
|
|
@@ -5501,6 +5641,119 @@ export interface HostingV1NodeJsSourceOptionsResource {
|
|
|
5501
5641
|
*/
|
|
5502
5642
|
'archive_path': string | null;
|
|
5503
5643
|
}
|
|
5644
|
+
/**
|
|
5645
|
+
*
|
|
5646
|
+
* @export
|
|
5647
|
+
* @interface HostingV1NodeJsStartBuildRequest
|
|
5648
|
+
*/
|
|
5649
|
+
export interface HostingV1NodeJsStartBuildRequest {
|
|
5650
|
+
/**
|
|
5651
|
+
* Node.js version
|
|
5652
|
+
* @type {number}
|
|
5653
|
+
* @memberof HostingV1NodeJsStartBuildRequest
|
|
5654
|
+
*/
|
|
5655
|
+
'node_version': HostingV1NodeJsStartBuildRequestNodeVersionEnum;
|
|
5656
|
+
/**
|
|
5657
|
+
* Node.js application type
|
|
5658
|
+
* @type {string}
|
|
5659
|
+
* @memberof HostingV1NodeJsStartBuildRequest
|
|
5660
|
+
*/
|
|
5661
|
+
'app_type': HostingV1NodeJsStartBuildRequestAppTypeEnum | null;
|
|
5662
|
+
/**
|
|
5663
|
+
* Application root directory (where package.json is located) relative to public_html
|
|
5664
|
+
* @type {string}
|
|
5665
|
+
* @memberof HostingV1NodeJsStartBuildRequest
|
|
5666
|
+
*/
|
|
5667
|
+
'root_directory': string | null;
|
|
5668
|
+
/**
|
|
5669
|
+
* Build output directory relative to the root directory
|
|
5670
|
+
* @type {string}
|
|
5671
|
+
* @memberof HostingV1NodeJsStartBuildRequest
|
|
5672
|
+
*/
|
|
5673
|
+
'output_directory': string | null;
|
|
5674
|
+
/**
|
|
5675
|
+
* Build script that will be ran to build the application
|
|
5676
|
+
* @type {string}
|
|
5677
|
+
* @memberof HostingV1NodeJsStartBuildRequest
|
|
5678
|
+
*/
|
|
5679
|
+
'build_script': string | null;
|
|
5680
|
+
/**
|
|
5681
|
+
* The main entry point file for the application
|
|
5682
|
+
* @type {string}
|
|
5683
|
+
* @memberof HostingV1NodeJsStartBuildRequest
|
|
5684
|
+
*/
|
|
5685
|
+
'entry_file': string | null;
|
|
5686
|
+
/**
|
|
5687
|
+
* Package manager
|
|
5688
|
+
* @type {string}
|
|
5689
|
+
* @memberof HostingV1NodeJsStartBuildRequest
|
|
5690
|
+
*/
|
|
5691
|
+
'package_manager': HostingV1NodeJsStartBuildRequestPackageManagerEnum | null;
|
|
5692
|
+
/**
|
|
5693
|
+
* The source type of the files
|
|
5694
|
+
* @type {string}
|
|
5695
|
+
* @memberof HostingV1NodeJsStartBuildRequest
|
|
5696
|
+
*/
|
|
5697
|
+
'source_type': HostingV1NodeJsStartBuildRequestSourceTypeEnum;
|
|
5698
|
+
/**
|
|
5699
|
+
*
|
|
5700
|
+
* @type {HostingV1NodeJsStartBuildRequestSourceOptions}
|
|
5701
|
+
* @memberof HostingV1NodeJsStartBuildRequest
|
|
5702
|
+
*/
|
|
5703
|
+
'source_options': HostingV1NodeJsStartBuildRequestSourceOptions | null;
|
|
5704
|
+
}
|
|
5705
|
+
export declare const HostingV1NodeJsStartBuildRequestNodeVersionEnum: {
|
|
5706
|
+
readonly NUMBER_18: 18;
|
|
5707
|
+
readonly NUMBER_20: 20;
|
|
5708
|
+
readonly NUMBER_22: 22;
|
|
5709
|
+
readonly NUMBER_24: 24;
|
|
5710
|
+
};
|
|
5711
|
+
export type HostingV1NodeJsStartBuildRequestNodeVersionEnum = typeof HostingV1NodeJsStartBuildRequestNodeVersionEnum[keyof typeof HostingV1NodeJsStartBuildRequestNodeVersionEnum];
|
|
5712
|
+
export declare const HostingV1NodeJsStartBuildRequestAppTypeEnum: {
|
|
5713
|
+
readonly CreateReactApp: "create-react-app";
|
|
5714
|
+
readonly Gatsby: "gatsby";
|
|
5715
|
+
readonly Vite: "vite";
|
|
5716
|
+
readonly Angular: "angular";
|
|
5717
|
+
readonly React: "react";
|
|
5718
|
+
readonly Vue: "vue";
|
|
5719
|
+
readonly Parcel: "parcel";
|
|
5720
|
+
readonly Next: "next";
|
|
5721
|
+
readonly Nuxt: "nuxt";
|
|
5722
|
+
readonly Nest: "nest";
|
|
5723
|
+
readonly Express: "express";
|
|
5724
|
+
readonly Fastify: "fastify";
|
|
5725
|
+
readonly Astro: "astro";
|
|
5726
|
+
readonly Svelte: "svelte";
|
|
5727
|
+
readonly SvelteKit: "svelte-kit";
|
|
5728
|
+
readonly Hono: "hono";
|
|
5729
|
+
readonly ReactRouter: "react-router";
|
|
5730
|
+
readonly Nitro: "nitro";
|
|
5731
|
+
readonly Other: "other";
|
|
5732
|
+
};
|
|
5733
|
+
export type HostingV1NodeJsStartBuildRequestAppTypeEnum = typeof HostingV1NodeJsStartBuildRequestAppTypeEnum[keyof typeof HostingV1NodeJsStartBuildRequestAppTypeEnum];
|
|
5734
|
+
export declare const HostingV1NodeJsStartBuildRequestPackageManagerEnum: {
|
|
5735
|
+
readonly Npm: "npm";
|
|
5736
|
+
readonly Yarn: "yarn";
|
|
5737
|
+
readonly Pnpm: "pnpm";
|
|
5738
|
+
};
|
|
5739
|
+
export type HostingV1NodeJsStartBuildRequestPackageManagerEnum = typeof HostingV1NodeJsStartBuildRequestPackageManagerEnum[keyof typeof HostingV1NodeJsStartBuildRequestPackageManagerEnum];
|
|
5740
|
+
export declare const HostingV1NodeJsStartBuildRequestSourceTypeEnum: {
|
|
5741
|
+
readonly Archive: "archive";
|
|
5742
|
+
};
|
|
5743
|
+
export type HostingV1NodeJsStartBuildRequestSourceTypeEnum = typeof HostingV1NodeJsStartBuildRequestSourceTypeEnum[keyof typeof HostingV1NodeJsStartBuildRequestSourceTypeEnum];
|
|
5744
|
+
/**
|
|
5745
|
+
* Source-specific options
|
|
5746
|
+
* @export
|
|
5747
|
+
* @interface HostingV1NodeJsStartBuildRequestSourceOptions
|
|
5748
|
+
*/
|
|
5749
|
+
export interface HostingV1NodeJsStartBuildRequestSourceOptions {
|
|
5750
|
+
/**
|
|
5751
|
+
* The path to the archive file relative to the document root of the vhost (required if source is \"archive\")
|
|
5752
|
+
* @type {string}
|
|
5753
|
+
* @memberof HostingV1NodeJsStartBuildRequestSourceOptions
|
|
5754
|
+
*/
|
|
5755
|
+
'archive_path': string;
|
|
5756
|
+
}
|
|
5504
5757
|
/**
|
|
5505
5758
|
*
|
|
5506
5759
|
* @export
|
|
@@ -5910,6 +6163,19 @@ export interface HostingV1WebsitesCreateWebsiteRequest {
|
|
|
5910
6163
|
*/
|
|
5911
6164
|
'datacenter_code': string | null;
|
|
5912
6165
|
}
|
|
6166
|
+
/**
|
|
6167
|
+
*
|
|
6168
|
+
* @export
|
|
6169
|
+
* @interface HostingV1WebsitesDeployArchiveRequest
|
|
6170
|
+
*/
|
|
6171
|
+
export interface HostingV1WebsitesDeployArchiveRequest {
|
|
6172
|
+
/**
|
|
6173
|
+
* Relative path to the archive file from website root directory
|
|
6174
|
+
* @type {string}
|
|
6175
|
+
* @memberof HostingV1WebsitesDeployArchiveRequest
|
|
6176
|
+
*/
|
|
6177
|
+
'archive_path': string;
|
|
6178
|
+
}
|
|
5913
6179
|
/**
|
|
5914
6180
|
*
|
|
5915
6181
|
* @export
|
|
@@ -5917,17 +6183,17 @@ export interface HostingV1WebsitesCreateWebsiteRequest {
|
|
|
5917
6183
|
*/
|
|
5918
6184
|
export interface HostingV1WebsitesWebsiteResource {
|
|
5919
6185
|
/**
|
|
5920
|
-
* Website domain
|
|
6186
|
+
* Website domain. Null for U4S websites with no domain attached.
|
|
5921
6187
|
* @type {string}
|
|
5922
6188
|
* @memberof HostingV1WebsitesWebsiteResource
|
|
5923
6189
|
*/
|
|
5924
|
-
'domain': string;
|
|
6190
|
+
'domain': string | null;
|
|
5925
6191
|
/**
|
|
5926
|
-
* Virtual host type
|
|
6192
|
+
* Virtual host type. Only present for CloudLinux websites.
|
|
5927
6193
|
* @type {string}
|
|
5928
6194
|
* @memberof HostingV1WebsitesWebsiteResource
|
|
5929
6195
|
*/
|
|
5930
|
-
'vhost_type': HostingV1WebsitesWebsiteResourceVhostTypeEnum;
|
|
6196
|
+
'vhost_type': HostingV1WebsitesWebsiteResourceVhostTypeEnum | null;
|
|
5931
6197
|
/**
|
|
5932
6198
|
* Whether website is enabled
|
|
5933
6199
|
* @type {boolean}
|
|
@@ -5935,11 +6201,11 @@ export interface HostingV1WebsitesWebsiteResource {
|
|
|
5935
6201
|
*/
|
|
5936
6202
|
'is_enabled': boolean;
|
|
5937
6203
|
/**
|
|
5938
|
-
* Username
|
|
6204
|
+
* Username. Not applicable for U4S websites.
|
|
5939
6205
|
* @type {string}
|
|
5940
6206
|
* @memberof HostingV1WebsitesWebsiteResource
|
|
5941
6207
|
*/
|
|
5942
|
-
'username': string;
|
|
6208
|
+
'username': string | null;
|
|
5943
6209
|
/**
|
|
5944
6210
|
* Client ID
|
|
5945
6211
|
* @type {number}
|
|
@@ -5959,17 +6225,29 @@ export interface HostingV1WebsitesWebsiteResource {
|
|
|
5959
6225
|
*/
|
|
5960
6226
|
'created_at': string;
|
|
5961
6227
|
/**
|
|
5962
|
-
* Root directory path
|
|
6228
|
+
* Root directory path. Only present for CloudLinux websites.
|
|
5963
6229
|
* @type {string}
|
|
5964
6230
|
* @memberof HostingV1WebsitesWebsiteResource
|
|
5965
6231
|
*/
|
|
5966
|
-
'root_directory': string;
|
|
6232
|
+
'root_directory': string | null;
|
|
5967
6233
|
/**
|
|
5968
6234
|
* Parent domain
|
|
5969
6235
|
* @type {string}
|
|
5970
6236
|
* @memberof HostingV1WebsitesWebsiteResource
|
|
5971
6237
|
*/
|
|
5972
6238
|
'parent_domain': string | null;
|
|
6239
|
+
/**
|
|
6240
|
+
* Type of website detected on the underlying platform.
|
|
6241
|
+
* @type {string}
|
|
6242
|
+
* @memberof HostingV1WebsitesWebsiteResource
|
|
6243
|
+
*/
|
|
6244
|
+
'website_type': HostingV1WebsitesWebsiteResourceWebsiteTypeEnum;
|
|
6245
|
+
/**
|
|
6246
|
+
* Horizons UUID. Only present for horizons websites.
|
|
6247
|
+
* @type {string}
|
|
6248
|
+
* @memberof HostingV1WebsitesWebsiteResource
|
|
6249
|
+
*/
|
|
6250
|
+
'horizons_uuid': string | null;
|
|
5973
6251
|
}
|
|
5974
6252
|
export declare const HostingV1WebsitesWebsiteResourceVhostTypeEnum: {
|
|
5975
6253
|
readonly Main: "main";
|
|
@@ -5978,6 +6256,14 @@ export declare const HostingV1WebsitesWebsiteResourceVhostTypeEnum: {
|
|
|
5978
6256
|
readonly Subdomain: "subdomain";
|
|
5979
6257
|
};
|
|
5980
6258
|
export type HostingV1WebsitesWebsiteResourceVhostTypeEnum = typeof HostingV1WebsitesWebsiteResourceVhostTypeEnum[keyof typeof HostingV1WebsitesWebsiteResourceVhostTypeEnum];
|
|
6259
|
+
export declare const HostingV1WebsitesWebsiteResourceWebsiteTypeEnum: {
|
|
6260
|
+
readonly Wordpress: "wordpress";
|
|
6261
|
+
readonly Builder: "builder";
|
|
6262
|
+
readonly Horizons: "horizons";
|
|
6263
|
+
readonly Nodejs: "nodejs";
|
|
6264
|
+
readonly Other: "other";
|
|
6265
|
+
};
|
|
6266
|
+
export type HostingV1WebsitesWebsiteResourceWebsiteTypeEnum = typeof HostingV1WebsitesWebsiteResourceWebsiteTypeEnum[keyof typeof HostingV1WebsitesWebsiteResourceWebsiteTypeEnum];
|
|
5981
6267
|
/**
|
|
5982
6268
|
*
|
|
5983
6269
|
* @export
|
|
@@ -11952,6 +12238,25 @@ export interface WordPressV1InstallationsDeleteInstallationRequest {
|
|
|
11952
12238
|
*/
|
|
11953
12239
|
'delete_database': boolean;
|
|
11954
12240
|
}
|
|
12241
|
+
/**
|
|
12242
|
+
*
|
|
12243
|
+
* @export
|
|
12244
|
+
* @interface WordPressV1InstallationsImportWordPressRequest
|
|
12245
|
+
*/
|
|
12246
|
+
export interface WordPressV1InstallationsImportWordPressRequest {
|
|
12247
|
+
/**
|
|
12248
|
+
* Path to the WordPress archive file (relative to website root)
|
|
12249
|
+
* @type {string}
|
|
12250
|
+
* @memberof WordPressV1InstallationsImportWordPressRequest
|
|
12251
|
+
*/
|
|
12252
|
+
'archive_path': string;
|
|
12253
|
+
/**
|
|
12254
|
+
* Path to the database SQL file (relative to website root)
|
|
12255
|
+
* @type {string}
|
|
12256
|
+
* @memberof WordPressV1InstallationsImportWordPressRequest
|
|
12257
|
+
*/
|
|
12258
|
+
'sql_path': string;
|
|
12259
|
+
}
|
|
11955
12260
|
/**
|
|
11956
12261
|
*
|
|
11957
12262
|
* @export
|
|
@@ -12508,6 +12813,25 @@ export interface WordPressV1PluginsDeactivatePluginRequest {
|
|
|
12508
12813
|
*/
|
|
12509
12814
|
'plugin': string;
|
|
12510
12815
|
}
|
|
12816
|
+
/**
|
|
12817
|
+
*
|
|
12818
|
+
* @export
|
|
12819
|
+
* @interface WordPressV1PluginsDeployPluginRequest
|
|
12820
|
+
*/
|
|
12821
|
+
export interface WordPressV1PluginsDeployPluginRequest {
|
|
12822
|
+
/**
|
|
12823
|
+
* Slug of the plugin
|
|
12824
|
+
* @type {string}
|
|
12825
|
+
* @memberof WordPressV1PluginsDeployPluginRequest
|
|
12826
|
+
*/
|
|
12827
|
+
'slug': string;
|
|
12828
|
+
/**
|
|
12829
|
+
* Relative path to the plugin directory from wp-content/plugins
|
|
12830
|
+
* @type {string}
|
|
12831
|
+
* @memberof WordPressV1PluginsDeployPluginRequest
|
|
12832
|
+
*/
|
|
12833
|
+
'plugin_path': string;
|
|
12834
|
+
}
|
|
12511
12835
|
/**
|
|
12512
12836
|
*
|
|
12513
12837
|
* @export
|
|
@@ -12794,6 +13118,31 @@ export interface WordPressV1ThemesActivateThemeRequest {
|
|
|
12794
13118
|
*/
|
|
12795
13119
|
'theme': string;
|
|
12796
13120
|
}
|
|
13121
|
+
/**
|
|
13122
|
+
*
|
|
13123
|
+
* @export
|
|
13124
|
+
* @interface WordPressV1ThemesDeployThemeRequest
|
|
13125
|
+
*/
|
|
13126
|
+
export interface WordPressV1ThemesDeployThemeRequest {
|
|
13127
|
+
/**
|
|
13128
|
+
* Slug of the theme
|
|
13129
|
+
* @type {string}
|
|
13130
|
+
* @memberof WordPressV1ThemesDeployThemeRequest
|
|
13131
|
+
*/
|
|
13132
|
+
'slug': string;
|
|
13133
|
+
/**
|
|
13134
|
+
* Relative path to the theme directory from wp-content/themes
|
|
13135
|
+
* @type {string}
|
|
13136
|
+
* @memberof WordPressV1ThemesDeployThemeRequest
|
|
13137
|
+
*/
|
|
13138
|
+
'theme_path': string;
|
|
13139
|
+
/**
|
|
13140
|
+
* Whether to activate the theme after deployment
|
|
13141
|
+
* @type {boolean}
|
|
13142
|
+
* @memberof WordPressV1ThemesDeployThemeRequest
|
|
13143
|
+
*/
|
|
13144
|
+
'is_activated': boolean | null;
|
|
13145
|
+
}
|
|
12797
13146
|
/**
|
|
12798
13147
|
*
|
|
12799
13148
|
* @export
|
|
@@ -13632,6 +13981,14 @@ export declare class AgencyHostingDomainsApi extends BaseAPI {
|
|
|
13632
13981
|
* @export
|
|
13633
13982
|
*/
|
|
13634
13983
|
export declare const AgencyHostingFilesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
13984
|
+
/**
|
|
13985
|
+
* Generate a file browser upload URL with authentication credentials for uploading files to an Agency Plan website\'s file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s file storage via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside the website\'s file storage, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
13986
|
+
* @summary Generate upload URL
|
|
13987
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
13988
|
+
* @param {*} [options] Override http request option.
|
|
13989
|
+
* @throws {RequiredError}
|
|
13990
|
+
*/
|
|
13991
|
+
generateUploadURLV1: (websiteUid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13635
13992
|
/**
|
|
13636
13993
|
* Imports an Agency Plan website from an already-uploaded archive. Upload the archive to the website\'s root directory via file browser first, then provide its filename in this request. Website contents are overwritten by the archive contents. Supported archive types: .zip, .tar, .tar.gz, .tgz.
|
|
13637
13994
|
* @summary Import website from archive
|
|
@@ -13647,6 +14004,14 @@ export declare const AgencyHostingFilesApiAxiosParamCreator: (configuration?: Co
|
|
|
13647
14004
|
* @export
|
|
13648
14005
|
*/
|
|
13649
14006
|
export declare const AgencyHostingFilesApiFp: (configuration?: Configuration) => {
|
|
14007
|
+
/**
|
|
14008
|
+
* Generate a file browser upload URL with authentication credentials for uploading files to an Agency Plan website\'s file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s file storage via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside the website\'s file storage, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
14009
|
+
* @summary Generate upload URL
|
|
14010
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
14011
|
+
* @param {*} [options] Override http request option.
|
|
14012
|
+
* @throws {RequiredError}
|
|
14013
|
+
*/
|
|
14014
|
+
generateUploadURLV1(websiteUid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AgencyHostingV1FilesUploadUrlResource>>;
|
|
13650
14015
|
/**
|
|
13651
14016
|
* Imports an Agency Plan website from an already-uploaded archive. Upload the archive to the website\'s root directory via file browser first, then provide its filename in this request. Website contents are overwritten by the archive contents. Supported archive types: .zip, .tar, .tar.gz, .tgz.
|
|
13652
14017
|
* @summary Import website from archive
|
|
@@ -13662,6 +14027,14 @@ export declare const AgencyHostingFilesApiFp: (configuration?: Configuration) =>
|
|
|
13662
14027
|
* @export
|
|
13663
14028
|
*/
|
|
13664
14029
|
export declare const AgencyHostingFilesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
14030
|
+
/**
|
|
14031
|
+
* Generate a file browser upload URL with authentication credentials for uploading files to an Agency Plan website\'s file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s file storage via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside the website\'s file storage, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
14032
|
+
* @summary Generate upload URL
|
|
14033
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
14034
|
+
* @param {*} [options] Override http request option.
|
|
14035
|
+
* @throws {RequiredError}
|
|
14036
|
+
*/
|
|
14037
|
+
generateUploadURLV1(websiteUid: string, options?: RawAxiosRequestConfig): AxiosPromise<AgencyHostingV1FilesUploadUrlResource>;
|
|
13665
14038
|
/**
|
|
13666
14039
|
* Imports an Agency Plan website from an already-uploaded archive. Upload the archive to the website\'s root directory via file browser first, then provide its filename in this request. Website contents are overwritten by the archive contents. Supported archive types: .zip, .tar, .tar.gz, .tgz.
|
|
13667
14040
|
* @summary Import website from archive
|
|
@@ -13679,6 +14052,15 @@ export declare const AgencyHostingFilesApiFactory: (configuration?: Configuratio
|
|
|
13679
14052
|
* @extends {BaseAPI}
|
|
13680
14053
|
*/
|
|
13681
14054
|
export declare class AgencyHostingFilesApi extends BaseAPI {
|
|
14055
|
+
/**
|
|
14056
|
+
* Generate a file browser upload URL with authentication credentials for uploading files to an Agency Plan website\'s file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s file storage via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside the website\'s file storage, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
14057
|
+
* @summary Generate upload URL
|
|
14058
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
14059
|
+
* @param {*} [options] Override http request option.
|
|
14060
|
+
* @throws {RequiredError}
|
|
14061
|
+
* @memberof AgencyHostingFilesApi
|
|
14062
|
+
*/
|
|
14063
|
+
generateUploadURLV1(websiteUid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AgencyHostingV1FilesUploadUrlResource, any, {}, any>>;
|
|
13682
14064
|
/**
|
|
13683
14065
|
* Imports an Agency Plan website from an already-uploaded archive. Upload the archive to the website\'s root directory via file browser first, then provide its filename in this request. Website contents are overwritten by the archive contents. Supported archive types: .zip, .tar, .tar.gz, .tgz.
|
|
13684
14066
|
* @summary Import website from archive
|
|
@@ -18632,6 +19014,14 @@ export declare class HostingDomainsApi extends BaseAPI {
|
|
|
18632
19014
|
* @export
|
|
18633
19015
|
*/
|
|
18634
19016
|
export declare const HostingFilesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
19017
|
+
/**
|
|
19018
|
+
* Generate a file browser upload URL with authentication credentials for uploading files directly to a website\'s file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s `public_html` directory via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside `public_html`, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
19019
|
+
* @summary Generate upload URL
|
|
19020
|
+
* @param {HostingV1FilesGenerateUploadUrlRequest} hostingV1FilesGenerateUploadUrlRequest
|
|
19021
|
+
* @param {*} [options] Override http request option.
|
|
19022
|
+
* @throws {RequiredError}
|
|
19023
|
+
*/
|
|
19024
|
+
generateUploadURLV1: (hostingV1FilesGenerateUploadUrlRequest: HostingV1FilesGenerateUploadUrlRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18635
19025
|
/**
|
|
18636
19026
|
* Get a single file\'s content, relative to a website\'s document root. Read-only; refuses symlinks, oversized files, non-text file types, and files identified as containing secrets (e.g. credential files) — none of these are returned by this endpoint.
|
|
18637
19027
|
* @summary Get website file content
|
|
@@ -18664,6 +19054,14 @@ export declare const HostingFilesApiAxiosParamCreator: (configuration?: Configur
|
|
|
18664
19054
|
* @export
|
|
18665
19055
|
*/
|
|
18666
19056
|
export declare const HostingFilesApiFp: (configuration?: Configuration) => {
|
|
19057
|
+
/**
|
|
19058
|
+
* Generate a file browser upload URL with authentication credentials for uploading files directly to a website\'s file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s `public_html` directory via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside `public_html`, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
19059
|
+
* @summary Generate upload URL
|
|
19060
|
+
* @param {HostingV1FilesGenerateUploadUrlRequest} hostingV1FilesGenerateUploadUrlRequest
|
|
19061
|
+
* @param {*} [options] Override http request option.
|
|
19062
|
+
* @throws {RequiredError}
|
|
19063
|
+
*/
|
|
19064
|
+
generateUploadURLV1(hostingV1FilesGenerateUploadUrlRequest: HostingV1FilesGenerateUploadUrlRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1FilesUploadUrlResource>>;
|
|
18667
19065
|
/**
|
|
18668
19066
|
* Get a single file\'s content, relative to a website\'s document root. Read-only; refuses symlinks, oversized files, non-text file types, and files identified as containing secrets (e.g. credential files) — none of these are returned by this endpoint.
|
|
18669
19067
|
* @summary Get website file content
|
|
@@ -18696,6 +19094,14 @@ export declare const HostingFilesApiFp: (configuration?: Configuration) => {
|
|
|
18696
19094
|
* @export
|
|
18697
19095
|
*/
|
|
18698
19096
|
export declare const HostingFilesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
19097
|
+
/**
|
|
19098
|
+
* Generate a file browser upload URL with authentication credentials for uploading files directly to a website\'s file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s `public_html` directory via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside `public_html`, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
19099
|
+
* @summary Generate upload URL
|
|
19100
|
+
* @param {HostingV1FilesGenerateUploadUrlRequest} hostingV1FilesGenerateUploadUrlRequest
|
|
19101
|
+
* @param {*} [options] Override http request option.
|
|
19102
|
+
* @throws {RequiredError}
|
|
19103
|
+
*/
|
|
19104
|
+
generateUploadURLV1(hostingV1FilesGenerateUploadUrlRequest: HostingV1FilesGenerateUploadUrlRequest, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1FilesUploadUrlResource>;
|
|
18699
19105
|
/**
|
|
18700
19106
|
* Get a single file\'s content, relative to a website\'s document root. Read-only; refuses symlinks, oversized files, non-text file types, and files identified as containing secrets (e.g. credential files) — none of these are returned by this endpoint.
|
|
18701
19107
|
* @summary Get website file content
|
|
@@ -18730,6 +19136,15 @@ export declare const HostingFilesApiFactory: (configuration?: Configuration, bas
|
|
|
18730
19136
|
* @extends {BaseAPI}
|
|
18731
19137
|
*/
|
|
18732
19138
|
export declare class HostingFilesApi extends BaseAPI {
|
|
19139
|
+
/**
|
|
19140
|
+
* Generate a file browser upload URL with authentication credentials for uploading files directly to a website\'s file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s `public_html` directory via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside `public_html`, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
19141
|
+
* @summary Generate upload URL
|
|
19142
|
+
* @param {HostingV1FilesGenerateUploadUrlRequest} hostingV1FilesGenerateUploadUrlRequest
|
|
19143
|
+
* @param {*} [options] Override http request option.
|
|
19144
|
+
* @throws {RequiredError}
|
|
19145
|
+
* @memberof HostingFilesApi
|
|
19146
|
+
*/
|
|
19147
|
+
generateUploadURLV1(hostingV1FilesGenerateUploadUrlRequest: HostingV1FilesGenerateUploadUrlRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1FilesUploadUrlResource, any, {}, any>>;
|
|
18733
19148
|
/**
|
|
18734
19149
|
* Get a single file\'s content, relative to a website\'s document root. Read-only; refuses symlinks, oversized files, non-text file types, and files identified as containing secrets (e.g. credential files) — none of these are returned by this endpoint.
|
|
18735
19150
|
* @summary Get website file content
|
|
@@ -18775,7 +19190,7 @@ export type ListWebsiteFilesAndDirectoriesV1FileTypesEnum = typeof ListWebsiteFi
|
|
|
18775
19190
|
*/
|
|
18776
19191
|
export declare const HostingNodeJSApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
18777
19192
|
/**
|
|
18778
|
-
* Upload a project archive, auto-detect build settings, and immediately start a Node.js build. This is the recommended single-step approach for deploying a Node.js application. The archive is uploaded to the website\'s file storage, build settings are auto-detected from the package.json inside the archive, and the build process starts automatically. Optional override fields take precedence over auto-detected values. Maximum archive size is 50MB. Before archiving, exclude `node_modules/` and any build output directories (e.g. `dist/`, `.next/`, `build/`) — they are not needed because the build process runs the install step automatically, and including them unnecessarily increases the archive size. This also helps keep the archive well under the 50MB limit. Example (zip): ``` zip -r archive.zip . --exclude \"node_modules/_*\" --exclude \"dist/_*\" ``` The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
19193
|
+
* Upload a project archive, auto-detect build settings, and immediately start a Node.js build. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This is the recommended single-step approach for deploying a Node.js application. The archive is uploaded to the website\'s file storage, build settings are auto-detected from the package.json inside the archive, and the build process starts automatically. Optional override fields take precedence over auto-detected values. Maximum archive size is 50MB. Before archiving, exclude `node_modules/` and any build output directories (e.g. `dist/`, `.next/`, `build/`) — they are not needed because the build process runs the install step automatically, and including them unnecessarily increases the archive size. This also helps keep the archive well under the 50MB limit. Example (zip): ``` zip -r archive.zip . --exclude \"node_modules/_*\" --exclude \"dist/_*\" ``` The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
18779
19194
|
* @summary Create NodeJS build from archive
|
|
18780
19195
|
* @param {string} username
|
|
18781
19196
|
* @param {string} domain Domain name
|
|
@@ -18795,6 +19210,16 @@ export declare const HostingNodeJSApiAxiosParamCreator: (configuration?: Configu
|
|
|
18795
19210
|
* @throws {RequiredError}
|
|
18796
19211
|
*/
|
|
18797
19212
|
getNodeJSBuildLogsV1: (username: string, domain: string, uuid: string, fromLine?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19213
|
+
/**
|
|
19214
|
+
* Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website\'s file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To upload an archive and start a build in one step without inspecting settings first, use the `Create Node.js Build from Archive` endpoint instead.
|
|
19215
|
+
* @summary Get Node.js build settings from archive
|
|
19216
|
+
* @param {string} username
|
|
19217
|
+
* @param {string} domain Domain name
|
|
19218
|
+
* @param {string} archivePath The path to the archive file relative to the document root of the vhost
|
|
19219
|
+
* @param {*} [options] Override http request option.
|
|
19220
|
+
* @throws {RequiredError}
|
|
19221
|
+
*/
|
|
19222
|
+
getNodeJsBuildSettingsFromArchiveV1: (username: string, domain: string, archivePath: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18798
19223
|
/**
|
|
18799
19224
|
* Retrieve a paginated list of Node.js build processes for a specific website. Each build represents a single run of the Node.js build pipeline. Use the `states` query parameter to filter results by build state (pending, running, completed, failed). Use the `uuid` from a build to poll its output via the `Get Node.js Build Logs` endpoint.
|
|
18800
19225
|
* @summary List NodeJS builds
|
|
@@ -18836,6 +19261,16 @@ export declare const HostingNodeJSApiAxiosParamCreator: (configuration?: Configu
|
|
|
18836
19261
|
* @throws {RequiredError}
|
|
18837
19262
|
*/
|
|
18838
19263
|
restartNodeJsApplicationV1: (username: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19264
|
+
/**
|
|
19265
|
+
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. The `source_type` must be `archive` and `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint. To upload an archive and start a build in one step, use the `Create Node.js Build from Archive` endpoint instead. The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
19266
|
+
* @summary Start Node.js build
|
|
19267
|
+
* @param {string} username
|
|
19268
|
+
* @param {string} domain Domain name
|
|
19269
|
+
* @param {HostingV1NodeJsStartBuildRequest} hostingV1NodeJsStartBuildRequest
|
|
19270
|
+
* @param {*} [options] Override http request option.
|
|
19271
|
+
* @throws {RequiredError}
|
|
19272
|
+
*/
|
|
19273
|
+
startNodeJsBuildV1: (username: string, domain: string, hostingV1NodeJsStartBuildRequest: HostingV1NodeJsStartBuildRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18839
19274
|
};
|
|
18840
19275
|
/**
|
|
18841
19276
|
* HostingNodeJSApi - functional programming interface
|
|
@@ -18843,7 +19278,7 @@ export declare const HostingNodeJSApiAxiosParamCreator: (configuration?: Configu
|
|
|
18843
19278
|
*/
|
|
18844
19279
|
export declare const HostingNodeJSApiFp: (configuration?: Configuration) => {
|
|
18845
19280
|
/**
|
|
18846
|
-
* Upload a project archive, auto-detect build settings, and immediately start a Node.js build. This is the recommended single-step approach for deploying a Node.js application. The archive is uploaded to the website\'s file storage, build settings are auto-detected from the package.json inside the archive, and the build process starts automatically. Optional override fields take precedence over auto-detected values. Maximum archive size is 50MB. Before archiving, exclude `node_modules/` and any build output directories (e.g. `dist/`, `.next/`, `build/`) — they are not needed because the build process runs the install step automatically, and including them unnecessarily increases the archive size. This also helps keep the archive well under the 50MB limit. Example (zip): ``` zip -r archive.zip . --exclude \"node_modules/_*\" --exclude \"dist/_*\" ``` The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
19281
|
+
* Upload a project archive, auto-detect build settings, and immediately start a Node.js build. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This is the recommended single-step approach for deploying a Node.js application. The archive is uploaded to the website\'s file storage, build settings are auto-detected from the package.json inside the archive, and the build process starts automatically. Optional override fields take precedence over auto-detected values. Maximum archive size is 50MB. Before archiving, exclude `node_modules/` and any build output directories (e.g. `dist/`, `.next/`, `build/`) — they are not needed because the build process runs the install step automatically, and including them unnecessarily increases the archive size. This also helps keep the archive well under the 50MB limit. Example (zip): ``` zip -r archive.zip . --exclude \"node_modules/_*\" --exclude \"dist/_*\" ``` The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
18847
19282
|
* @summary Create NodeJS build from archive
|
|
18848
19283
|
* @param {string} username
|
|
18849
19284
|
* @param {string} domain Domain name
|
|
@@ -18863,6 +19298,16 @@ export declare const HostingNodeJSApiFp: (configuration?: Configuration) => {
|
|
|
18863
19298
|
* @throws {RequiredError}
|
|
18864
19299
|
*/
|
|
18865
19300
|
getNodeJSBuildLogsV1(username: string, domain: string, uuid: string, fromLine?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1NodeJsBuildLogsResource>>;
|
|
19301
|
+
/**
|
|
19302
|
+
* Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website\'s file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To upload an archive and start a build in one step without inspecting settings first, use the `Create Node.js Build from Archive` endpoint instead.
|
|
19303
|
+
* @summary Get Node.js build settings from archive
|
|
19304
|
+
* @param {string} username
|
|
19305
|
+
* @param {string} domain Domain name
|
|
19306
|
+
* @param {string} archivePath The path to the archive file relative to the document root of the vhost
|
|
19307
|
+
* @param {*} [options] Override http request option.
|
|
19308
|
+
* @throws {RequiredError}
|
|
19309
|
+
*/
|
|
19310
|
+
getNodeJsBuildSettingsFromArchiveV1(username: string, domain: string, archivePath: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1NodeJsBuildSettingsResource>>;
|
|
18866
19311
|
/**
|
|
18867
19312
|
* Retrieve a paginated list of Node.js build processes for a specific website. Each build represents a single run of the Node.js build pipeline. Use the `states` query parameter to filter results by build state (pending, running, completed, failed). Use the `uuid` from a build to poll its output via the `Get Node.js Build Logs` endpoint.
|
|
18868
19313
|
* @summary List NodeJS builds
|
|
@@ -18904,6 +19349,16 @@ export declare const HostingNodeJSApiFp: (configuration?: Configuration) => {
|
|
|
18904
19349
|
* @throws {RequiredError}
|
|
18905
19350
|
*/
|
|
18906
19351
|
restartNodeJsApplicationV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
19352
|
+
/**
|
|
19353
|
+
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. The `source_type` must be `archive` and `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint. To upload an archive and start a build in one step, use the `Create Node.js Build from Archive` endpoint instead. The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
19354
|
+
* @summary Start Node.js build
|
|
19355
|
+
* @param {string} username
|
|
19356
|
+
* @param {string} domain Domain name
|
|
19357
|
+
* @param {HostingV1NodeJsStartBuildRequest} hostingV1NodeJsStartBuildRequest
|
|
19358
|
+
* @param {*} [options] Override http request option.
|
|
19359
|
+
* @throws {RequiredError}
|
|
19360
|
+
*/
|
|
19361
|
+
startNodeJsBuildV1(username: string, domain: string, hostingV1NodeJsStartBuildRequest: HostingV1NodeJsStartBuildRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1NodeJsBuildResource>>;
|
|
18907
19362
|
};
|
|
18908
19363
|
/**
|
|
18909
19364
|
* HostingNodeJSApi - factory interface
|
|
@@ -18911,7 +19366,7 @@ export declare const HostingNodeJSApiFp: (configuration?: Configuration) => {
|
|
|
18911
19366
|
*/
|
|
18912
19367
|
export declare const HostingNodeJSApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
18913
19368
|
/**
|
|
18914
|
-
* Upload a project archive, auto-detect build settings, and immediately start a Node.js build. This is the recommended single-step approach for deploying a Node.js application. The archive is uploaded to the website\'s file storage, build settings are auto-detected from the package.json inside the archive, and the build process starts automatically. Optional override fields take precedence over auto-detected values. Maximum archive size is 50MB. Before archiving, exclude `node_modules/` and any build output directories (e.g. `dist/`, `.next/`, `build/`) — they are not needed because the build process runs the install step automatically, and including them unnecessarily increases the archive size. This also helps keep the archive well under the 50MB limit. Example (zip): ``` zip -r archive.zip . --exclude \"node_modules/_*\" --exclude \"dist/_*\" ``` The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
19369
|
+
* Upload a project archive, auto-detect build settings, and immediately start a Node.js build. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This is the recommended single-step approach for deploying a Node.js application. The archive is uploaded to the website\'s file storage, build settings are auto-detected from the package.json inside the archive, and the build process starts automatically. Optional override fields take precedence over auto-detected values. Maximum archive size is 50MB. Before archiving, exclude `node_modules/` and any build output directories (e.g. `dist/`, `.next/`, `build/`) — they are not needed because the build process runs the install step automatically, and including them unnecessarily increases the archive size. This also helps keep the archive well under the 50MB limit. Example (zip): ``` zip -r archive.zip . --exclude \"node_modules/_*\" --exclude \"dist/_*\" ``` The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
18915
19370
|
* @summary Create NodeJS build from archive
|
|
18916
19371
|
* @param {string} username
|
|
18917
19372
|
* @param {string} domain Domain name
|
|
@@ -18931,6 +19386,16 @@ export declare const HostingNodeJSApiFactory: (configuration?: Configuration, ba
|
|
|
18931
19386
|
* @throws {RequiredError}
|
|
18932
19387
|
*/
|
|
18933
19388
|
getNodeJSBuildLogsV1(username: string, domain: string, uuid: string, fromLine?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1NodeJsBuildLogsResource>;
|
|
19389
|
+
/**
|
|
19390
|
+
* Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website\'s file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To upload an archive and start a build in one step without inspecting settings first, use the `Create Node.js Build from Archive` endpoint instead.
|
|
19391
|
+
* @summary Get Node.js build settings from archive
|
|
19392
|
+
* @param {string} username
|
|
19393
|
+
* @param {string} domain Domain name
|
|
19394
|
+
* @param {string} archivePath The path to the archive file relative to the document root of the vhost
|
|
19395
|
+
* @param {*} [options] Override http request option.
|
|
19396
|
+
* @throws {RequiredError}
|
|
19397
|
+
*/
|
|
19398
|
+
getNodeJsBuildSettingsFromArchiveV1(username: string, domain: string, archivePath: string, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1NodeJsBuildSettingsResource>;
|
|
18934
19399
|
/**
|
|
18935
19400
|
* Retrieve a paginated list of Node.js build processes for a specific website. Each build represents a single run of the Node.js build pipeline. Use the `states` query parameter to filter results by build state (pending, running, completed, failed). Use the `uuid` from a build to poll its output via the `Get Node.js Build Logs` endpoint.
|
|
18936
19401
|
* @summary List NodeJS builds
|
|
@@ -18972,6 +19437,16 @@ export declare const HostingNodeJSApiFactory: (configuration?: Configuration, ba
|
|
|
18972
19437
|
* @throws {RequiredError}
|
|
18973
19438
|
*/
|
|
18974
19439
|
restartNodeJsApplicationV1(username: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
19440
|
+
/**
|
|
19441
|
+
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. The `source_type` must be `archive` and `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint. To upload an archive and start a build in one step, use the `Create Node.js Build from Archive` endpoint instead. The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
19442
|
+
* @summary Start Node.js build
|
|
19443
|
+
* @param {string} username
|
|
19444
|
+
* @param {string} domain Domain name
|
|
19445
|
+
* @param {HostingV1NodeJsStartBuildRequest} hostingV1NodeJsStartBuildRequest
|
|
19446
|
+
* @param {*} [options] Override http request option.
|
|
19447
|
+
* @throws {RequiredError}
|
|
19448
|
+
*/
|
|
19449
|
+
startNodeJsBuildV1(username: string, domain: string, hostingV1NodeJsStartBuildRequest: HostingV1NodeJsStartBuildRequest, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1NodeJsBuildResource>;
|
|
18975
19450
|
};
|
|
18976
19451
|
/**
|
|
18977
19452
|
* HostingNodeJSApi - object-oriented interface
|
|
@@ -18981,7 +19456,7 @@ export declare const HostingNodeJSApiFactory: (configuration?: Configuration, ba
|
|
|
18981
19456
|
*/
|
|
18982
19457
|
export declare class HostingNodeJSApi extends BaseAPI {
|
|
18983
19458
|
/**
|
|
18984
|
-
* Upload a project archive, auto-detect build settings, and immediately start a Node.js build. This is the recommended single-step approach for deploying a Node.js application. The archive is uploaded to the website\'s file storage, build settings are auto-detected from the package.json inside the archive, and the build process starts automatically. Optional override fields take precedence over auto-detected values. Maximum archive size is 50MB. Before archiving, exclude `node_modules/` and any build output directories (e.g. `dist/`, `.next/`, `build/`) — they are not needed because the build process runs the install step automatically, and including them unnecessarily increases the archive size. This also helps keep the archive well under the 50MB limit. Example (zip): ``` zip -r archive.zip . --exclude \"node_modules/_*\" --exclude \"dist/_*\" ``` The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
19459
|
+
* Upload a project archive, auto-detect build settings, and immediately start a Node.js build. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This is the recommended single-step approach for deploying a Node.js application. The archive is uploaded to the website\'s file storage, build settings are auto-detected from the package.json inside the archive, and the build process starts automatically. Optional override fields take precedence over auto-detected values. Maximum archive size is 50MB. Before archiving, exclude `node_modules/` and any build output directories (e.g. `dist/`, `.next/`, `build/`) — they are not needed because the build process runs the install step automatically, and including them unnecessarily increases the archive size. This also helps keep the archive well under the 50MB limit. Example (zip): ``` zip -r archive.zip . --exclude \"node_modules/_*\" --exclude \"dist/_*\" ``` The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
18985
19460
|
* @summary Create NodeJS build from archive
|
|
18986
19461
|
* @param {string} username
|
|
18987
19462
|
* @param {string} domain Domain name
|
|
@@ -19003,6 +19478,17 @@ export declare class HostingNodeJSApi extends BaseAPI {
|
|
|
19003
19478
|
* @memberof HostingNodeJSApi
|
|
19004
19479
|
*/
|
|
19005
19480
|
getNodeJSBuildLogsV1(username: string, domain: string, uuid: string, fromLine?: number | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1NodeJsBuildLogsResource, any, {}, any>>;
|
|
19481
|
+
/**
|
|
19482
|
+
* Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website\'s file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To upload an archive and start a build in one step without inspecting settings first, use the `Create Node.js Build from Archive` endpoint instead.
|
|
19483
|
+
* @summary Get Node.js build settings from archive
|
|
19484
|
+
* @param {string} username
|
|
19485
|
+
* @param {string} domain Domain name
|
|
19486
|
+
* @param {string} archivePath The path to the archive file relative to the document root of the vhost
|
|
19487
|
+
* @param {*} [options] Override http request option.
|
|
19488
|
+
* @throws {RequiredError}
|
|
19489
|
+
* @memberof HostingNodeJSApi
|
|
19490
|
+
*/
|
|
19491
|
+
getNodeJsBuildSettingsFromArchiveV1(username: string, domain: string, archivePath: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1NodeJsBuildSettingsResource, any, {}, any>>;
|
|
19006
19492
|
/**
|
|
19007
19493
|
* Retrieve a paginated list of Node.js build processes for a specific website. Each build represents a single run of the Node.js build pipeline. Use the `states` query parameter to filter results by build state (pending, running, completed, failed). Use the `uuid` from a build to poll its output via the `Get Node.js Build Logs` endpoint.
|
|
19008
19494
|
* @summary List NodeJS builds
|
|
@@ -19048,6 +19534,17 @@ export declare class HostingNodeJSApi extends BaseAPI {
|
|
|
19048
19534
|
* @memberof HostingNodeJSApi
|
|
19049
19535
|
*/
|
|
19050
19536
|
restartNodeJsApplicationV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
19537
|
+
/**
|
|
19538
|
+
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. The `source_type` must be `archive` and `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint. To upload an archive and start a build in one step, use the `Create Node.js Build from Archive` endpoint instead. The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
19539
|
+
* @summary Start Node.js build
|
|
19540
|
+
* @param {string} username
|
|
19541
|
+
* @param {string} domain Domain name
|
|
19542
|
+
* @param {HostingV1NodeJsStartBuildRequest} hostingV1NodeJsStartBuildRequest
|
|
19543
|
+
* @param {*} [options] Override http request option.
|
|
19544
|
+
* @throws {RequiredError}
|
|
19545
|
+
* @memberof HostingNodeJSApi
|
|
19546
|
+
*/
|
|
19547
|
+
startNodeJsBuildV1(username: string, domain: string, hostingV1NodeJsStartBuildRequest: HostingV1NodeJsStartBuildRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1NodeJsBuildResource, any, {}, any>>;
|
|
19051
19548
|
}
|
|
19052
19549
|
/**
|
|
19053
19550
|
* @export
|
|
@@ -19586,7 +20083,17 @@ export declare const HostingWebsitesApiAxiosParamCreator: (configuration?: Confi
|
|
|
19586
20083
|
*/
|
|
19587
20084
|
deleteWebsiteV1: (domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19588
20085
|
/**
|
|
19589
|
-
*
|
|
20086
|
+
* Deploy a static application from an archive file. WARNING: this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This endpoint allows you to deploy a static application from an archive file that has been uploaded to the website\'s directory. This only works for static sites (pre-built HTML/CSS/JS with no build step). For Node.js applications, use `Create NodeJS build from archive` instead, or `Start Node.js build` if the archive is already uploaded. For WordPress sites, use `Import WordPress website`.
|
|
20087
|
+
* @summary Deploy static site archive
|
|
20088
|
+
* @param {string} username
|
|
20089
|
+
* @param {string} domain Domain name
|
|
20090
|
+
* @param {HostingV1WebsitesDeployArchiveRequest} hostingV1WebsitesDeployArchiveRequest
|
|
20091
|
+
* @param {*} [options] Override http request option.
|
|
20092
|
+
* @throws {RequiredError}
|
|
20093
|
+
*/
|
|
20094
|
+
deployStaticSiteArchiveV1: (username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
20095
|
+
/**
|
|
20096
|
+
* Retrieve a paginated list of websites (CloudLinux, Builder, and Horizons) accessible to the authenticated client. This endpoint returns websites from your hosting accounts as well as websites from other client hosting accounts that have shared access with you. Each website includes a `website_type` field describing the type of website detected on the underlying platform (`wordpress`, `builder`, `horizons`, `nodejs`, or `other`). Some fields, such as `vhost_type`, `username`, and `root_directory`, only apply to CloudLinux websites and are null for other platforms. Use the available query parameters to filter results by username, order ID, enabled status, or domain name for more targeted results.
|
|
19590
20097
|
* @summary List websites
|
|
19591
20098
|
* @param {number} [page] Page number
|
|
19592
20099
|
* @param {number} [perPage] Number of items per page
|
|
@@ -19621,7 +20128,17 @@ export declare const HostingWebsitesApiFp: (configuration?: Configuration) => {
|
|
|
19621
20128
|
*/
|
|
19622
20129
|
deleteWebsiteV1(domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
19623
20130
|
/**
|
|
19624
|
-
*
|
|
20131
|
+
* Deploy a static application from an archive file. WARNING: this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This endpoint allows you to deploy a static application from an archive file that has been uploaded to the website\'s directory. This only works for static sites (pre-built HTML/CSS/JS with no build step). For Node.js applications, use `Create NodeJS build from archive` instead, or `Start Node.js build` if the archive is already uploaded. For WordPress sites, use `Import WordPress website`.
|
|
20132
|
+
* @summary Deploy static site archive
|
|
20133
|
+
* @param {string} username
|
|
20134
|
+
* @param {string} domain Domain name
|
|
20135
|
+
* @param {HostingV1WebsitesDeployArchiveRequest} hostingV1WebsitesDeployArchiveRequest
|
|
20136
|
+
* @param {*} [options] Override http request option.
|
|
20137
|
+
* @throws {RequiredError}
|
|
20138
|
+
*/
|
|
20139
|
+
deployStaticSiteArchiveV1(username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
20140
|
+
/**
|
|
20141
|
+
* Retrieve a paginated list of websites (CloudLinux, Builder, and Horizons) accessible to the authenticated client. This endpoint returns websites from your hosting accounts as well as websites from other client hosting accounts that have shared access with you. Each website includes a `website_type` field describing the type of website detected on the underlying platform (`wordpress`, `builder`, `horizons`, `nodejs`, or `other`). Some fields, such as `vhost_type`, `username`, and `root_directory`, only apply to CloudLinux websites and are null for other platforms. Use the available query parameters to filter results by username, order ID, enabled status, or domain name for more targeted results.
|
|
19625
20142
|
* @summary List websites
|
|
19626
20143
|
* @param {number} [page] Page number
|
|
19627
20144
|
* @param {number} [perPage] Number of items per page
|
|
@@ -19656,7 +20173,17 @@ export declare const HostingWebsitesApiFactory: (configuration?: Configuration,
|
|
|
19656
20173
|
*/
|
|
19657
20174
|
deleteWebsiteV1(domain: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
19658
20175
|
/**
|
|
19659
|
-
*
|
|
20176
|
+
* Deploy a static application from an archive file. WARNING: this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This endpoint allows you to deploy a static application from an archive file that has been uploaded to the website\'s directory. This only works for static sites (pre-built HTML/CSS/JS with no build step). For Node.js applications, use `Create NodeJS build from archive` instead, or `Start Node.js build` if the archive is already uploaded. For WordPress sites, use `Import WordPress website`.
|
|
20177
|
+
* @summary Deploy static site archive
|
|
20178
|
+
* @param {string} username
|
|
20179
|
+
* @param {string} domain Domain name
|
|
20180
|
+
* @param {HostingV1WebsitesDeployArchiveRequest} hostingV1WebsitesDeployArchiveRequest
|
|
20181
|
+
* @param {*} [options] Override http request option.
|
|
20182
|
+
* @throws {RequiredError}
|
|
20183
|
+
*/
|
|
20184
|
+
deployStaticSiteArchiveV1(username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
20185
|
+
/**
|
|
20186
|
+
* Retrieve a paginated list of websites (CloudLinux, Builder, and Horizons) accessible to the authenticated client. This endpoint returns websites from your hosting accounts as well as websites from other client hosting accounts that have shared access with you. Each website includes a `website_type` field describing the type of website detected on the underlying platform (`wordpress`, `builder`, `horizons`, `nodejs`, or `other`). Some fields, such as `vhost_type`, `username`, and `root_directory`, only apply to CloudLinux websites and are null for other platforms. Use the available query parameters to filter results by username, order ID, enabled status, or domain name for more targeted results.
|
|
19660
20187
|
* @summary List websites
|
|
19661
20188
|
* @param {number} [page] Page number
|
|
19662
20189
|
* @param {number} [perPage] Number of items per page
|
|
@@ -19695,7 +20222,18 @@ export declare class HostingWebsitesApi extends BaseAPI {
|
|
|
19695
20222
|
*/
|
|
19696
20223
|
deleteWebsiteV1(domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
19697
20224
|
/**
|
|
19698
|
-
*
|
|
20225
|
+
* Deploy a static application from an archive file. WARNING: this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This endpoint allows you to deploy a static application from an archive file that has been uploaded to the website\'s directory. This only works for static sites (pre-built HTML/CSS/JS with no build step). For Node.js applications, use `Create NodeJS build from archive` instead, or `Start Node.js build` if the archive is already uploaded. For WordPress sites, use `Import WordPress website`.
|
|
20226
|
+
* @summary Deploy static site archive
|
|
20227
|
+
* @param {string} username
|
|
20228
|
+
* @param {string} domain Domain name
|
|
20229
|
+
* @param {HostingV1WebsitesDeployArchiveRequest} hostingV1WebsitesDeployArchiveRequest
|
|
20230
|
+
* @param {*} [options] Override http request option.
|
|
20231
|
+
* @throws {RequiredError}
|
|
20232
|
+
* @memberof HostingWebsitesApi
|
|
20233
|
+
*/
|
|
20234
|
+
deployStaticSiteArchiveV1(username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
20235
|
+
/**
|
|
20236
|
+
* Retrieve a paginated list of websites (CloudLinux, Builder, and Horizons) accessible to the authenticated client. This endpoint returns websites from your hosting accounts as well as websites from other client hosting accounts that have shared access with you. Each website includes a `website_type` field describing the type of website detected on the underlying platform (`wordpress`, `builder`, `horizons`, `nodejs`, or `other`). Some fields, such as `vhost_type`, `username`, and `root_directory`, only apply to CloudLinux websites and are null for other platforms. Use the available query parameters to filter results by username, order ID, enabled status, or domain name for more targeted results.
|
|
19699
20237
|
* @summary List websites
|
|
19700
20238
|
* @param {number} [page] Page number
|
|
19701
20239
|
* @param {number} [perPage] Number of items per page
|
|
@@ -26290,6 +26828,16 @@ export declare const WordPressInstallationsApiAxiosParamCreator: (configuration?
|
|
|
26290
26828
|
* @throws {RequiredError}
|
|
26291
26829
|
*/
|
|
26292
26830
|
getInstallationJWTTokenV1: (username: string, software: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
26831
|
+
/**
|
|
26832
|
+
* Import WordPress website to the specified domain. WARNING: this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This endpoint allows you to import a WordPress website from archive and database files that have been uploaded to the website\'s directory.
|
|
26833
|
+
* @summary Import WordPress website
|
|
26834
|
+
* @param {string} username
|
|
26835
|
+
* @param {string} domain Domain name
|
|
26836
|
+
* @param {WordPressV1InstallationsImportWordPressRequest} wordPressV1InstallationsImportWordPressRequest
|
|
26837
|
+
* @param {*} [options] Override http request option.
|
|
26838
|
+
* @throws {RequiredError}
|
|
26839
|
+
*/
|
|
26840
|
+
importWordPressWebsiteV1: (username: string, domain: string, wordPressV1InstallationsImportWordPressRequest: WordPressV1InstallationsImportWordPressRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
26293
26841
|
/**
|
|
26294
26842
|
* Install WordPress on an existing website. The website must already exist before calling this endpoint. To create a new website first, use POST /api/hosting/v1/websites and poll GET /api/hosting/v1/websites until it appears. Call GET /api/hosting/v1/wordpress/installations filtered by username and domain before proceeding to check whether WordPress is already installed on the target domain/path. If WordPress already exists and `overwrite` is false (the default), the async job will fail. This operation is asynchronous: a successful response only means the install job has been queued, not that WordPress is ready. Installation typically takes 1-2 minutes. Poll GET /api/hosting/v1/wordpress/installations filtered by username and domain to track progress. When the installation appears in that list, WordPress is ready.
|
|
26295
26843
|
* @summary Install WordPress
|
|
@@ -26379,6 +26927,16 @@ export declare const WordPressInstallationsApiFp: (configuration?: Configuration
|
|
|
26379
26927
|
* @throws {RequiredError}
|
|
26380
26928
|
*/
|
|
26381
26929
|
getInstallationJWTTokenV1(username: string, software: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WordPressV1InstallationsJwtTokenResource>>;
|
|
26930
|
+
/**
|
|
26931
|
+
* Import WordPress website to the specified domain. WARNING: this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This endpoint allows you to import a WordPress website from archive and database files that have been uploaded to the website\'s directory.
|
|
26932
|
+
* @summary Import WordPress website
|
|
26933
|
+
* @param {string} username
|
|
26934
|
+
* @param {string} domain Domain name
|
|
26935
|
+
* @param {WordPressV1InstallationsImportWordPressRequest} wordPressV1InstallationsImportWordPressRequest
|
|
26936
|
+
* @param {*} [options] Override http request option.
|
|
26937
|
+
* @throws {RequiredError}
|
|
26938
|
+
*/
|
|
26939
|
+
importWordPressWebsiteV1(username: string, domain: string, wordPressV1InstallationsImportWordPressRequest: WordPressV1InstallationsImportWordPressRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
26382
26940
|
/**
|
|
26383
26941
|
* Install WordPress on an existing website. The website must already exist before calling this endpoint. To create a new website first, use POST /api/hosting/v1/websites and poll GET /api/hosting/v1/websites until it appears. Call GET /api/hosting/v1/wordpress/installations filtered by username and domain before proceeding to check whether WordPress is already installed on the target domain/path. If WordPress already exists and `overwrite` is false (the default), the async job will fail. This operation is asynchronous: a successful response only means the install job has been queued, not that WordPress is ready. Installation typically takes 1-2 minutes. Poll GET /api/hosting/v1/wordpress/installations filtered by username and domain to track progress. When the installation appears in that list, WordPress is ready.
|
|
26384
26942
|
* @summary Install WordPress
|
|
@@ -26468,6 +27026,16 @@ export declare const WordPressInstallationsApiFactory: (configuration?: Configur
|
|
|
26468
27026
|
* @throws {RequiredError}
|
|
26469
27027
|
*/
|
|
26470
27028
|
getInstallationJWTTokenV1(username: string, software: string, options?: RawAxiosRequestConfig): AxiosPromise<WordPressV1InstallationsJwtTokenResource>;
|
|
27029
|
+
/**
|
|
27030
|
+
* Import WordPress website to the specified domain. WARNING: this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This endpoint allows you to import a WordPress website from archive and database files that have been uploaded to the website\'s directory.
|
|
27031
|
+
* @summary Import WordPress website
|
|
27032
|
+
* @param {string} username
|
|
27033
|
+
* @param {string} domain Domain name
|
|
27034
|
+
* @param {WordPressV1InstallationsImportWordPressRequest} wordPressV1InstallationsImportWordPressRequest
|
|
27035
|
+
* @param {*} [options] Override http request option.
|
|
27036
|
+
* @throws {RequiredError}
|
|
27037
|
+
*/
|
|
27038
|
+
importWordPressWebsiteV1(username: string, domain: string, wordPressV1InstallationsImportWordPressRequest: WordPressV1InstallationsImportWordPressRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
26471
27039
|
/**
|
|
26472
27040
|
* Install WordPress on an existing website. The website must already exist before calling this endpoint. To create a new website first, use POST /api/hosting/v1/websites and poll GET /api/hosting/v1/websites until it appears. Call GET /api/hosting/v1/wordpress/installations filtered by username and domain before proceeding to check whether WordPress is already installed on the target domain/path. If WordPress already exists and `overwrite` is false (the default), the async job will fail. This operation is asynchronous: a successful response only means the install job has been queued, not that WordPress is ready. Installation typically takes 1-2 minutes. Poll GET /api/hosting/v1/wordpress/installations filtered by username and domain to track progress. When the installation appears in that list, WordPress is ready.
|
|
26473
27041
|
* @summary Install WordPress
|
|
@@ -26563,6 +27131,17 @@ export declare class WordPressInstallationsApi extends BaseAPI {
|
|
|
26563
27131
|
* @memberof WordPressInstallationsApi
|
|
26564
27132
|
*/
|
|
26565
27133
|
getInstallationJWTTokenV1(username: string, software: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WordPressV1InstallationsJwtTokenResource, any, {}, any>>;
|
|
27134
|
+
/**
|
|
27135
|
+
* Import WordPress website to the specified domain. WARNING: this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This endpoint allows you to import a WordPress website from archive and database files that have been uploaded to the website\'s directory.
|
|
27136
|
+
* @summary Import WordPress website
|
|
27137
|
+
* @param {string} username
|
|
27138
|
+
* @param {string} domain Domain name
|
|
27139
|
+
* @param {WordPressV1InstallationsImportWordPressRequest} wordPressV1InstallationsImportWordPressRequest
|
|
27140
|
+
* @param {*} [options] Override http request option.
|
|
27141
|
+
* @throws {RequiredError}
|
|
27142
|
+
* @memberof WordPressInstallationsApi
|
|
27143
|
+
*/
|
|
27144
|
+
importWordPressWebsiteV1(username: string, domain: string, wordPressV1InstallationsImportWordPressRequest: WordPressV1InstallationsImportWordPressRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
26566
27145
|
/**
|
|
26567
27146
|
* Install WordPress on an existing website. The website must already exist before calling this endpoint. To create a new website first, use POST /api/hosting/v1/websites and poll GET /api/hosting/v1/websites until it appears. Call GET /api/hosting/v1/wordpress/installations filtered by username and domain before proceeding to check whether WordPress is already installed on the target domain/path. If WordPress already exists and `overwrite` is false (the default), the async job will fail. This operation is asynchronous: a successful response only means the install job has been queued, not that WordPress is ready. Installation typically takes 1-2 minutes. Poll GET /api/hosting/v1/wordpress/installations filtered by username and domain to track progress. When the installation appears in that list, WordPress is ready.
|
|
26568
27147
|
* @summary Install WordPress
|
|
@@ -27029,6 +27608,16 @@ export declare const WordPressPluginsApiAxiosParamCreator: (configuration?: Conf
|
|
|
27029
27608
|
* @throws {RequiredError}
|
|
27030
27609
|
*/
|
|
27031
27610
|
deactivateWordPressPluginV1: (username: string, software: string, wordPressV1PluginsDeactivatePluginRequest: WordPressV1PluginsDeactivatePluginRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
27611
|
+
/**
|
|
27612
|
+
* Deploy a WordPress plugin from an already uploaded directory. This endpoint allows you to deploy a WordPress plugin that has been uploaded to the website\'s directory. The plugin will be activated and made available in the WordPress admin panel.
|
|
27613
|
+
* @summary Deploy WordPress plugin
|
|
27614
|
+
* @param {string} username
|
|
27615
|
+
* @param {string} domain Domain name
|
|
27616
|
+
* @param {WordPressV1PluginsDeployPluginRequest} wordPressV1PluginsDeployPluginRequest
|
|
27617
|
+
* @param {*} [options] Override http request option.
|
|
27618
|
+
* @throws {RequiredError}
|
|
27619
|
+
*/
|
|
27620
|
+
deployWordPressPluginV1: (username: string, domain: string, wordPressV1PluginsDeployPluginRequest: WordPressV1PluginsDeployPluginRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
27032
27621
|
/**
|
|
27033
27622
|
* Install one or more plugins on an existing WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). Use GET /api/hosting/v1/wordpress/plugins to discover the plugin slugs available for installation. This operation is asynchronous: a successful response only means the install job has been queued, not that the plugins are ready.
|
|
27034
27623
|
* @summary Install WordPress plugins
|
|
@@ -27138,6 +27727,16 @@ export declare const WordPressPluginsApiFp: (configuration?: Configuration) => {
|
|
|
27138
27727
|
* @throws {RequiredError}
|
|
27139
27728
|
*/
|
|
27140
27729
|
deactivateWordPressPluginV1(username: string, software: string, wordPressV1PluginsDeactivatePluginRequest: WordPressV1PluginsDeactivatePluginRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
27730
|
+
/**
|
|
27731
|
+
* Deploy a WordPress plugin from an already uploaded directory. This endpoint allows you to deploy a WordPress plugin that has been uploaded to the website\'s directory. The plugin will be activated and made available in the WordPress admin panel.
|
|
27732
|
+
* @summary Deploy WordPress plugin
|
|
27733
|
+
* @param {string} username
|
|
27734
|
+
* @param {string} domain Domain name
|
|
27735
|
+
* @param {WordPressV1PluginsDeployPluginRequest} wordPressV1PluginsDeployPluginRequest
|
|
27736
|
+
* @param {*} [options] Override http request option.
|
|
27737
|
+
* @throws {RequiredError}
|
|
27738
|
+
*/
|
|
27739
|
+
deployWordPressPluginV1(username: string, domain: string, wordPressV1PluginsDeployPluginRequest: WordPressV1PluginsDeployPluginRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
27141
27740
|
/**
|
|
27142
27741
|
* Install one or more plugins on an existing WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). Use GET /api/hosting/v1/wordpress/plugins to discover the plugin slugs available for installation. This operation is asynchronous: a successful response only means the install job has been queued, not that the plugins are ready.
|
|
27143
27742
|
* @summary Install WordPress plugins
|
|
@@ -27247,6 +27846,16 @@ export declare const WordPressPluginsApiFactory: (configuration?: Configuration,
|
|
|
27247
27846
|
* @throws {RequiredError}
|
|
27248
27847
|
*/
|
|
27249
27848
|
deactivateWordPressPluginV1(username: string, software: string, wordPressV1PluginsDeactivatePluginRequest: WordPressV1PluginsDeactivatePluginRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
27849
|
+
/**
|
|
27850
|
+
* Deploy a WordPress plugin from an already uploaded directory. This endpoint allows you to deploy a WordPress plugin that has been uploaded to the website\'s directory. The plugin will be activated and made available in the WordPress admin panel.
|
|
27851
|
+
* @summary Deploy WordPress plugin
|
|
27852
|
+
* @param {string} username
|
|
27853
|
+
* @param {string} domain Domain name
|
|
27854
|
+
* @param {WordPressV1PluginsDeployPluginRequest} wordPressV1PluginsDeployPluginRequest
|
|
27855
|
+
* @param {*} [options] Override http request option.
|
|
27856
|
+
* @throws {RequiredError}
|
|
27857
|
+
*/
|
|
27858
|
+
deployWordPressPluginV1(username: string, domain: string, wordPressV1PluginsDeployPluginRequest: WordPressV1PluginsDeployPluginRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
27250
27859
|
/**
|
|
27251
27860
|
* Install one or more plugins on an existing WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). Use GET /api/hosting/v1/wordpress/plugins to discover the plugin slugs available for installation. This operation is asynchronous: a successful response only means the install job has been queued, not that the plugins are ready.
|
|
27252
27861
|
* @summary Install WordPress plugins
|
|
@@ -27361,6 +27970,17 @@ export declare class WordPressPluginsApi extends BaseAPI {
|
|
|
27361
27970
|
* @memberof WordPressPluginsApi
|
|
27362
27971
|
*/
|
|
27363
27972
|
deactivateWordPressPluginV1(username: string, software: string, wordPressV1PluginsDeactivatePluginRequest: WordPressV1PluginsDeactivatePluginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
27973
|
+
/**
|
|
27974
|
+
* Deploy a WordPress plugin from an already uploaded directory. This endpoint allows you to deploy a WordPress plugin that has been uploaded to the website\'s directory. The plugin will be activated and made available in the WordPress admin panel.
|
|
27975
|
+
* @summary Deploy WordPress plugin
|
|
27976
|
+
* @param {string} username
|
|
27977
|
+
* @param {string} domain Domain name
|
|
27978
|
+
* @param {WordPressV1PluginsDeployPluginRequest} wordPressV1PluginsDeployPluginRequest
|
|
27979
|
+
* @param {*} [options] Override http request option.
|
|
27980
|
+
* @throws {RequiredError}
|
|
27981
|
+
* @memberof WordPressPluginsApi
|
|
27982
|
+
*/
|
|
27983
|
+
deployWordPressPluginV1(username: string, domain: string, wordPressV1PluginsDeployPluginRequest: WordPressV1PluginsDeployPluginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
27364
27984
|
/**
|
|
27365
27985
|
* Install one or more plugins on an existing WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). Use GET /api/hosting/v1/wordpress/plugins to discover the plugin slugs available for installation. This operation is asynchronous: a successful response only means the install job has been queued, not that the plugins are ready.
|
|
27366
27986
|
* @summary Install WordPress plugins
|
|
@@ -27467,6 +28087,16 @@ export declare const WordPressThemesApiAxiosParamCreator: (configuration?: Confi
|
|
|
27467
28087
|
* @throws {RequiredError}
|
|
27468
28088
|
*/
|
|
27469
28089
|
activateWordPressThemeV1: (username: string, software: string, wordPressV1ThemesActivateThemeRequest: WordPressV1ThemesActivateThemeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
28090
|
+
/**
|
|
28091
|
+
* Deploy a WordPress theme from an already uploaded directory. This endpoint allows you to deploy a WordPress theme that has been uploaded to the website\'s directory. The theme can be optionally activated after deployment.
|
|
28092
|
+
* @summary Deploy WordPress theme
|
|
28093
|
+
* @param {string} username
|
|
28094
|
+
* @param {string} domain Domain name
|
|
28095
|
+
* @param {WordPressV1ThemesDeployThemeRequest} wordPressV1ThemesDeployThemeRequest
|
|
28096
|
+
* @param {*} [options] Override http request option.
|
|
28097
|
+
* @throws {RequiredError}
|
|
28098
|
+
*/
|
|
28099
|
+
deployWordPressThemeV1: (username: string, domain: string, wordPressV1ThemesDeployThemeRequest: WordPressV1ThemesDeployThemeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
27470
28100
|
/**
|
|
27471
28101
|
* Install a theme on an existing WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). When the theme is one of the Hostinger themes (hostinger-blog, hostinger-affiliate-theme, hostinger-ai-theme), the optional `palette`, `layout`, and `font` fields are forwarded to the custom installer (defaults: palette1, layout1, default). For any other theme they are ignored. This operation is asynchronous: a successful response only means the install job has been queued, not that the theme is ready.
|
|
27472
28102
|
* @summary Install WordPress theme
|
|
@@ -27531,6 +28161,16 @@ export declare const WordPressThemesApiFp: (configuration?: Configuration) => {
|
|
|
27531
28161
|
* @throws {RequiredError}
|
|
27532
28162
|
*/
|
|
27533
28163
|
activateWordPressThemeV1(username: string, software: string, wordPressV1ThemesActivateThemeRequest: WordPressV1ThemesActivateThemeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
28164
|
+
/**
|
|
28165
|
+
* Deploy a WordPress theme from an already uploaded directory. This endpoint allows you to deploy a WordPress theme that has been uploaded to the website\'s directory. The theme can be optionally activated after deployment.
|
|
28166
|
+
* @summary Deploy WordPress theme
|
|
28167
|
+
* @param {string} username
|
|
28168
|
+
* @param {string} domain Domain name
|
|
28169
|
+
* @param {WordPressV1ThemesDeployThemeRequest} wordPressV1ThemesDeployThemeRequest
|
|
28170
|
+
* @param {*} [options] Override http request option.
|
|
28171
|
+
* @throws {RequiredError}
|
|
28172
|
+
*/
|
|
28173
|
+
deployWordPressThemeV1(username: string, domain: string, wordPressV1ThemesDeployThemeRequest: WordPressV1ThemesDeployThemeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
27534
28174
|
/**
|
|
27535
28175
|
* Install a theme on an existing WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). When the theme is one of the Hostinger themes (hostinger-blog, hostinger-affiliate-theme, hostinger-ai-theme), the optional `palette`, `layout`, and `font` fields are forwarded to the custom installer (defaults: palette1, layout1, default). For any other theme they are ignored. This operation is asynchronous: a successful response only means the install job has been queued, not that the theme is ready.
|
|
27536
28176
|
* @summary Install WordPress theme
|
|
@@ -27595,6 +28235,16 @@ export declare const WordPressThemesApiFactory: (configuration?: Configuration,
|
|
|
27595
28235
|
* @throws {RequiredError}
|
|
27596
28236
|
*/
|
|
27597
28237
|
activateWordPressThemeV1(username: string, software: string, wordPressV1ThemesActivateThemeRequest: WordPressV1ThemesActivateThemeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
28238
|
+
/**
|
|
28239
|
+
* Deploy a WordPress theme from an already uploaded directory. This endpoint allows you to deploy a WordPress theme that has been uploaded to the website\'s directory. The theme can be optionally activated after deployment.
|
|
28240
|
+
* @summary Deploy WordPress theme
|
|
28241
|
+
* @param {string} username
|
|
28242
|
+
* @param {string} domain Domain name
|
|
28243
|
+
* @param {WordPressV1ThemesDeployThemeRequest} wordPressV1ThemesDeployThemeRequest
|
|
28244
|
+
* @param {*} [options] Override http request option.
|
|
28245
|
+
* @throws {RequiredError}
|
|
28246
|
+
*/
|
|
28247
|
+
deployWordPressThemeV1(username: string, domain: string, wordPressV1ThemesDeployThemeRequest: WordPressV1ThemesDeployThemeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
27598
28248
|
/**
|
|
27599
28249
|
* Install a theme on an existing WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). When the theme is one of the Hostinger themes (hostinger-blog, hostinger-affiliate-theme, hostinger-ai-theme), the optional `palette`, `layout`, and `font` fields are forwarded to the custom installer (defaults: palette1, layout1, default). For any other theme they are ignored. This operation is asynchronous: a successful response only means the install job has been queued, not that the theme is ready.
|
|
27600
28250
|
* @summary Install WordPress theme
|
|
@@ -27662,6 +28312,17 @@ export declare class WordPressThemesApi extends BaseAPI {
|
|
|
27662
28312
|
* @memberof WordPressThemesApi
|
|
27663
28313
|
*/
|
|
27664
28314
|
activateWordPressThemeV1(username: string, software: string, wordPressV1ThemesActivateThemeRequest: WordPressV1ThemesActivateThemeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
28315
|
+
/**
|
|
28316
|
+
* Deploy a WordPress theme from an already uploaded directory. This endpoint allows you to deploy a WordPress theme that has been uploaded to the website\'s directory. The theme can be optionally activated after deployment.
|
|
28317
|
+
* @summary Deploy WordPress theme
|
|
28318
|
+
* @param {string} username
|
|
28319
|
+
* @param {string} domain Domain name
|
|
28320
|
+
* @param {WordPressV1ThemesDeployThemeRequest} wordPressV1ThemesDeployThemeRequest
|
|
28321
|
+
* @param {*} [options] Override http request option.
|
|
28322
|
+
* @throws {RequiredError}
|
|
28323
|
+
* @memberof WordPressThemesApi
|
|
28324
|
+
*/
|
|
28325
|
+
deployWordPressThemeV1(username: string, domain: string, wordPressV1ThemesDeployThemeRequest: WordPressV1ThemesDeployThemeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
27665
28326
|
/**
|
|
27666
28327
|
* Install a theme on an existing WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). When the theme is one of the Hostinger themes (hostinger-blog, hostinger-affiliate-theme, hostinger-ai-theme), the optional `palette`, `layout`, and `font` fields are forwarded to the custom installer (defaults: palette1, layout1, default). For any other theme they are ignored. This operation is asynchronous: a successful response only means the install job has been queued, not that the theme is ready.
|
|
27667
28328
|
* @summary Install WordPress theme
|