@hostinger/sdk 1.54.2 → 1.55.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 +138 -19
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +95 -19
- package/dist/api.js +101 -28
- 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 +95 -19
- package/dist/esm/api.js +90 -17
- 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/HostingDatabasesApi.md +1 -1
- package/docs/HostingFilesApi.md +2 -1
- package/docs/HostingV1OnboardingsOnboardingResource.md +28 -0
- package/docs/HostingV1WebsitesCreateWebsiteRequest.md +1 -1
- package/docs/HostingV1WebsitesWebsiteResource.md +1 -1
- package/docs/HostingWebsitesApi.md +57 -2
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.55.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
|
|
@@ -8534,6 +8534,49 @@ export declare const HostingV1NodeJsVulnerabilityResourceSeverityEnum: {
|
|
|
8534
8534
|
readonly Unknown: "unknown";
|
|
8535
8535
|
};
|
|
8536
8536
|
export type HostingV1NodeJsVulnerabilityResourceSeverityEnum = typeof HostingV1NodeJsVulnerabilityResourceSeverityEnum[keyof typeof HostingV1NodeJsVulnerabilityResourceSeverityEnum];
|
|
8537
|
+
/**
|
|
8538
|
+
*
|
|
8539
|
+
* @export
|
|
8540
|
+
* @interface HostingV1OnboardingsOnboardingResource
|
|
8541
|
+
*/
|
|
8542
|
+
export interface HostingV1OnboardingsOnboardingResource {
|
|
8543
|
+
/**
|
|
8544
|
+
* Domain of the website being set up.
|
|
8545
|
+
* @type {string}
|
|
8546
|
+
* @memberof HostingV1OnboardingsOnboardingResource
|
|
8547
|
+
*/
|
|
8548
|
+
'domain': string;
|
|
8549
|
+
/**
|
|
8550
|
+
* Hosting account username.
|
|
8551
|
+
* @type {string}
|
|
8552
|
+
* @memberof HostingV1OnboardingsOnboardingResource
|
|
8553
|
+
*/
|
|
8554
|
+
'username': string;
|
|
8555
|
+
/**
|
|
8556
|
+
* `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.
|
|
8557
|
+
* @type {string}
|
|
8558
|
+
* @memberof HostingV1OnboardingsOnboardingResource
|
|
8559
|
+
*/
|
|
8560
|
+
'status': HostingV1OnboardingsOnboardingResourceStatusEnum;
|
|
8561
|
+
/**
|
|
8562
|
+
* When the setup was requested.
|
|
8563
|
+
* @type {string}
|
|
8564
|
+
* @memberof HostingV1OnboardingsOnboardingResource
|
|
8565
|
+
*/
|
|
8566
|
+
'created_at': string;
|
|
8567
|
+
/**
|
|
8568
|
+
* When the setup last reported progress.
|
|
8569
|
+
* @type {string}
|
|
8570
|
+
* @memberof HostingV1OnboardingsOnboardingResource
|
|
8571
|
+
*/
|
|
8572
|
+
'updated_at': string;
|
|
8573
|
+
}
|
|
8574
|
+
export declare const HostingV1OnboardingsOnboardingResourceStatusEnum: {
|
|
8575
|
+
readonly Running: "running";
|
|
8576
|
+
readonly Completed: "completed";
|
|
8577
|
+
readonly Failed: "failed";
|
|
8578
|
+
};
|
|
8579
|
+
export type HostingV1OnboardingsOnboardingResourceStatusEnum = typeof HostingV1OnboardingsOnboardingResourceStatusEnum[keyof typeof HostingV1OnboardingsOnboardingResourceStatusEnum];
|
|
8537
8580
|
/**
|
|
8538
8581
|
*
|
|
8539
8582
|
* @export
|
|
@@ -8899,7 +8942,7 @@ export interface HostingV1WebsitesCreateWebsiteRequest {
|
|
|
8899
8942
|
*/
|
|
8900
8943
|
'domain': string;
|
|
8901
8944
|
/**
|
|
8902
|
-
* ID
|
|
8945
|
+
* Hosting order ID to create this website on. Choose the order whose hosting plan should host the new website. List orders to find available IDs.
|
|
8903
8946
|
* @type {number}
|
|
8904
8947
|
* @memberof HostingV1WebsitesCreateWebsiteRequest
|
|
8905
8948
|
*/
|
|
@@ -8943,7 +8986,7 @@ export interface HostingV1WebsitesWebsiteResource {
|
|
|
8943
8986
|
*/
|
|
8944
8987
|
'vhost_type': HostingV1WebsitesWebsiteResourceVhostTypeEnum | null;
|
|
8945
8988
|
/**
|
|
8946
|
-
*
|
|
8989
|
+
* 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
8990
|
* @type {boolean}
|
|
8948
8991
|
* @memberof HostingV1WebsitesWebsiteResource
|
|
8949
8992
|
*/
|
|
@@ -22811,7 +22854,7 @@ export declare const HostingDatabasesApiAxiosParamCreator: (configuration?: Conf
|
|
|
22811
22854
|
*/
|
|
22812
22855
|
createAccountDatabaseV1: (username: string, hostingV1DatabasesCreateDatabaseRequest: HostingV1DatabasesCreateDatabaseRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22813
22856
|
/**
|
|
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.
|
|
22857
|
+
* 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
22858
|
* @summary Create database remote connection
|
|
22816
22859
|
* @param {string} username
|
|
22817
22860
|
* @param {string} name Full database name as returned by the list databases endpoint.
|
|
@@ -22915,7 +22958,7 @@ export declare const HostingDatabasesApiFp: (configuration?: Configuration) => {
|
|
|
22915
22958
|
*/
|
|
22916
22959
|
createAccountDatabaseV1(username: string, hostingV1DatabasesCreateDatabaseRequest: HostingV1DatabasesCreateDatabaseRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
22917
22960
|
/**
|
|
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.
|
|
22961
|
+
* 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
22962
|
* @summary Create database remote connection
|
|
22920
22963
|
* @param {string} username
|
|
22921
22964
|
* @param {string} name Full database name as returned by the list databases endpoint.
|
|
@@ -23019,7 +23062,7 @@ export declare const HostingDatabasesApiFactory: (configuration?: Configuration,
|
|
|
23019
23062
|
*/
|
|
23020
23063
|
createAccountDatabaseV1(username: string, hostingV1DatabasesCreateDatabaseRequest: HostingV1DatabasesCreateDatabaseRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
23021
23064
|
/**
|
|
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.
|
|
23065
|
+
* 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
23066
|
* @summary Create database remote connection
|
|
23024
23067
|
* @param {string} username
|
|
23025
23068
|
* @param {string} name Full database name as returned by the list databases endpoint.
|
|
@@ -23127,7 +23170,7 @@ export declare class HostingDatabasesApi extends BaseAPI {
|
|
|
23127
23170
|
*/
|
|
23128
23171
|
createAccountDatabaseV1(username: string, hostingV1DatabasesCreateDatabaseRequest: HostingV1DatabasesCreateDatabaseRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
23129
23172
|
/**
|
|
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.
|
|
23173
|
+
* 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
23174
|
* @summary Create database remote connection
|
|
23132
23175
|
* @param {string} username
|
|
23133
23176
|
* @param {string} name Full database name as returned by the list databases endpoint.
|
|
@@ -23605,7 +23648,7 @@ export declare class HostingDomainsApi extends BaseAPI {
|
|
|
23605
23648
|
*/
|
|
23606
23649
|
export declare const HostingFilesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23607
23650
|
/**
|
|
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 ```
|
|
23651
|
+
* 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
23652
|
* @summary Generate upload URL
|
|
23610
23653
|
* @param {HostingV1FilesGenerateUploadUrlRequest} hostingV1FilesGenerateUploadUrlRequest
|
|
23611
23654
|
* @param {*} [options] Override http request option.
|
|
@@ -23645,7 +23688,7 @@ export declare const HostingFilesApiAxiosParamCreator: (configuration?: Configur
|
|
|
23645
23688
|
*/
|
|
23646
23689
|
export declare const HostingFilesApiFp: (configuration?: Configuration) => {
|
|
23647
23690
|
/**
|
|
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 ```
|
|
23691
|
+
* 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
23692
|
* @summary Generate upload URL
|
|
23650
23693
|
* @param {HostingV1FilesGenerateUploadUrlRequest} hostingV1FilesGenerateUploadUrlRequest
|
|
23651
23694
|
* @param {*} [options] Override http request option.
|
|
@@ -23685,7 +23728,7 @@ export declare const HostingFilesApiFp: (configuration?: Configuration) => {
|
|
|
23685
23728
|
*/
|
|
23686
23729
|
export declare const HostingFilesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
23687
23730
|
/**
|
|
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 ```
|
|
23731
|
+
* 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
23732
|
* @summary Generate upload URL
|
|
23690
23733
|
* @param {HostingV1FilesGenerateUploadUrlRequest} hostingV1FilesGenerateUploadUrlRequest
|
|
23691
23734
|
* @param {*} [options] Override http request option.
|
|
@@ -23727,7 +23770,7 @@ export declare const HostingFilesApiFactory: (configuration?: Configuration, bas
|
|
|
23727
23770
|
*/
|
|
23728
23771
|
export declare class HostingFilesApi extends BaseAPI {
|
|
23729
23772
|
/**
|
|
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 ```
|
|
23773
|
+
* 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
23774
|
* @summary Generate upload URL
|
|
23732
23775
|
* @param {HostingV1FilesGenerateUploadUrlRequest} hostingV1FilesGenerateUploadUrlRequest
|
|
23733
23776
|
* @param {*} [options] Override http request option.
|
|
@@ -25373,7 +25416,7 @@ export declare class HostingSSLApi extends BaseAPI {
|
|
|
25373
25416
|
*/
|
|
25374
25417
|
export declare const HostingWebsitesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
25375
25418
|
/**
|
|
25376
|
-
* Create a new website for the authenticated client.
|
|
25419
|
+
* 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
25420
|
* @summary Create website
|
|
25378
25421
|
* @param {HostingV1WebsitesCreateWebsiteRequest} hostingV1WebsitesCreateWebsiteRequest
|
|
25379
25422
|
* @param {*} [options] Override http request option.
|
|
@@ -25399,7 +25442,15 @@ export declare const HostingWebsitesApiAxiosParamCreator: (configuration?: Confi
|
|
|
25399
25442
|
*/
|
|
25400
25443
|
deployStaticSiteArchiveV1: (username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25401
25444
|
/**
|
|
25402
|
-
*
|
|
25445
|
+
* 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.
|
|
25446
|
+
* @summary List website setups
|
|
25447
|
+
* @param {string | null} [domain] Filter by domain name (exact match)
|
|
25448
|
+
* @param {*} [options] Override http request option.
|
|
25449
|
+
* @throws {RequiredError}
|
|
25450
|
+
*/
|
|
25451
|
+
listWebsiteSetupsV1: (domain?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25452
|
+
/**
|
|
25453
|
+
* 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
25454
|
* @summary List websites
|
|
25404
25455
|
* @param {number} [page] Page number
|
|
25405
25456
|
* @param {number} [perPage] Number of items per page
|
|
@@ -25419,7 +25470,7 @@ export declare const HostingWebsitesApiAxiosParamCreator: (configuration?: Confi
|
|
|
25419
25470
|
*/
|
|
25420
25471
|
export declare const HostingWebsitesApiFp: (configuration?: Configuration) => {
|
|
25421
25472
|
/**
|
|
25422
|
-
* Create a new website for the authenticated client.
|
|
25473
|
+
* 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
25474
|
* @summary Create website
|
|
25424
25475
|
* @param {HostingV1WebsitesCreateWebsiteRequest} hostingV1WebsitesCreateWebsiteRequest
|
|
25425
25476
|
* @param {*} [options] Override http request option.
|
|
@@ -25445,7 +25496,15 @@ export declare const HostingWebsitesApiFp: (configuration?: Configuration) => {
|
|
|
25445
25496
|
*/
|
|
25446
25497
|
deployStaticSiteArchiveV1(username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
25447
25498
|
/**
|
|
25448
|
-
*
|
|
25499
|
+
* 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.
|
|
25500
|
+
* @summary List website setups
|
|
25501
|
+
* @param {string | null} [domain] Filter by domain name (exact match)
|
|
25502
|
+
* @param {*} [options] Override http request option.
|
|
25503
|
+
* @throws {RequiredError}
|
|
25504
|
+
*/
|
|
25505
|
+
listWebsiteSetupsV1(domain?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<HostingV1OnboardingsOnboardingResource>>>;
|
|
25506
|
+
/**
|
|
25507
|
+
* 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
25508
|
* @summary List websites
|
|
25450
25509
|
* @param {number} [page] Page number
|
|
25451
25510
|
* @param {number} [perPage] Number of items per page
|
|
@@ -25465,7 +25524,7 @@ export declare const HostingWebsitesApiFp: (configuration?: Configuration) => {
|
|
|
25465
25524
|
*/
|
|
25466
25525
|
export declare const HostingWebsitesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
25467
25526
|
/**
|
|
25468
|
-
* Create a new website for the authenticated client.
|
|
25527
|
+
* 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
25528
|
* @summary Create website
|
|
25470
25529
|
* @param {HostingV1WebsitesCreateWebsiteRequest} hostingV1WebsitesCreateWebsiteRequest
|
|
25471
25530
|
* @param {*} [options] Override http request option.
|
|
@@ -25491,7 +25550,15 @@ export declare const HostingWebsitesApiFactory: (configuration?: Configuration,
|
|
|
25491
25550
|
*/
|
|
25492
25551
|
deployStaticSiteArchiveV1(username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
25493
25552
|
/**
|
|
25494
|
-
*
|
|
25553
|
+
* 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.
|
|
25554
|
+
* @summary List website setups
|
|
25555
|
+
* @param {string | null} [domain] Filter by domain name (exact match)
|
|
25556
|
+
* @param {*} [options] Override http request option.
|
|
25557
|
+
* @throws {RequiredError}
|
|
25558
|
+
*/
|
|
25559
|
+
listWebsiteSetupsV1(domain?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<HostingV1OnboardingsOnboardingResource>>;
|
|
25560
|
+
/**
|
|
25561
|
+
* 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
25562
|
* @summary List websites
|
|
25496
25563
|
* @param {number} [page] Page number
|
|
25497
25564
|
* @param {number} [perPage] Number of items per page
|
|
@@ -25513,7 +25580,7 @@ export declare const HostingWebsitesApiFactory: (configuration?: Configuration,
|
|
|
25513
25580
|
*/
|
|
25514
25581
|
export declare class HostingWebsitesApi extends BaseAPI {
|
|
25515
25582
|
/**
|
|
25516
|
-
* Create a new website for the authenticated client.
|
|
25583
|
+
* 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
25584
|
* @summary Create website
|
|
25518
25585
|
* @param {HostingV1WebsitesCreateWebsiteRequest} hostingV1WebsitesCreateWebsiteRequest
|
|
25519
25586
|
* @param {*} [options] Override http request option.
|
|
@@ -25542,7 +25609,16 @@ export declare class HostingWebsitesApi extends BaseAPI {
|
|
|
25542
25609
|
*/
|
|
25543
25610
|
deployStaticSiteArchiveV1(username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
25544
25611
|
/**
|
|
25545
|
-
*
|
|
25612
|
+
* 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.
|
|
25613
|
+
* @summary List website setups
|
|
25614
|
+
* @param {string | null} [domain] Filter by domain name (exact match)
|
|
25615
|
+
* @param {*} [options] Override http request option.
|
|
25616
|
+
* @throws {RequiredError}
|
|
25617
|
+
* @memberof HostingWebsitesApi
|
|
25618
|
+
*/
|
|
25619
|
+
listWebsiteSetupsV1(domain?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1OnboardingsOnboardingResource[], any, {}, any>>;
|
|
25620
|
+
/**
|
|
25621
|
+
* 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
25622
|
* @summary List websites
|
|
25547
25623
|
* @param {number} [page] Page number
|
|
25548
25624
|
* @param {number} [perPage] Number of items per page
|