@hostinger/sdk 1.54.3 → 1.56.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/dist/api.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * Hostinger API
3
3
  *
4
- * API Version: 1.54.2
4
+ * API Version: 1.56.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
@@ -3746,6 +3746,37 @@ export interface DomainsV1TransferClaimRequest {
3746
3746
  */
3747
3747
  'should_keep_ns': boolean;
3748
3748
  }
3749
+ /**
3750
+ *
3751
+ * @export
3752
+ * @interface DomainsV1TransferTransferRequest
3753
+ */
3754
+ export interface DomainsV1TransferTransferRequest {
3755
+ /**
3756
+ * Domain name
3757
+ * @type {string}
3758
+ * @memberof DomainsV1TransferTransferRequest
3759
+ */
3760
+ 'domain': string;
3761
+ /**
3762
+ * Authorization code from the current registrar
3763
+ * @type {string}
3764
+ * @memberof DomainsV1TransferTransferRequest
3765
+ */
3766
+ 'auth_code': string;
3767
+ /**
3768
+ *
3769
+ * @type {DomainsV1PortfolioClaimRequestDomainContacts}
3770
+ * @memberof DomainsV1TransferTransferRequest
3771
+ */
3772
+ 'domain_contacts': DomainsV1PortfolioClaimRequestDomainContacts;
3773
+ /**
3774
+ * Keep the existing nameservers of the domain
3775
+ * @type {boolean}
3776
+ * @memberof DomainsV1TransferTransferRequest
3777
+ */
3778
+ 'should_keep_ns': boolean;
3779
+ }
3749
3780
  /**
3750
3781
  *
3751
3782
  * @export
@@ -8534,6 +8565,49 @@ export declare const HostingV1NodeJsVulnerabilityResourceSeverityEnum: {
8534
8565
  readonly Unknown: "unknown";
8535
8566
  };
8536
8567
  export type HostingV1NodeJsVulnerabilityResourceSeverityEnum = typeof HostingV1NodeJsVulnerabilityResourceSeverityEnum[keyof typeof HostingV1NodeJsVulnerabilityResourceSeverityEnum];
8568
+ /**
8569
+ *
8570
+ * @export
8571
+ * @interface HostingV1OnboardingsOnboardingResource
8572
+ */
8573
+ export interface HostingV1OnboardingsOnboardingResource {
8574
+ /**
8575
+ * Domain of the website being set up.
8576
+ * @type {string}
8577
+ * @memberof HostingV1OnboardingsOnboardingResource
8578
+ */
8579
+ 'domain': string;
8580
+ /**
8581
+ * Hosting account username.
8582
+ * @type {string}
8583
+ * @memberof HostingV1OnboardingsOnboardingResource
8584
+ */
8585
+ 'username': string;
8586
+ /**
8587
+ * `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.
8588
+ * @type {string}
8589
+ * @memberof HostingV1OnboardingsOnboardingResource
8590
+ */
8591
+ 'status': HostingV1OnboardingsOnboardingResourceStatusEnum;
8592
+ /**
8593
+ * When the setup was requested.
8594
+ * @type {string}
8595
+ * @memberof HostingV1OnboardingsOnboardingResource
8596
+ */
8597
+ 'created_at': string;
8598
+ /**
8599
+ * When the setup last reported progress.
8600
+ * @type {string}
8601
+ * @memberof HostingV1OnboardingsOnboardingResource
8602
+ */
8603
+ 'updated_at': string;
8604
+ }
8605
+ export declare const HostingV1OnboardingsOnboardingResourceStatusEnum: {
8606
+ readonly Running: "running";
8607
+ readonly Completed: "completed";
8608
+ readonly Failed: "failed";
8609
+ };
8610
+ export type HostingV1OnboardingsOnboardingResourceStatusEnum = typeof HostingV1OnboardingsOnboardingResourceStatusEnum[keyof typeof HostingV1OnboardingsOnboardingResourceStatusEnum];
8537
8611
  /**
8538
8612
  *
8539
8613
  * @export
@@ -8943,7 +9017,7 @@ export interface HostingV1WebsitesWebsiteResource {
8943
9017
  */
8944
9018
  'vhost_type': HostingV1WebsitesWebsiteResourceVhostTypeEnum | null;
8945
9019
  /**
8946
- * Whether website is enabled
9020
+ * True unless the website is suspended. Not a readiness signal: a website that is still being set up is enabled too, see the list website setups endpoint.
8947
9021
  * @type {boolean}
8948
9022
  * @memberof HostingV1WebsitesWebsiteResource
8949
9023
  */
@@ -20356,6 +20430,14 @@ export declare const DomainsTransferApiAxiosParamCreator: (configuration?: Confi
20356
20430
  * @throws {RequiredError}
20357
20431
  */
20358
20432
  getTransferV1: (domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
20433
+ /**
20434
+ * Transfer a domain from another registrar to your account. The transfer runs on a domain transfer service you have already purchased. Before making request, unlock the domain at the current registrar and get its authorization code. A successful response means the transfer has been started. Completion depends on the current registrar and can be followed with the [transfer list endpoint](#tag/domains-transfer). If no WHOIS information is provided, default contact information for that TLD will be used. Before making request, ensure WHOIS information for desired TLD exists in your account. Use this endpoint to bring domains registered elsewhere into your account.
20435
+ * @summary Start domain transfer
20436
+ * @param {DomainsV1TransferTransferRequest} domainsV1TransferTransferRequest
20437
+ * @param {*} [options] Override http request option.
20438
+ * @throws {RequiredError}
20439
+ */
20440
+ startDomainTransferV1: (domainsV1TransferTransferRequest: DomainsV1TransferTransferRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
20359
20441
  };
20360
20442
  /**
20361
20443
  * DomainsTransferApi - functional programming interface
@@ -20385,6 +20467,14 @@ export declare const DomainsTransferApiFp: (configuration?: Configuration) => {
20385
20467
  * @throws {RequiredError}
20386
20468
  */
20387
20469
  getTransferV1(domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DomainsV1TransferTransferResource>>;
20470
+ /**
20471
+ * Transfer a domain from another registrar to your account. The transfer runs on a domain transfer service you have already purchased. Before making request, unlock the domain at the current registrar and get its authorization code. A successful response means the transfer has been started. Completion depends on the current registrar and can be followed with the [transfer list endpoint](#tag/domains-transfer). If no WHOIS information is provided, default contact information for that TLD will be used. Before making request, ensure WHOIS information for desired TLD exists in your account. Use this endpoint to bring domains registered elsewhere into your account.
20472
+ * @summary Start domain transfer
20473
+ * @param {DomainsV1TransferTransferRequest} domainsV1TransferTransferRequest
20474
+ * @param {*} [options] Override http request option.
20475
+ * @throws {RequiredError}
20476
+ */
20477
+ startDomainTransferV1(domainsV1TransferTransferRequest: DomainsV1TransferTransferRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
20388
20478
  };
20389
20479
  /**
20390
20480
  * DomainsTransferApi - factory interface
@@ -20414,6 +20504,14 @@ export declare const DomainsTransferApiFactory: (configuration?: Configuration,
20414
20504
  * @throws {RequiredError}
20415
20505
  */
20416
20506
  getTransferV1(domain: string, options?: RawAxiosRequestConfig): AxiosPromise<DomainsV1TransferTransferResource>;
20507
+ /**
20508
+ * Transfer a domain from another registrar to your account. The transfer runs on a domain transfer service you have already purchased. Before making request, unlock the domain at the current registrar and get its authorization code. A successful response means the transfer has been started. Completion depends on the current registrar and can be followed with the [transfer list endpoint](#tag/domains-transfer). If no WHOIS information is provided, default contact information for that TLD will be used. Before making request, ensure WHOIS information for desired TLD exists in your account. Use this endpoint to bring domains registered elsewhere into your account.
20509
+ * @summary Start domain transfer
20510
+ * @param {DomainsV1TransferTransferRequest} domainsV1TransferTransferRequest
20511
+ * @param {*} [options] Override http request option.
20512
+ * @throws {RequiredError}
20513
+ */
20514
+ startDomainTransferV1(domainsV1TransferTransferRequest: DomainsV1TransferTransferRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
20417
20515
  };
20418
20516
  /**
20419
20517
  * DomainsTransferApi - object-oriented interface
@@ -20448,6 +20546,15 @@ export declare class DomainsTransferApi extends BaseAPI {
20448
20546
  * @memberof DomainsTransferApi
20449
20547
  */
20450
20548
  getTransferV1(domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DomainsV1TransferTransferResource, any, {}, any>>;
20549
+ /**
20550
+ * Transfer a domain from another registrar to your account. The transfer runs on a domain transfer service you have already purchased. Before making request, unlock the domain at the current registrar and get its authorization code. A successful response means the transfer has been started. Completion depends on the current registrar and can be followed with the [transfer list endpoint](#tag/domains-transfer). If no WHOIS information is provided, default contact information for that TLD will be used. Before making request, ensure WHOIS information for desired TLD exists in your account. Use this endpoint to bring domains registered elsewhere into your account.
20551
+ * @summary Start domain transfer
20552
+ * @param {DomainsV1TransferTransferRequest} domainsV1TransferTransferRequest
20553
+ * @param {*} [options] Override http request option.
20554
+ * @throws {RequiredError}
20555
+ * @memberof DomainsTransferApi
20556
+ */
20557
+ startDomainTransferV1(domainsV1TransferTransferRequest: DomainsV1TransferTransferRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
20451
20558
  }
20452
20559
  /**
20453
20560
  * DomainsWHOISApi - axios parameter creator
@@ -22811,7 +22918,7 @@ export declare const HostingDatabasesApiAxiosParamCreator: (configuration?: Conf
22811
22918
  */
22812
22919
  createAccountDatabaseV1: (username: string, hostingV1DatabasesCreateDatabaseRequest: HostingV1DatabasesCreateDatabaseRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
22813
22920
  /**
22814
- * Allows a remote host to connect to the specified database. Provide an IPv4/IPv6 address, or \"%\" to allow any host. The database name must be the full name returned by the list databases endpoint.
22921
+ * Allows a remote host to connect to the specified database. Provide an IPv4/IPv6 address, or \"%\" to allow any host. The database name must be the full name returned by the list databases endpoint. Database creation is synchronous, so a 404 here means no database with that name exists under the username, not that it is still being created.
22815
22922
  * @summary Create database remote connection
22816
22923
  * @param {string} username
22817
22924
  * @param {string} name Full database name as returned by the list databases endpoint.
@@ -22915,7 +23022,7 @@ export declare const HostingDatabasesApiFp: (configuration?: Configuration) => {
22915
23022
  */
22916
23023
  createAccountDatabaseV1(username: string, hostingV1DatabasesCreateDatabaseRequest: HostingV1DatabasesCreateDatabaseRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
22917
23024
  /**
22918
- * Allows a remote host to connect to the specified database. Provide an IPv4/IPv6 address, or \"%\" to allow any host. The database name must be the full name returned by the list databases endpoint.
23025
+ * Allows a remote host to connect to the specified database. Provide an IPv4/IPv6 address, or \"%\" to allow any host. The database name must be the full name returned by the list databases endpoint. Database creation is synchronous, so a 404 here means no database with that name exists under the username, not that it is still being created.
22919
23026
  * @summary Create database remote connection
22920
23027
  * @param {string} username
22921
23028
  * @param {string} name Full database name as returned by the list databases endpoint.
@@ -23019,7 +23126,7 @@ export declare const HostingDatabasesApiFactory: (configuration?: Configuration,
23019
23126
  */
23020
23127
  createAccountDatabaseV1(username: string, hostingV1DatabasesCreateDatabaseRequest: HostingV1DatabasesCreateDatabaseRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
23021
23128
  /**
23022
- * Allows a remote host to connect to the specified database. Provide an IPv4/IPv6 address, or \"%\" to allow any host. The database name must be the full name returned by the list databases endpoint.
23129
+ * Allows a remote host to connect to the specified database. Provide an IPv4/IPv6 address, or \"%\" to allow any host. The database name must be the full name returned by the list databases endpoint. Database creation is synchronous, so a 404 here means no database with that name exists under the username, not that it is still being created.
23023
23130
  * @summary Create database remote connection
23024
23131
  * @param {string} username
23025
23132
  * @param {string} name Full database name as returned by the list databases endpoint.
@@ -23127,7 +23234,7 @@ export declare class HostingDatabasesApi extends BaseAPI {
23127
23234
  */
23128
23235
  createAccountDatabaseV1(username: string, hostingV1DatabasesCreateDatabaseRequest: HostingV1DatabasesCreateDatabaseRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
23129
23236
  /**
23130
- * Allows a remote host to connect to the specified database. Provide an IPv4/IPv6 address, or \"%\" to allow any host. The database name must be the full name returned by the list databases endpoint.
23237
+ * Allows a remote host to connect to the specified database. Provide an IPv4/IPv6 address, or \"%\" to allow any host. The database name must be the full name returned by the list databases endpoint. Database creation is synchronous, so a 404 here means no database with that name exists under the username, not that it is still being created.
23131
23238
  * @summary Create database remote connection
23132
23239
  * @param {string} username
23133
23240
  * @param {string} name Full database name as returned by the list databases endpoint.
@@ -23605,7 +23712,7 @@ export declare class HostingDomainsApi extends BaseAPI {
23605
23712
  */
23606
23713
  export declare const HostingFilesApiAxiosParamCreator: (configuration?: Configuration) => {
23607
23714
  /**
23608
- * 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 ```
23715
+ * Generate a file browser upload URL with authentication credentials for uploading files directly to a website\'s file storage. While the website is still being set up (`status: running` on the list website setups endpoint) this endpoint returns 409 with a `Retry-After` header: wait that many seconds and retry, or poll the website setups until the status is `completed`. 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 ```
23609
23716
  * @summary Generate upload URL
23610
23717
  * @param {HostingV1FilesGenerateUploadUrlRequest} hostingV1FilesGenerateUploadUrlRequest
23611
23718
  * @param {*} [options] Override http request option.
@@ -23645,7 +23752,7 @@ export declare const HostingFilesApiAxiosParamCreator: (configuration?: Configur
23645
23752
  */
23646
23753
  export declare const HostingFilesApiFp: (configuration?: Configuration) => {
23647
23754
  /**
23648
- * 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 ```
23755
+ * Generate a file browser upload URL with authentication credentials for uploading files directly to a website\'s file storage. While the website is still being set up (`status: running` on the list website setups endpoint) this endpoint returns 409 with a `Retry-After` header: wait that many seconds and retry, or poll the website setups until the status is `completed`. 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 ```
23649
23756
  * @summary Generate upload URL
23650
23757
  * @param {HostingV1FilesGenerateUploadUrlRequest} hostingV1FilesGenerateUploadUrlRequest
23651
23758
  * @param {*} [options] Override http request option.
@@ -23685,7 +23792,7 @@ export declare const HostingFilesApiFp: (configuration?: Configuration) => {
23685
23792
  */
23686
23793
  export declare const HostingFilesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
23687
23794
  /**
23688
- * 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 ```
23795
+ * Generate a file browser upload URL with authentication credentials for uploading files directly to a website\'s file storage. While the website is still being set up (`status: running` on the list website setups endpoint) this endpoint returns 409 with a `Retry-After` header: wait that many seconds and retry, or poll the website setups until the status is `completed`. 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 ```
23689
23796
  * @summary Generate upload URL
23690
23797
  * @param {HostingV1FilesGenerateUploadUrlRequest} hostingV1FilesGenerateUploadUrlRequest
23691
23798
  * @param {*} [options] Override http request option.
@@ -23727,7 +23834,7 @@ export declare const HostingFilesApiFactory: (configuration?: Configuration, bas
23727
23834
  */
23728
23835
  export declare class HostingFilesApi extends BaseAPI {
23729
23836
  /**
23730
- * 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 ```
23837
+ * Generate a file browser upload URL with authentication credentials for uploading files directly to a website\'s file storage. While the website is still being set up (`status: running` on the list website setups endpoint) this endpoint returns 409 with a `Retry-After` header: wait that many seconds and retry, or poll the website setups until the status is `completed`. 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 ```
23731
23838
  * @summary Generate upload URL
23732
23839
  * @param {HostingV1FilesGenerateUploadUrlRequest} hostingV1FilesGenerateUploadUrlRequest
23733
23840
  * @param {*} [options] Override http request option.
@@ -25373,7 +25480,7 @@ export declare class HostingSSLApi extends BaseAPI {
25373
25480
  */
25374
25481
  export declare const HostingWebsitesApiAxiosParamCreator: (configuration?: Configuration) => {
25375
25482
  /**
25376
- * Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation takes up to a few minutes to complete. Check the websites list endpoint to see when your new website becomes available.
25483
+ * Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation is asynchronous and takes up to a few minutes. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. While the setup is `running`, endpoints that operate on the website may respond with `404` or `409`. `is_enabled` on the websites list reflects suspension, not readiness.
25377
25484
  * @summary Create website
25378
25485
  * @param {HostingV1WebsitesCreateWebsiteRequest} hostingV1WebsitesCreateWebsiteRequest
25379
25486
  * @param {*} [options] Override http request option.
@@ -25399,7 +25506,15 @@ export declare const HostingWebsitesApiAxiosParamCreator: (configuration?: Confi
25399
25506
  */
25400
25507
  deployStaticSiteArchiveV1: (username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
25401
25508
  /**
25402
- * 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.
25509
+ * 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.
25510
+ * @summary List website setups
25511
+ * @param {string | null} [domain] Filter by domain name (exact match)
25512
+ * @param {*} [options] Override http request option.
25513
+ * @throws {RequiredError}
25514
+ */
25515
+ listWebsiteSetupsV1: (domain?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
25516
+ /**
25517
+ * 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.
25403
25518
  * @summary List websites
25404
25519
  * @param {number} [page] Page number
25405
25520
  * @param {number} [perPage] Number of items per page
@@ -25419,7 +25534,7 @@ export declare const HostingWebsitesApiAxiosParamCreator: (configuration?: Confi
25419
25534
  */
25420
25535
  export declare const HostingWebsitesApiFp: (configuration?: Configuration) => {
25421
25536
  /**
25422
- * Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation takes up to a few minutes to complete. Check the websites list endpoint to see when your new website becomes available.
25537
+ * Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation is asynchronous and takes up to a few minutes. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. While the setup is `running`, endpoints that operate on the website may respond with `404` or `409`. `is_enabled` on the websites list reflects suspension, not readiness.
25423
25538
  * @summary Create website
25424
25539
  * @param {HostingV1WebsitesCreateWebsiteRequest} hostingV1WebsitesCreateWebsiteRequest
25425
25540
  * @param {*} [options] Override http request option.
@@ -25445,7 +25560,15 @@ export declare const HostingWebsitesApiFp: (configuration?: Configuration) => {
25445
25560
  */
25446
25561
  deployStaticSiteArchiveV1(username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
25447
25562
  /**
25448
- * 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.
25563
+ * 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.
25564
+ * @summary List website setups
25565
+ * @param {string | null} [domain] Filter by domain name (exact match)
25566
+ * @param {*} [options] Override http request option.
25567
+ * @throws {RequiredError}
25568
+ */
25569
+ listWebsiteSetupsV1(domain?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<HostingV1OnboardingsOnboardingResource>>>;
25570
+ /**
25571
+ * 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.
25449
25572
  * @summary List websites
25450
25573
  * @param {number} [page] Page number
25451
25574
  * @param {number} [perPage] Number of items per page
@@ -25465,7 +25588,7 @@ export declare const HostingWebsitesApiFp: (configuration?: Configuration) => {
25465
25588
  */
25466
25589
  export declare const HostingWebsitesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
25467
25590
  /**
25468
- * Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation takes up to a few minutes to complete. Check the websites list endpoint to see when your new website becomes available.
25591
+ * Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation is asynchronous and takes up to a few minutes. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. While the setup is `running`, endpoints that operate on the website may respond with `404` or `409`. `is_enabled` on the websites list reflects suspension, not readiness.
25469
25592
  * @summary Create website
25470
25593
  * @param {HostingV1WebsitesCreateWebsiteRequest} hostingV1WebsitesCreateWebsiteRequest
25471
25594
  * @param {*} [options] Override http request option.
@@ -25491,7 +25614,15 @@ export declare const HostingWebsitesApiFactory: (configuration?: Configuration,
25491
25614
  */
25492
25615
  deployStaticSiteArchiveV1(username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
25493
25616
  /**
25494
- * 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.
25617
+ * 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.
25618
+ * @summary List website setups
25619
+ * @param {string | null} [domain] Filter by domain name (exact match)
25620
+ * @param {*} [options] Override http request option.
25621
+ * @throws {RequiredError}
25622
+ */
25623
+ listWebsiteSetupsV1(domain?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<HostingV1OnboardingsOnboardingResource>>;
25624
+ /**
25625
+ * 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.
25495
25626
  * @summary List websites
25496
25627
  * @param {number} [page] Page number
25497
25628
  * @param {number} [perPage] Number of items per page
@@ -25513,7 +25644,7 @@ export declare const HostingWebsitesApiFactory: (configuration?: Configuration,
25513
25644
  */
25514
25645
  export declare class HostingWebsitesApi extends BaseAPI {
25515
25646
  /**
25516
- * Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation takes up to a few minutes to complete. Check the websites list endpoint to see when your new website becomes available.
25647
+ * Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order\'s hosting plan. The datacenter_code parameter is required when creating the first website on a new hosting plan - this will set up and configure new hosting account in the selected datacenter. Subsequent websites will be hosted on the same datacenter automatically. Website creation is asynchronous and takes up to a few minutes. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. While the setup is `running`, endpoints that operate on the website may respond with `404` or `409`. `is_enabled` on the websites list reflects suspension, not readiness.
25517
25648
  * @summary Create website
25518
25649
  * @param {HostingV1WebsitesCreateWebsiteRequest} hostingV1WebsitesCreateWebsiteRequest
25519
25650
  * @param {*} [options] Override http request option.
@@ -25542,7 +25673,16 @@ export declare class HostingWebsitesApi extends BaseAPI {
25542
25673
  */
25543
25674
  deployStaticSiteArchiveV1(username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
25544
25675
  /**
25545
- * 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.
25676
+ * 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.
25677
+ * @summary List website setups
25678
+ * @param {string | null} [domain] Filter by domain name (exact match)
25679
+ * @param {*} [options] Override http request option.
25680
+ * @throws {RequiredError}
25681
+ * @memberof HostingWebsitesApi
25682
+ */
25683
+ listWebsiteSetupsV1(domain?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1OnboardingsOnboardingResource[], any, {}, any>>;
25684
+ /**
25685
+ * 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.
25546
25686
  * @summary List websites
25547
25687
  * @param {number} [page] Page number
25548
25688
  * @param {number} [perPage] Number of items per page