@hostinger/sdk 1.58.2 → 1.59.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 +206 -18
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +148 -15
- package/dist/api.js +123 -27
- 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 +148 -15
- package/dist/esm/api.js +112 -16
- 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/HostingV1OnboardingsOnboardingResource.md +2 -0
- package/docs/HostingV1OnboardingsStartOnboardingRequest.md +25 -0
- package/docs/HostingV1OnboardingsStartOnboardingRequestWordpress.md +25 -0
- package/docs/HostingV1OnboardingsStartOnboardingRequestWordpressAdmin.md +25 -0
- package/docs/HostingWebsitesApi.md +68 -1
- package/docs/WordPressInstallationsApi.md +1 -1
- package/docs/WordPressV1InstallationsInstallWordPressRequestDatabase.md +2 -2
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.59.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -530,6 +530,12 @@ export const HostingV1OnboardingsOnboardingResourceStatusEnum = {
|
|
|
530
530
|
Completed: 'completed',
|
|
531
531
|
Failed: 'failed'
|
|
532
532
|
};
|
|
533
|
+
export const HostingV1OnboardingsStartOnboardingRequestTypeEnum = {
|
|
534
|
+
Wordpress: 'wordpress',
|
|
535
|
+
HeadlessWordpress: 'headless_wordpress',
|
|
536
|
+
HeadlessEcommerce: 'headless_ecommerce',
|
|
537
|
+
HeadlessPocketbase: 'headless_pocketbase'
|
|
538
|
+
};
|
|
533
539
|
export const HostingV1SslSslStatusResourceStatusEnum = {
|
|
534
540
|
NotInstalled: 'not_installed',
|
|
535
541
|
Installing: 'installing',
|
|
@@ -18246,13 +18252,15 @@ export const HostingWebsitesApiAxiosParamCreator = function (configuration) {
|
|
|
18246
18252
|
};
|
|
18247
18253
|
}),
|
|
18248
18254
|
/**
|
|
18249
|
-
* Returns the website setups started in the last 24 hours for the hosting accounts accessible to the authenticated client, newest first. Meant for polling right after creating a website: the website shows up in the websites list before its server-side setup has finished, and while the setup is `running` endpoints that operate on that website may respond with `404` or `409`. Poll this endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. `failed` means the setup stopped before finishing or has not reported progress for over an hour. Setups older than 24 hours are not listed.
|
|
18255
|
+
* Returns the website setups started in the last 24 hours for the hosting accounts accessible to the authenticated client, newest first. Narrow the list with the `order_id`, `subscription_id` or `domain` filters. Meant for polling right after creating a website or starting a website setup: the website shows up in the websites list before its server-side setup has finished, and while the setup is `running` endpoints that operate on that website may respond with `404` or `409`. Poll this endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. `failed` means the setup stopped before finishing or has not reported progress for over an hour. Setups older than 24 hours are not listed. `type` is the website type the setup was started with (`wordpress`, `headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`), or `null` for an empty website.
|
|
18250
18256
|
* @summary List website setups
|
|
18257
|
+
* @param {number | null} [orderId] Order ID
|
|
18258
|
+
* @param {string | null} [subscriptionId] Filter by hosting order subscription ID
|
|
18251
18259
|
* @param {string | null} [domain] Filter by domain name (exact match)
|
|
18252
18260
|
* @param {*} [options] Override http request option.
|
|
18253
18261
|
* @throws {RequiredError}
|
|
18254
18262
|
*/
|
|
18255
|
-
listWebsiteSetupsV1: (domain_1, ...args_1) => __awaiter(this, [domain_1, ...args_1], void 0, function* (domain, options = {}) {
|
|
18263
|
+
listWebsiteSetupsV1: (orderId_1, subscriptionId_1, domain_1, ...args_1) => __awaiter(this, [orderId_1, subscriptionId_1, domain_1, ...args_1], void 0, function* (orderId, subscriptionId, domain, options = {}) {
|
|
18256
18264
|
const localVarPath = `/api/hosting/v1/onboardings`;
|
|
18257
18265
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18258
18266
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -18266,6 +18274,12 @@ export const HostingWebsitesApiAxiosParamCreator = function (configuration) {
|
|
|
18266
18274
|
// authentication apiToken required
|
|
18267
18275
|
// http bearer authentication required
|
|
18268
18276
|
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
18277
|
+
if (orderId !== undefined) {
|
|
18278
|
+
localVarQueryParameter['order_id'] = orderId;
|
|
18279
|
+
}
|
|
18280
|
+
if (subscriptionId !== undefined) {
|
|
18281
|
+
localVarQueryParameter['subscription_id'] = subscriptionId;
|
|
18282
|
+
}
|
|
18269
18283
|
if (domain !== undefined) {
|
|
18270
18284
|
localVarQueryParameter['domain'] = domain;
|
|
18271
18285
|
}
|
|
@@ -18333,6 +18347,43 @@ export const HostingWebsitesApiAxiosParamCreator = function (configuration) {
|
|
|
18333
18347
|
options: localVarRequestOptions,
|
|
18334
18348
|
};
|
|
18335
18349
|
}),
|
|
18350
|
+
/**
|
|
18351
|
+
* Starts a website setup on a Web or Cloud hosting order and returns the created setup right away; the website itself is provisioned asynchronously. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. Omit `type` for an empty website. `type: wordpress` installs WordPress in the website root with the admin user, email and password from `wordpress`, the domain as the site title, and `en_US` when `wordpress.language` is omitted. The headless types (`headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`) create a headless website; `headless_wordpress` additionally installs WordPress into the `cms` directory of the website root with generated credentials. Omit `domain` to set the website up on a generated temporary free subdomain. The order must already have a hosting account: to create the first website on a new hosting plan use the create website endpoint, which takes the `datacenter_code`. Returns 404 when the order does not exist or is not accessible to the authenticated client, and 409 with a `Retry-After` header while a setup for the same domain is still running.
|
|
18352
|
+
* @summary Start website setup
|
|
18353
|
+
* @param {number} orderId Hosting order ID. List orders to find available IDs.
|
|
18354
|
+
* @param {HostingV1OnboardingsStartOnboardingRequest} hostingV1OnboardingsStartOnboardingRequest
|
|
18355
|
+
* @param {*} [options] Override http request option.
|
|
18356
|
+
* @throws {RequiredError}
|
|
18357
|
+
*/
|
|
18358
|
+
startWebsiteSetupV1: (orderId_1, hostingV1OnboardingsStartOnboardingRequest_1, ...args_1) => __awaiter(this, [orderId_1, hostingV1OnboardingsStartOnboardingRequest_1, ...args_1], void 0, function* (orderId, hostingV1OnboardingsStartOnboardingRequest, options = {}) {
|
|
18359
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
18360
|
+
assertParamExists('startWebsiteSetupV1', 'orderId', orderId);
|
|
18361
|
+
// verify required parameter 'hostingV1OnboardingsStartOnboardingRequest' is not null or undefined
|
|
18362
|
+
assertParamExists('startWebsiteSetupV1', 'hostingV1OnboardingsStartOnboardingRequest', hostingV1OnboardingsStartOnboardingRequest);
|
|
18363
|
+
const localVarPath = `/api/hosting/v1/orders/{order_id}/onboardings`
|
|
18364
|
+
.replace(`{${"order_id"}}`, encodeURIComponent(String(orderId)));
|
|
18365
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18366
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
18367
|
+
let baseOptions;
|
|
18368
|
+
if (configuration) {
|
|
18369
|
+
baseOptions = configuration.baseOptions;
|
|
18370
|
+
}
|
|
18371
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
18372
|
+
const localVarHeaderParameter = {};
|
|
18373
|
+
const localVarQueryParameter = {};
|
|
18374
|
+
// authentication apiToken required
|
|
18375
|
+
// http bearer authentication required
|
|
18376
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
18377
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
18378
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
18379
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18380
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
18381
|
+
localVarRequestOptions.data = serializeDataIfNeeded(hostingV1OnboardingsStartOnboardingRequest, localVarRequestOptions, configuration);
|
|
18382
|
+
return {
|
|
18383
|
+
url: toPathString(localVarUrlObj),
|
|
18384
|
+
options: localVarRequestOptions,
|
|
18385
|
+
};
|
|
18386
|
+
}),
|
|
18336
18387
|
};
|
|
18337
18388
|
};
|
|
18338
18389
|
/**
|
|
@@ -18390,16 +18441,18 @@ export const HostingWebsitesApiFp = function (configuration) {
|
|
|
18390
18441
|
});
|
|
18391
18442
|
},
|
|
18392
18443
|
/**
|
|
18393
|
-
* Returns the website setups started in the last 24 hours for the hosting accounts accessible to the authenticated client, newest first. Meant for polling right after creating a website: the website shows up in the websites list before its server-side setup has finished, and while the setup is `running` endpoints that operate on that website may respond with `404` or `409`. Poll this endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. `failed` means the setup stopped before finishing or has not reported progress for over an hour. Setups older than 24 hours are not listed.
|
|
18444
|
+
* Returns the website setups started in the last 24 hours for the hosting accounts accessible to the authenticated client, newest first. Narrow the list with the `order_id`, `subscription_id` or `domain` filters. Meant for polling right after creating a website or starting a website setup: the website shows up in the websites list before its server-side setup has finished, and while the setup is `running` endpoints that operate on that website may respond with `404` or `409`. Poll this endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. `failed` means the setup stopped before finishing or has not reported progress for over an hour. Setups older than 24 hours are not listed. `type` is the website type the setup was started with (`wordpress`, `headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`), or `null` for an empty website.
|
|
18394
18445
|
* @summary List website setups
|
|
18446
|
+
* @param {number | null} [orderId] Order ID
|
|
18447
|
+
* @param {string | null} [subscriptionId] Filter by hosting order subscription ID
|
|
18395
18448
|
* @param {string | null} [domain] Filter by domain name (exact match)
|
|
18396
18449
|
* @param {*} [options] Override http request option.
|
|
18397
18450
|
* @throws {RequiredError}
|
|
18398
18451
|
*/
|
|
18399
|
-
listWebsiteSetupsV1(domain, options) {
|
|
18452
|
+
listWebsiteSetupsV1(orderId, subscriptionId, domain, options) {
|
|
18400
18453
|
return __awaiter(this, void 0, void 0, function* () {
|
|
18401
18454
|
var _a, _b;
|
|
18402
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listWebsiteSetupsV1(domain, options);
|
|
18455
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listWebsiteSetupsV1(orderId, subscriptionId, domain, options);
|
|
18403
18456
|
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['HostingWebsitesApi.listWebsiteSetupsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
18404
18457
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18405
18458
|
});
|
|
@@ -18425,6 +18478,22 @@ export const HostingWebsitesApiFp = function (configuration) {
|
|
|
18425
18478
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18426
18479
|
});
|
|
18427
18480
|
},
|
|
18481
|
+
/**
|
|
18482
|
+
* Starts a website setup on a Web or Cloud hosting order and returns the created setup right away; the website itself is provisioned asynchronously. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. Omit `type` for an empty website. `type: wordpress` installs WordPress in the website root with the admin user, email and password from `wordpress`, the domain as the site title, and `en_US` when `wordpress.language` is omitted. The headless types (`headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`) create a headless website; `headless_wordpress` additionally installs WordPress into the `cms` directory of the website root with generated credentials. Omit `domain` to set the website up on a generated temporary free subdomain. The order must already have a hosting account: to create the first website on a new hosting plan use the create website endpoint, which takes the `datacenter_code`. Returns 404 when the order does not exist or is not accessible to the authenticated client, and 409 with a `Retry-After` header while a setup for the same domain is still running.
|
|
18483
|
+
* @summary Start website setup
|
|
18484
|
+
* @param {number} orderId Hosting order ID. List orders to find available IDs.
|
|
18485
|
+
* @param {HostingV1OnboardingsStartOnboardingRequest} hostingV1OnboardingsStartOnboardingRequest
|
|
18486
|
+
* @param {*} [options] Override http request option.
|
|
18487
|
+
* @throws {RequiredError}
|
|
18488
|
+
*/
|
|
18489
|
+
startWebsiteSetupV1(orderId, hostingV1OnboardingsStartOnboardingRequest, options) {
|
|
18490
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18491
|
+
var _a, _b;
|
|
18492
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.startWebsiteSetupV1(orderId, hostingV1OnboardingsStartOnboardingRequest, options);
|
|
18493
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['HostingWebsitesApi.startWebsiteSetupV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
18494
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18495
|
+
});
|
|
18496
|
+
},
|
|
18428
18497
|
};
|
|
18429
18498
|
};
|
|
18430
18499
|
/**
|
|
@@ -18467,14 +18536,16 @@ export const HostingWebsitesApiFactory = function (configuration, basePath, axio
|
|
|
18467
18536
|
return localVarFp.deployStaticSiteArchiveV1(username, domain, hostingV1WebsitesDeployArchiveRequest, options).then((request) => request(axios, basePath));
|
|
18468
18537
|
},
|
|
18469
18538
|
/**
|
|
18470
|
-
* Returns the website setups started in the last 24 hours for the hosting accounts accessible to the authenticated client, newest first. Meant for polling right after creating a website: the website shows up in the websites list before its server-side setup has finished, and while the setup is `running` endpoints that operate on that website may respond with `404` or `409`. Poll this endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. `failed` means the setup stopped before finishing or has not reported progress for over an hour. Setups older than 24 hours are not listed.
|
|
18539
|
+
* Returns the website setups started in the last 24 hours for the hosting accounts accessible to the authenticated client, newest first. Narrow the list with the `order_id`, `subscription_id` or `domain` filters. Meant for polling right after creating a website or starting a website setup: the website shows up in the websites list before its server-side setup has finished, and while the setup is `running` endpoints that operate on that website may respond with `404` or `409`. Poll this endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. `failed` means the setup stopped before finishing or has not reported progress for over an hour. Setups older than 24 hours are not listed. `type` is the website type the setup was started with (`wordpress`, `headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`), or `null` for an empty website.
|
|
18471
18540
|
* @summary List website setups
|
|
18541
|
+
* @param {number | null} [orderId] Order ID
|
|
18542
|
+
* @param {string | null} [subscriptionId] Filter by hosting order subscription ID
|
|
18472
18543
|
* @param {string | null} [domain] Filter by domain name (exact match)
|
|
18473
18544
|
* @param {*} [options] Override http request option.
|
|
18474
18545
|
* @throws {RequiredError}
|
|
18475
18546
|
*/
|
|
18476
|
-
listWebsiteSetupsV1(domain, options) {
|
|
18477
|
-
return localVarFp.listWebsiteSetupsV1(domain, options).then((request) => request(axios, basePath));
|
|
18547
|
+
listWebsiteSetupsV1(orderId, subscriptionId, domain, options) {
|
|
18548
|
+
return localVarFp.listWebsiteSetupsV1(orderId, subscriptionId, domain, options).then((request) => request(axios, basePath));
|
|
18478
18549
|
},
|
|
18479
18550
|
/**
|
|
18480
18551
|
* 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 `website_types` to list only websites of a given detected type, e.g. only WordPress websites (`website_types=wordpress`) or only Node.js websites (`website_types=nodejs`). Combine with the other available query parameters to filter by username, order ID, enabled status, or domain name for more targeted results. A website appears in this list before its server-side setup has finished, and `is_enabled` reflects suspension, not readiness. To know when a newly created website is ready for file, deploy or database operations, poll the list website setups endpoint instead.
|
|
@@ -18492,6 +18563,17 @@ export const HostingWebsitesApiFactory = function (configuration, basePath, axio
|
|
|
18492
18563
|
listWebsitesV1(page, perPage, username, orderId, isEnabled, domain, websiteTypes, options) {
|
|
18493
18564
|
return localVarFp.listWebsitesV1(page, perPage, username, orderId, isEnabled, domain, websiteTypes, options).then((request) => request(axios, basePath));
|
|
18494
18565
|
},
|
|
18566
|
+
/**
|
|
18567
|
+
* Starts a website setup on a Web or Cloud hosting order and returns the created setup right away; the website itself is provisioned asynchronously. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. Omit `type` for an empty website. `type: wordpress` installs WordPress in the website root with the admin user, email and password from `wordpress`, the domain as the site title, and `en_US` when `wordpress.language` is omitted. The headless types (`headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`) create a headless website; `headless_wordpress` additionally installs WordPress into the `cms` directory of the website root with generated credentials. Omit `domain` to set the website up on a generated temporary free subdomain. The order must already have a hosting account: to create the first website on a new hosting plan use the create website endpoint, which takes the `datacenter_code`. Returns 404 when the order does not exist or is not accessible to the authenticated client, and 409 with a `Retry-After` header while a setup for the same domain is still running.
|
|
18568
|
+
* @summary Start website setup
|
|
18569
|
+
* @param {number} orderId Hosting order ID. List orders to find available IDs.
|
|
18570
|
+
* @param {HostingV1OnboardingsStartOnboardingRequest} hostingV1OnboardingsStartOnboardingRequest
|
|
18571
|
+
* @param {*} [options] Override http request option.
|
|
18572
|
+
* @throws {RequiredError}
|
|
18573
|
+
*/
|
|
18574
|
+
startWebsiteSetupV1(orderId, hostingV1OnboardingsStartOnboardingRequest, options) {
|
|
18575
|
+
return localVarFp.startWebsiteSetupV1(orderId, hostingV1OnboardingsStartOnboardingRequest, options).then((request) => request(axios, basePath));
|
|
18576
|
+
},
|
|
18495
18577
|
};
|
|
18496
18578
|
};
|
|
18497
18579
|
/**
|
|
@@ -18537,15 +18619,17 @@ export class HostingWebsitesApi extends BaseAPI {
|
|
|
18537
18619
|
return HostingWebsitesApiFp(this.configuration).deployStaticSiteArchiveV1(username, domain, hostingV1WebsitesDeployArchiveRequest, options).then((request) => request(this.axios, this.basePath));
|
|
18538
18620
|
}
|
|
18539
18621
|
/**
|
|
18540
|
-
* Returns the website setups started in the last 24 hours for the hosting accounts accessible to the authenticated client, newest first. Meant for polling right after creating a website: the website shows up in the websites list before its server-side setup has finished, and while the setup is `running` endpoints that operate on that website may respond with `404` or `409`. Poll this endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. `failed` means the setup stopped before finishing or has not reported progress for over an hour. Setups older than 24 hours are not listed.
|
|
18622
|
+
* Returns the website setups started in the last 24 hours for the hosting accounts accessible to the authenticated client, newest first. Narrow the list with the `order_id`, `subscription_id` or `domain` filters. Meant for polling right after creating a website or starting a website setup: the website shows up in the websites list before its server-side setup has finished, and while the setup is `running` endpoints that operate on that website may respond with `404` or `409`. Poll this endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. `failed` means the setup stopped before finishing or has not reported progress for over an hour. Setups older than 24 hours are not listed. `type` is the website type the setup was started with (`wordpress`, `headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`), or `null` for an empty website.
|
|
18541
18623
|
* @summary List website setups
|
|
18624
|
+
* @param {number | null} [orderId] Order ID
|
|
18625
|
+
* @param {string | null} [subscriptionId] Filter by hosting order subscription ID
|
|
18542
18626
|
* @param {string | null} [domain] Filter by domain name (exact match)
|
|
18543
18627
|
* @param {*} [options] Override http request option.
|
|
18544
18628
|
* @throws {RequiredError}
|
|
18545
18629
|
* @memberof HostingWebsitesApi
|
|
18546
18630
|
*/
|
|
18547
|
-
listWebsiteSetupsV1(domain, options) {
|
|
18548
|
-
return HostingWebsitesApiFp(this.configuration).listWebsiteSetupsV1(domain, options).then((request) => request(this.axios, this.basePath));
|
|
18631
|
+
listWebsiteSetupsV1(orderId, subscriptionId, domain, options) {
|
|
18632
|
+
return HostingWebsitesApiFp(this.configuration).listWebsiteSetupsV1(orderId, subscriptionId, domain, options).then((request) => request(this.axios, this.basePath));
|
|
18549
18633
|
}
|
|
18550
18634
|
/**
|
|
18551
18635
|
* 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 `website_types` to list only websites of a given detected type, e.g. only WordPress websites (`website_types=wordpress`) or only Node.js websites (`website_types=nodejs`). Combine with the other available query parameters to filter by username, order ID, enabled status, or domain name for more targeted results. A website appears in this list before its server-side setup has finished, and `is_enabled` reflects suspension, not readiness. To know when a newly created website is ready for file, deploy or database operations, poll the list website setups endpoint instead.
|
|
@@ -18564,6 +18648,18 @@ export class HostingWebsitesApi extends BaseAPI {
|
|
|
18564
18648
|
listWebsitesV1(page, perPage, username, orderId, isEnabled, domain, websiteTypes, options) {
|
|
18565
18649
|
return HostingWebsitesApiFp(this.configuration).listWebsitesV1(page, perPage, username, orderId, isEnabled, domain, websiteTypes, options).then((request) => request(this.axios, this.basePath));
|
|
18566
18650
|
}
|
|
18651
|
+
/**
|
|
18652
|
+
* Starts a website setup on a Web or Cloud hosting order and returns the created setup right away; the website itself is provisioned asynchronously. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. Omit `type` for an empty website. `type: wordpress` installs WordPress in the website root with the admin user, email and password from `wordpress`, the domain as the site title, and `en_US` when `wordpress.language` is omitted. The headless types (`headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`) create a headless website; `headless_wordpress` additionally installs WordPress into the `cms` directory of the website root with generated credentials. Omit `domain` to set the website up on a generated temporary free subdomain. The order must already have a hosting account: to create the first website on a new hosting plan use the create website endpoint, which takes the `datacenter_code`. Returns 404 when the order does not exist or is not accessible to the authenticated client, and 409 with a `Retry-After` header while a setup for the same domain is still running.
|
|
18653
|
+
* @summary Start website setup
|
|
18654
|
+
* @param {number} orderId Hosting order ID. List orders to find available IDs.
|
|
18655
|
+
* @param {HostingV1OnboardingsStartOnboardingRequest} hostingV1OnboardingsStartOnboardingRequest
|
|
18656
|
+
* @param {*} [options] Override http request option.
|
|
18657
|
+
* @throws {RequiredError}
|
|
18658
|
+
* @memberof HostingWebsitesApi
|
|
18659
|
+
*/
|
|
18660
|
+
startWebsiteSetupV1(orderId, hostingV1OnboardingsStartOnboardingRequest, options) {
|
|
18661
|
+
return HostingWebsitesApiFp(this.configuration).startWebsiteSetupV1(orderId, hostingV1OnboardingsStartOnboardingRequest, options).then((request) => request(this.axios, this.basePath));
|
|
18662
|
+
}
|
|
18567
18663
|
}
|
|
18568
18664
|
/**
|
|
18569
18665
|
* @export
|
|
@@ -31956,7 +32052,7 @@ export const WordPressInstallationsApiAxiosParamCreator = function (configuratio
|
|
|
31956
32052
|
};
|
|
31957
32053
|
}),
|
|
31958
32054
|
/**
|
|
31959
|
-
* 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.
|
|
32055
|
+
* 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. Returns 422 when the account already uses all the databases its plan allows, unless `database.name` is an existing database on the account.
|
|
31960
32056
|
* @summary Install WordPress
|
|
31961
32057
|
* @param {string} username
|
|
31962
32058
|
* @param {WordPressV1InstallationsInstallWordPressRequest} wordPressV1InstallationsInstallWordPressRequest
|
|
@@ -32236,7 +32332,7 @@ export const WordPressInstallationsApiFp = function (configuration) {
|
|
|
32236
32332
|
});
|
|
32237
32333
|
},
|
|
32238
32334
|
/**
|
|
32239
|
-
* 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.
|
|
32335
|
+
* 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. Returns 422 when the account already uses all the databases its plan allows, unless `database.name` is an existing database on the account.
|
|
32240
32336
|
* @summary Install WordPress
|
|
32241
32337
|
* @param {string} username
|
|
32242
32338
|
* @param {WordPressV1InstallationsInstallWordPressRequest} wordPressV1InstallationsInstallWordPressRequest
|
|
@@ -32383,7 +32479,7 @@ export const WordPressInstallationsApiFactory = function (configuration, basePat
|
|
|
32383
32479
|
return localVarFp.importWordPressWebsiteV1(username, domain, wordPressV1InstallationsImportWordPressRequest, options).then((request) => request(axios, basePath));
|
|
32384
32480
|
},
|
|
32385
32481
|
/**
|
|
32386
|
-
* 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.
|
|
32482
|
+
* 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. Returns 422 when the account already uses all the databases its plan allows, unless `database.name` is an existing database on the account.
|
|
32387
32483
|
* @summary Install WordPress
|
|
32388
32484
|
* @param {string} username
|
|
32389
32485
|
* @param {WordPressV1InstallationsInstallWordPressRequest} wordPressV1InstallationsInstallWordPressRequest
|
|
@@ -32510,7 +32606,7 @@ export class WordPressInstallationsApi extends BaseAPI {
|
|
|
32510
32606
|
return WordPressInstallationsApiFp(this.configuration).importWordPressWebsiteV1(username, domain, wordPressV1InstallationsImportWordPressRequest, options).then((request) => request(this.axios, this.basePath));
|
|
32511
32607
|
}
|
|
32512
32608
|
/**
|
|
32513
|
-
* 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.
|
|
32609
|
+
* 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. Returns 422 when the account already uses all the databases its plan allows, unless `database.name` is an existing database on the account.
|
|
32514
32610
|
* @summary Install WordPress
|
|
32515
32611
|
* @param {string} username
|
|
32516
32612
|
* @param {WordPressV1InstallationsInstallWordPressRequest} wordPressV1InstallationsInstallWordPressRequest
|
package/dist/esm/base.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.59.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
|
package/dist/esm/base.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.59.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.59.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
|
package/dist/esm/common.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.59.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.59.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
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.59.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -13,7 +13,7 @@ export class Configuration {
|
|
|
13
13
|
var _a;
|
|
14
14
|
this.accessToken = param.accessToken;
|
|
15
15
|
this.basePath = param.basePath;
|
|
16
|
-
this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({ 'User-Agent': "hostinger-typescript-sdk/1.
|
|
16
|
+
this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({ 'User-Agent': "hostinger-typescript-sdk/1.59.0" }, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
|
|
17
17
|
this.formDataCtor = param.formDataCtor;
|
|
18
18
|
}
|
|
19
19
|
/**
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.59.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
|
package/dist/esm/index.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.59.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.59.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
|
package/dist/index.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* Hostinger API
|
|
6
6
|
*
|
|
7
|
-
* API Version: 1.
|
|
7
|
+
* API Version: 1.59.0
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
10
10
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**domain** | **string** | Domain of the website being set up. | [default to undefined]
|
|
9
9
|
**username** | **string** | Hosting account username. | [default to undefined]
|
|
10
|
+
**type** | **string** | Website type requested for the setup: `wordpress`, `headless_wordpress`, `headless_ecommerce` or `headless_pocketbase`. `null` for an empty website. Setups started outside this API may report other legacy types. | [optional] [default to undefined]
|
|
10
11
|
**status** | **string** | `running` while the website is still being set up, `completed` once the setup has finished, `failed` when it stopped before finishing or has not reported progress for over an hour. | [default to undefined]
|
|
11
12
|
**created_at** | **string** | When the setup was requested. | [default to undefined]
|
|
12
13
|
**updated_at** | **string** | When the setup last reported progress. | [default to undefined]
|
|
@@ -19,6 +20,7 @@ import { HostingV1OnboardingsOnboardingResource } from '@hostinger/sdk';
|
|
|
19
20
|
const instance: HostingV1OnboardingsOnboardingResource = {
|
|
20
21
|
domain,
|
|
21
22
|
username,
|
|
23
|
+
type,
|
|
22
24
|
status,
|
|
23
25
|
created_at,
|
|
24
26
|
updated_at,
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# HostingV1OnboardingsStartOnboardingRequest
|
|
2
|
+
|
|
3
|
+
Website type, domain and WordPress settings for a new website setup
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**type** | **string** | Website type. Omit or `null` for an empty website. `wordpress` installs WordPress in the website root and requires `wordpress`. The headless types (`headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`) create a headless website; `headless_wordpress` additionally installs WordPress into the `cms` directory with generated credentials. | [optional] [default to undefined]
|
|
10
|
+
**domain** | **string** | Customer-owned domain. Cannot start with \"www.\". Omit or `null` to set the website up on a generated temporary free subdomain. | [optional] [default to undefined]
|
|
11
|
+
**wordpress** | [**HostingV1OnboardingsStartOnboardingRequestWordpress**](HostingV1OnboardingsStartOnboardingRequestWordpress.md) | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { HostingV1OnboardingsStartOnboardingRequest } from '@hostinger/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: HostingV1OnboardingsStartOnboardingRequest = {
|
|
19
|
+
type,
|
|
20
|
+
domain,
|
|
21
|
+
wordpress,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# HostingV1OnboardingsStartOnboardingRequestWordpress
|
|
2
|
+
|
|
3
|
+
WordPress install settings. Required when `type` is `wordpress`, not allowed otherwise. The site title is the domain.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**language** | **string** | WordPress locale, for example `en_US` or `lt_LT`. Defaults to `en_US` when omitted. | [optional] [default to undefined]
|
|
10
|
+
**is_ai_builder** | **boolean** | When `true`, installs the Hostinger AI theme (`hostinger-ai-theme`). Defaults to `false` when omitted. | [optional] [default to undefined]
|
|
11
|
+
**admin** | [**HostingV1OnboardingsStartOnboardingRequestWordpressAdmin**](HostingV1OnboardingsStartOnboardingRequestWordpressAdmin.md) | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { HostingV1OnboardingsStartOnboardingRequestWordpress } from '@hostinger/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: HostingV1OnboardingsStartOnboardingRequestWordpress = {
|
|
19
|
+
language,
|
|
20
|
+
is_ai_builder,
|
|
21
|
+
admin,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# HostingV1OnboardingsStartOnboardingRequestWordpressAdmin
|
|
2
|
+
|
|
3
|
+
WordPress administrator account
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**user** | **string** | WordPress admin username (letters, numbers, and underscore) | [default to undefined]
|
|
10
|
+
**password** | **string** | WordPress admin password (8-50 characters, mixed case, a digit, and not compromised) | [default to undefined]
|
|
11
|
+
**email** | **string** | WordPress admin email address | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { HostingV1OnboardingsStartOnboardingRequestWordpressAdmin } from '@hostinger/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: HostingV1OnboardingsStartOnboardingRequestWordpressAdmin = {
|
|
19
|
+
user,
|
|
20
|
+
password,
|
|
21
|
+
email,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -9,6 +9,7 @@ All URIs are relative to *https://developers.hostinger.com*
|
|
|
9
9
|
|[**deployStaticSiteArchiveV1**](#deploystaticsitearchivev1) | **POST** /api/hosting/v1/accounts/{username}/websites/{domain}/deploy | Deploy static site archive|
|
|
10
10
|
|[**listWebsiteSetupsV1**](#listwebsitesetupsv1) | **GET** /api/hosting/v1/onboardings | List website setups|
|
|
11
11
|
|[**listWebsitesV1**](#listwebsitesv1) | **GET** /api/hosting/v1/websites | List websites|
|
|
12
|
+
|[**startWebsiteSetupV1**](#startwebsitesetupv1) | **POST** /api/hosting/v1/orders/{order_id}/onboardings | Start website setup|
|
|
12
13
|
|
|
13
14
|
# **createWebsiteV1**
|
|
14
15
|
> CommonSuccessEmptyResource createWebsiteV1(hostingV1WebsitesCreateWebsiteRequest)
|
|
@@ -183,7 +184,7 @@ const { status, data } = await apiInstance.deployStaticSiteArchiveV1(
|
|
|
183
184
|
# **listWebsiteSetupsV1**
|
|
184
185
|
> Array<HostingV1OnboardingsOnboardingResource> listWebsiteSetupsV1()
|
|
185
186
|
|
|
186
|
-
Returns the website setups started in the last 24 hours for the hosting accounts accessible to the authenticated client, newest first. Meant for polling right after creating a website: the website shows up in the websites list before its server-side setup has finished, and while the setup is `running` endpoints that operate on that website may respond with `404` or `409`. Poll this endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. `failed` means the setup stopped before finishing or has not reported progress for over an hour. Setups older than 24 hours are not listed.
|
|
187
|
+
Returns the website setups started in the last 24 hours for the hosting accounts accessible to the authenticated client, newest first. Narrow the list with the `order_id`, `subscription_id` or `domain` filters. Meant for polling right after creating a website or starting a website setup: the website shows up in the websites list before its server-side setup has finished, and while the setup is `running` endpoints that operate on that website may respond with `404` or `409`. Poll this endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. `failed` means the setup stopped before finishing or has not reported progress for over an hour. Setups older than 24 hours are not listed. `type` is the website type the setup was started with (`wordpress`, `headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`), or `null` for an empty website.
|
|
187
188
|
|
|
188
189
|
### Example
|
|
189
190
|
|
|
@@ -196,9 +197,13 @@ import {
|
|
|
196
197
|
const configuration = new Configuration();
|
|
197
198
|
const apiInstance = new HostingWebsitesApi(configuration);
|
|
198
199
|
|
|
200
|
+
let orderId: number; //Order ID (optional) (default to undefined)
|
|
201
|
+
let subscriptionId: string; //Filter by hosting order subscription ID (optional) (default to undefined)
|
|
199
202
|
let domain: string; //Filter by domain name (exact match) (optional) (default to undefined)
|
|
200
203
|
|
|
201
204
|
const { status, data } = await apiInstance.listWebsiteSetupsV1(
|
|
205
|
+
orderId,
|
|
206
|
+
subscriptionId,
|
|
202
207
|
domain
|
|
203
208
|
);
|
|
204
209
|
```
|
|
@@ -207,6 +212,8 @@ const { status, data } = await apiInstance.listWebsiteSetupsV1(
|
|
|
207
212
|
|
|
208
213
|
|Name | Type | Description | Notes|
|
|
209
214
|
|------------- | ------------- | ------------- | -------------|
|
|
215
|
+
| **orderId** | [**number**] | Order ID | (optional) defaults to undefined|
|
|
216
|
+
| **subscriptionId** | [**string**] | Filter by hosting order subscription ID | (optional) defaults to undefined|
|
|
210
217
|
| **domain** | [**string**] | Filter by domain name (exact match) | (optional) defaults to undefined|
|
|
211
218
|
|
|
212
219
|
|
|
@@ -305,3 +312,63 @@ const { status, data } = await apiInstance.listWebsitesV1(
|
|
|
305
312
|
|
|
306
313
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
307
314
|
|
|
315
|
+
# **startWebsiteSetupV1**
|
|
316
|
+
> HostingV1OnboardingsOnboardingResource startWebsiteSetupV1(hostingV1OnboardingsStartOnboardingRequest)
|
|
317
|
+
|
|
318
|
+
Starts a website setup on a Web or Cloud hosting order and returns the created setup right away; the website itself is provisioned asynchronously. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. Omit `type` for an empty website. `type: wordpress` installs WordPress in the website root with the admin user, email and password from `wordpress`, the domain as the site title, and `en_US` when `wordpress.language` is omitted. The headless types (`headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`) create a headless website; `headless_wordpress` additionally installs WordPress into the `cms` directory of the website root with generated credentials. Omit `domain` to set the website up on a generated temporary free subdomain. The order must already have a hosting account: to create the first website on a new hosting plan use the create website endpoint, which takes the `datacenter_code`. Returns 404 when the order does not exist or is not accessible to the authenticated client, and 409 with a `Retry-After` header while a setup for the same domain is still running.
|
|
319
|
+
|
|
320
|
+
### Example
|
|
321
|
+
|
|
322
|
+
```typescript
|
|
323
|
+
import {
|
|
324
|
+
HostingWebsitesApi,
|
|
325
|
+
Configuration,
|
|
326
|
+
HostingV1OnboardingsStartOnboardingRequest
|
|
327
|
+
} from '@hostinger/sdk';
|
|
328
|
+
|
|
329
|
+
const configuration = new Configuration();
|
|
330
|
+
const apiInstance = new HostingWebsitesApi(configuration);
|
|
331
|
+
|
|
332
|
+
let orderId: number; //Hosting order ID. List orders to find available IDs. (default to undefined)
|
|
333
|
+
let hostingV1OnboardingsStartOnboardingRequest: HostingV1OnboardingsStartOnboardingRequest; //
|
|
334
|
+
|
|
335
|
+
const { status, data } = await apiInstance.startWebsiteSetupV1(
|
|
336
|
+
orderId,
|
|
337
|
+
hostingV1OnboardingsStartOnboardingRequest
|
|
338
|
+
);
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
### Parameters
|
|
342
|
+
|
|
343
|
+
|Name | Type | Description | Notes|
|
|
344
|
+
|------------- | ------------- | ------------- | -------------|
|
|
345
|
+
| **hostingV1OnboardingsStartOnboardingRequest** | **HostingV1OnboardingsStartOnboardingRequest**| | |
|
|
346
|
+
| **orderId** | [**number**] | Hosting order ID. List orders to find available IDs. | defaults to undefined|
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
### Return type
|
|
350
|
+
|
|
351
|
+
**HostingV1OnboardingsOnboardingResource**
|
|
352
|
+
|
|
353
|
+
### Authorization
|
|
354
|
+
|
|
355
|
+
[apiToken](../README.md#apiToken)
|
|
356
|
+
|
|
357
|
+
### HTTP request headers
|
|
358
|
+
|
|
359
|
+
- **Content-Type**: application/json
|
|
360
|
+
- **Accept**: application/json
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
### HTTP response details
|
|
364
|
+
| Status code | Description | Response headers |
|
|
365
|
+
|-------------|-------------|------------------|
|
|
366
|
+
|**201** | Created response | - |
|
|
367
|
+
|**422** | Validation error response | - |
|
|
368
|
+
|**401** | Unauthenticated response | - |
|
|
369
|
+
|**404** | Error response | - |
|
|
370
|
+
|**409** | Conflict response. `Retry-After`, when present, is the number of seconds to wait before retrying. | * Retry-After - Seconds to wait before retrying the request <br> |
|
|
371
|
+
|**500** | Error response | - |
|
|
372
|
+
|
|
373
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
374
|
+
|
|
@@ -307,7 +307,7 @@ const { status, data } = await apiInstance.importWordPressWebsiteV1(
|
|
|
307
307
|
# **installWordPressV1**
|
|
308
308
|
> CommonSuccessEmptyResource installWordPressV1(wordPressV1InstallationsInstallWordPressRequest)
|
|
309
309
|
|
|
310
|
-
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.
|
|
310
|
+
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. Returns 422 when the account already uses all the databases its plan allows, unless `database.name` is an existing database on the account.
|
|
311
311
|
|
|
312
312
|
### Example
|
|
313
313
|
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# WordPressV1InstallationsInstallWordPressRequestDatabase
|
|
2
2
|
|
|
3
|
-
Optional. If the named database already exists, it
|
|
3
|
+
Optional. If the named database already exists on the account, it is used for this WordPress install. Otherwise a new database is created with this name, or with a generated name when database is omitted or null. A new database gets a random database user and counts toward the plan\'s database limit.
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**name** | **string** | Database name (username prefix added if missing) | [optional] [default to undefined]
|
|
10
|
-
**password** | **string** |
|
|
10
|
+
**password** | **string** | Password for a new database. Random when omitted or null. Ignored when the named database already exists. | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|