@hostinger/sdk 1.47.1 → 1.49.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 +877 -5
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +550 -5
- package/dist/api.js +665 -15
- 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 +550 -5
- package/dist/esm/api.js +655 -5
- 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/HostingNodeJSApi.md +367 -0
- package/docs/HostingV1NodeJsBuildAnalysisResource.md +22 -0
- package/docs/HostingV1NodeJsLogEntryResource.md +24 -0
- package/docs/HostingV1NodeJsRuntimeLogsResource.md +26 -0
- package/docs/HostingV1NodeJsStoredBuildSettingsResource.md +32 -0
- package/docs/HostingV1NodeJsUpdateBuildSettingsRequest.md +32 -0
- package/docs/VPSFirewallApi.md +56 -1
- 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.49.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
|
|
@@ -7028,6 +7028,25 @@ export interface HostingV1FilesUploadUrlResource {
|
|
|
7028
7028
|
*/
|
|
7029
7029
|
'rest_auth_key': string;
|
|
7030
7030
|
}
|
|
7031
|
+
/**
|
|
7032
|
+
*
|
|
7033
|
+
* @export
|
|
7034
|
+
* @interface HostingV1NodeJsBuildAnalysisResource
|
|
7035
|
+
*/
|
|
7036
|
+
export interface HostingV1NodeJsBuildAnalysisResource {
|
|
7037
|
+
/**
|
|
7038
|
+
* Why the build failed. null when no analysis could be produced.
|
|
7039
|
+
* @type {string}
|
|
7040
|
+
* @memberof HostingV1NodeJsBuildAnalysisResource
|
|
7041
|
+
*/
|
|
7042
|
+
'analysis': string | null;
|
|
7043
|
+
/**
|
|
7044
|
+
* Suggested fix for the build failure. null when no analysis could be produced.
|
|
7045
|
+
* @type {string}
|
|
7046
|
+
* @memberof HostingV1NodeJsBuildAnalysisResource
|
|
7047
|
+
*/
|
|
7048
|
+
'solution': string | null;
|
|
7049
|
+
}
|
|
7031
7050
|
/**
|
|
7032
7051
|
*
|
|
7033
7052
|
* @export
|
|
@@ -7389,6 +7408,31 @@ export interface HostingV1NodeJsGetBuildSettingsRequest {
|
|
|
7389
7408
|
*/
|
|
7390
7409
|
'archive_path': string;
|
|
7391
7410
|
}
|
|
7411
|
+
/**
|
|
7412
|
+
*
|
|
7413
|
+
* @export
|
|
7414
|
+
* @interface HostingV1NodeJsLogEntryResource
|
|
7415
|
+
*/
|
|
7416
|
+
export interface HostingV1NodeJsLogEntryResource {
|
|
7417
|
+
/**
|
|
7418
|
+
* ISO 8601 timestamp of the log entry
|
|
7419
|
+
* @type {string}
|
|
7420
|
+
* @memberof HostingV1NodeJsLogEntryResource
|
|
7421
|
+
*/
|
|
7422
|
+
'timestamp': string;
|
|
7423
|
+
/**
|
|
7424
|
+
* Log level in upper case (usually ERROR, WARN, INFO, LOG, DEBUG or TRACE). Numeric pino levels are mapped to these names.
|
|
7425
|
+
* @type {string}
|
|
7426
|
+
* @memberof HostingV1NodeJsLogEntryResource
|
|
7427
|
+
*/
|
|
7428
|
+
'level': string;
|
|
7429
|
+
/**
|
|
7430
|
+
* Log message
|
|
7431
|
+
* @type {string}
|
|
7432
|
+
* @memberof HostingV1NodeJsLogEntryResource
|
|
7433
|
+
*/
|
|
7434
|
+
'message': string;
|
|
7435
|
+
}
|
|
7392
7436
|
/**
|
|
7393
7437
|
*
|
|
7394
7438
|
* @export
|
|
@@ -7433,6 +7477,37 @@ export interface HostingV1NodeJsPatchVulnerabilitiesRequest {
|
|
|
7433
7477
|
*/
|
|
7434
7478
|
'vulnerability_ids': Array<string>;
|
|
7435
7479
|
}
|
|
7480
|
+
/**
|
|
7481
|
+
*
|
|
7482
|
+
* @export
|
|
7483
|
+
* @interface HostingV1NodeJsRuntimeLogsResource
|
|
7484
|
+
*/
|
|
7485
|
+
export interface HostingV1NodeJsRuntimeLogsResource {
|
|
7486
|
+
/**
|
|
7487
|
+
* Array of [`Hosting.V1.NodeJs.LogEntryResource`](#model/hostingv1nodejslogentryresource)
|
|
7488
|
+
* @type {Array<HostingV1NodeJsLogEntryResource>}
|
|
7489
|
+
* @memberof HostingV1NodeJsRuntimeLogsResource
|
|
7490
|
+
*/
|
|
7491
|
+
'logs': Array<HostingV1NodeJsLogEntryResource>;
|
|
7492
|
+
/**
|
|
7493
|
+
* Timestamp of the first line of the log file; null when the file is empty or its first line has no timestamp field
|
|
7494
|
+
* @type {string}
|
|
7495
|
+
* @memberof HostingV1NodeJsRuntimeLogsResource
|
|
7496
|
+
*/
|
|
7497
|
+
'started_at': string | null;
|
|
7498
|
+
/**
|
|
7499
|
+
* Total number of lines in the raw log file. Send total_lines + 1 as from_line in the next poll to receive only new entries.
|
|
7500
|
+
* @type {number}
|
|
7501
|
+
* @memberof HostingV1NodeJsRuntimeLogsResource
|
|
7502
|
+
*/
|
|
7503
|
+
'total_lines': number;
|
|
7504
|
+
/**
|
|
7505
|
+
* Time of the last completed build; entries before it belong to the previous deployment. null when no build has completed yet.
|
|
7506
|
+
* @type {string}
|
|
7507
|
+
* @memberof HostingV1NodeJsRuntimeLogsResource
|
|
7508
|
+
*/
|
|
7509
|
+
'last_deployed_at': string | null;
|
|
7510
|
+
}
|
|
7436
7511
|
/**
|
|
7437
7512
|
*
|
|
7438
7513
|
* @export
|
|
@@ -7591,6 +7666,167 @@ export interface HostingV1NodeJsStartBuildRequestSourceOptions {
|
|
|
7591
7666
|
*/
|
|
7592
7667
|
'archive_path': string;
|
|
7593
7668
|
}
|
|
7669
|
+
/**
|
|
7670
|
+
*
|
|
7671
|
+
* @export
|
|
7672
|
+
* @interface HostingV1NodeJsStoredBuildSettingsResource
|
|
7673
|
+
*/
|
|
7674
|
+
export interface HostingV1NodeJsStoredBuildSettingsResource {
|
|
7675
|
+
/**
|
|
7676
|
+
* Node.js major version used to build and run the application
|
|
7677
|
+
* @type {number}
|
|
7678
|
+
* @memberof HostingV1NodeJsStoredBuildSettingsResource
|
|
7679
|
+
*/
|
|
7680
|
+
'node_version': number;
|
|
7681
|
+
/**
|
|
7682
|
+
* Detected or chosen application framework
|
|
7683
|
+
* @type {string}
|
|
7684
|
+
* @memberof HostingV1NodeJsStoredBuildSettingsResource
|
|
7685
|
+
*/
|
|
7686
|
+
'app_type': HostingV1NodeJsStoredBuildSettingsResourceAppTypeEnum | null;
|
|
7687
|
+
/**
|
|
7688
|
+
* Application root directory (where package.json is located) relative to public_html; null means public_html itself
|
|
7689
|
+
* @type {string}
|
|
7690
|
+
* @memberof HostingV1NodeJsStoredBuildSettingsResource
|
|
7691
|
+
*/
|
|
7692
|
+
'root_directory': string | null;
|
|
7693
|
+
/**
|
|
7694
|
+
* Build output directory relative to the root directory
|
|
7695
|
+
* @type {string}
|
|
7696
|
+
* @memberof HostingV1NodeJsStoredBuildSettingsResource
|
|
7697
|
+
*/
|
|
7698
|
+
'output_directory': string | null;
|
|
7699
|
+
/**
|
|
7700
|
+
* The package.json script that builds the application
|
|
7701
|
+
* @type {string}
|
|
7702
|
+
* @memberof HostingV1NodeJsStoredBuildSettingsResource
|
|
7703
|
+
*/
|
|
7704
|
+
'build_script': string | null;
|
|
7705
|
+
/**
|
|
7706
|
+
* The main entry point file for the application
|
|
7707
|
+
* @type {string}
|
|
7708
|
+
* @memberof HostingV1NodeJsStoredBuildSettingsResource
|
|
7709
|
+
*/
|
|
7710
|
+
'entry_file': string | null;
|
|
7711
|
+
/**
|
|
7712
|
+
* Package manager used to install dependencies
|
|
7713
|
+
* @type {string}
|
|
7714
|
+
* @memberof HostingV1NodeJsStoredBuildSettingsResource
|
|
7715
|
+
*/
|
|
7716
|
+
'package_manager': HostingV1NodeJsStoredBuildSettingsResourcePackageManagerEnum | null;
|
|
7717
|
+
}
|
|
7718
|
+
export declare const HostingV1NodeJsStoredBuildSettingsResourceAppTypeEnum: {
|
|
7719
|
+
readonly CreateReactApp: "create-react-app";
|
|
7720
|
+
readonly Gatsby: "gatsby";
|
|
7721
|
+
readonly Vite: "vite";
|
|
7722
|
+
readonly Angular: "angular";
|
|
7723
|
+
readonly React: "react";
|
|
7724
|
+
readonly Vue: "vue";
|
|
7725
|
+
readonly Parcel: "parcel";
|
|
7726
|
+
readonly Next: "next";
|
|
7727
|
+
readonly Nuxt: "nuxt";
|
|
7728
|
+
readonly Nest: "nest";
|
|
7729
|
+
readonly Express: "express";
|
|
7730
|
+
readonly Fastify: "fastify";
|
|
7731
|
+
readonly Astro: "astro";
|
|
7732
|
+
readonly Svelte: "svelte";
|
|
7733
|
+
readonly SvelteKit: "svelte-kit";
|
|
7734
|
+
readonly Hono: "hono";
|
|
7735
|
+
readonly ReactRouter: "react-router";
|
|
7736
|
+
readonly Nitro: "nitro";
|
|
7737
|
+
readonly Other: "other";
|
|
7738
|
+
};
|
|
7739
|
+
export type HostingV1NodeJsStoredBuildSettingsResourceAppTypeEnum = typeof HostingV1NodeJsStoredBuildSettingsResourceAppTypeEnum[keyof typeof HostingV1NodeJsStoredBuildSettingsResourceAppTypeEnum];
|
|
7740
|
+
export declare const HostingV1NodeJsStoredBuildSettingsResourcePackageManagerEnum: {
|
|
7741
|
+
readonly Npm: "npm";
|
|
7742
|
+
readonly Yarn: "yarn";
|
|
7743
|
+
readonly Pnpm: "pnpm";
|
|
7744
|
+
};
|
|
7745
|
+
export type HostingV1NodeJsStoredBuildSettingsResourcePackageManagerEnum = typeof HostingV1NodeJsStoredBuildSettingsResourcePackageManagerEnum[keyof typeof HostingV1NodeJsStoredBuildSettingsResourcePackageManagerEnum];
|
|
7746
|
+
/**
|
|
7747
|
+
*
|
|
7748
|
+
* @export
|
|
7749
|
+
* @interface HostingV1NodeJsUpdateBuildSettingsRequest
|
|
7750
|
+
*/
|
|
7751
|
+
export interface HostingV1NodeJsUpdateBuildSettingsRequest {
|
|
7752
|
+
/**
|
|
7753
|
+
* Node.js major version
|
|
7754
|
+
* @type {number}
|
|
7755
|
+
* @memberof HostingV1NodeJsUpdateBuildSettingsRequest
|
|
7756
|
+
*/
|
|
7757
|
+
'node_version': HostingV1NodeJsUpdateBuildSettingsRequestNodeVersionEnum;
|
|
7758
|
+
/**
|
|
7759
|
+
* Node.js application framework. Set it explicitly when auto-detection picked the wrong one.
|
|
7760
|
+
* @type {string}
|
|
7761
|
+
* @memberof HostingV1NodeJsUpdateBuildSettingsRequest
|
|
7762
|
+
*/
|
|
7763
|
+
'app_type': HostingV1NodeJsUpdateBuildSettingsRequestAppTypeEnum | null;
|
|
7764
|
+
/**
|
|
7765
|
+
* Application root directory (where package.json is located) relative to public_html. Omit it, or send \".\", for public_html itself.
|
|
7766
|
+
* @type {string}
|
|
7767
|
+
* @memberof HostingV1NodeJsUpdateBuildSettingsRequest
|
|
7768
|
+
*/
|
|
7769
|
+
'root_directory': string | null;
|
|
7770
|
+
/**
|
|
7771
|
+
* Build output directory relative to the root directory
|
|
7772
|
+
* @type {string}
|
|
7773
|
+
* @memberof HostingV1NodeJsUpdateBuildSettingsRequest
|
|
7774
|
+
*/
|
|
7775
|
+
'output_directory': string | null;
|
|
7776
|
+
/**
|
|
7777
|
+
* The package.json script that builds the application
|
|
7778
|
+
* @type {string}
|
|
7779
|
+
* @memberof HostingV1NodeJsUpdateBuildSettingsRequest
|
|
7780
|
+
*/
|
|
7781
|
+
'build_script': string | null;
|
|
7782
|
+
/**
|
|
7783
|
+
* The main entry point file for the application (required for express, fastify, nest, nuxt and hono app types)
|
|
7784
|
+
* @type {string}
|
|
7785
|
+
* @memberof HostingV1NodeJsUpdateBuildSettingsRequest
|
|
7786
|
+
*/
|
|
7787
|
+
'entry_file': string | null;
|
|
7788
|
+
/**
|
|
7789
|
+
* Package manager used to install dependencies
|
|
7790
|
+
* @type {string}
|
|
7791
|
+
* @memberof HostingV1NodeJsUpdateBuildSettingsRequest
|
|
7792
|
+
*/
|
|
7793
|
+
'package_manager': HostingV1NodeJsUpdateBuildSettingsRequestPackageManagerEnum | null;
|
|
7794
|
+
}
|
|
7795
|
+
export declare const HostingV1NodeJsUpdateBuildSettingsRequestNodeVersionEnum: {
|
|
7796
|
+
readonly NUMBER_18: 18;
|
|
7797
|
+
readonly NUMBER_20: 20;
|
|
7798
|
+
readonly NUMBER_22: 22;
|
|
7799
|
+
readonly NUMBER_24: 24;
|
|
7800
|
+
};
|
|
7801
|
+
export type HostingV1NodeJsUpdateBuildSettingsRequestNodeVersionEnum = typeof HostingV1NodeJsUpdateBuildSettingsRequestNodeVersionEnum[keyof typeof HostingV1NodeJsUpdateBuildSettingsRequestNodeVersionEnum];
|
|
7802
|
+
export declare const HostingV1NodeJsUpdateBuildSettingsRequestAppTypeEnum: {
|
|
7803
|
+
readonly CreateReactApp: "create-react-app";
|
|
7804
|
+
readonly Gatsby: "gatsby";
|
|
7805
|
+
readonly Vite: "vite";
|
|
7806
|
+
readonly Angular: "angular";
|
|
7807
|
+
readonly React: "react";
|
|
7808
|
+
readonly Vue: "vue";
|
|
7809
|
+
readonly Parcel: "parcel";
|
|
7810
|
+
readonly Next: "next";
|
|
7811
|
+
readonly Nuxt: "nuxt";
|
|
7812
|
+
readonly Nest: "nest";
|
|
7813
|
+
readonly Express: "express";
|
|
7814
|
+
readonly Fastify: "fastify";
|
|
7815
|
+
readonly Astro: "astro";
|
|
7816
|
+
readonly Svelte: "svelte";
|
|
7817
|
+
readonly SvelteKit: "svelte-kit";
|
|
7818
|
+
readonly Hono: "hono";
|
|
7819
|
+
readonly ReactRouter: "react-router";
|
|
7820
|
+
readonly Nitro: "nitro";
|
|
7821
|
+
readonly Other: "other";
|
|
7822
|
+
};
|
|
7823
|
+
export type HostingV1NodeJsUpdateBuildSettingsRequestAppTypeEnum = typeof HostingV1NodeJsUpdateBuildSettingsRequestAppTypeEnum[keyof typeof HostingV1NodeJsUpdateBuildSettingsRequestAppTypeEnum];
|
|
7824
|
+
export declare const HostingV1NodeJsUpdateBuildSettingsRequestPackageManagerEnum: {
|
|
7825
|
+
readonly Npm: "npm";
|
|
7826
|
+
readonly Yarn: "yarn";
|
|
7827
|
+
readonly Pnpm: "pnpm";
|
|
7828
|
+
};
|
|
7829
|
+
export type HostingV1NodeJsUpdateBuildSettingsRequestPackageManagerEnum = typeof HostingV1NodeJsUpdateBuildSettingsRequestPackageManagerEnum[keyof typeof HostingV1NodeJsUpdateBuildSettingsRequestPackageManagerEnum];
|
|
7594
7830
|
/**
|
|
7595
7831
|
*
|
|
7596
7832
|
* @export
|
|
@@ -22484,6 +22720,25 @@ export type ListWebsiteFilesAndDirectoriesV1FileTypesEnum = typeof ListWebsiteFi
|
|
|
22484
22720
|
* @export
|
|
22485
22721
|
*/
|
|
22486
22722
|
export declare const HostingNodeJSApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22723
|
+
/**
|
|
22724
|
+
* Returns an AI analysis of why a build failed and how to fix it, based on the build logs, the project file list and package.json. Only builds in the `failed` state can be analysed; any other state returns 422. When no analysis could be produced both `analysis` and `solution` are null, in which case read `Get NodeJS build logs` instead. Each call runs the analysis again, so call it once per failed build and keep the result. Limited to 5 calls per minute per API client (429 above that).
|
|
22725
|
+
* @summary Analyse failed Node.js build
|
|
22726
|
+
* @param {string} username
|
|
22727
|
+
* @param {string} domain Domain name
|
|
22728
|
+
* @param {string} uuid Build UUID
|
|
22729
|
+
* @param {*} [options] Override http request option.
|
|
22730
|
+
* @throws {RequiredError}
|
|
22731
|
+
*/
|
|
22732
|
+
analyseFailedNodeJsBuildV1: (username: string, domain: string, uuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22733
|
+
/**
|
|
22734
|
+
* Empties the Node.js application\'s runtime log file. This cannot be undone, so confirm with the user before calling it. Returns success even when no log file exists yet. Use it before reproducing a problem so the next `Get Node.js runtime logs` call returns only fresh entries; start that call with `period` again instead of reusing a `from_line` from before the clear.
|
|
22735
|
+
* @summary Clear Node.js runtime logs
|
|
22736
|
+
* @param {string} username
|
|
22737
|
+
* @param {string} domain Domain name
|
|
22738
|
+
* @param {*} [options] Override http request option.
|
|
22739
|
+
* @throws {RequiredError}
|
|
22740
|
+
*/
|
|
22741
|
+
clearNodeJsRuntimeLogsV1: (username: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22487
22742
|
/**
|
|
22488
22743
|
* Retrieve logs from a specific Node.js build process. To stream live output while a build is running, poll this endpoint repeatedly while the build state is `running`, passing the previously returned `lines` count as `from_line` to fetch only new output since the last call. Log content may contain ANSI escape sequences (color codes).
|
|
22489
22744
|
* @summary Get NodeJS build logs
|
|
@@ -22495,6 +22750,16 @@ export declare const HostingNodeJSApiAxiosParamCreator: (configuration?: Configu
|
|
|
22495
22750
|
* @throws {RequiredError}
|
|
22496
22751
|
*/
|
|
22497
22752
|
getNodeJSBuildLogsV1: (username: string, domain: string, uuid: string, fromLine?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22753
|
+
/**
|
|
22754
|
+
* Returns one build by UUID: its state (`pending`, `running`, `completed`, `failed`), the options it ran with and timestamps. Poll this while a build is pending or running. When it is failed, read `Get NodeJS build logs` and `Analyse failed Node.js build` for the cause. Returns 404 when the UUID does not belong to a build of this website.
|
|
22755
|
+
* @summary Get Node.js build details
|
|
22756
|
+
* @param {string} username
|
|
22757
|
+
* @param {string} domain Domain name
|
|
22758
|
+
* @param {string} uuid Build UUID
|
|
22759
|
+
* @param {*} [options] Override http request option.
|
|
22760
|
+
* @throws {RequiredError}
|
|
22761
|
+
*/
|
|
22762
|
+
getNodeJsBuildDetailsV1: (username: string, domain: string, uuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22498
22763
|
/**
|
|
22499
22764
|
* Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website\'s file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first.
|
|
22500
22765
|
* @summary Get Node.js build settings from archive
|
|
@@ -22505,6 +22770,28 @@ export declare const HostingNodeJSApiAxiosParamCreator: (configuration?: Configu
|
|
|
22505
22770
|
* @throws {RequiredError}
|
|
22506
22771
|
*/
|
|
22507
22772
|
getNodeJsBuildSettingsFromArchiveV1: (username: string, domain: string, archivePath: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22773
|
+
/**
|
|
22774
|
+
* Returns the build settings stored for the website: framework (`app_type`), Node.js version, root and output directory, build script, entry file and package manager. Stored settings drive Git auto-deployment builds. A build started through the API uses the values sent in that request and saves them here only when no settings exist yet. Returns 404 until the first build or the first settings update stores them. Use this after a failed build to check whether the framework or the entry file were detected wrong, then fix them with the `Update Node.js build settings` endpoint.
|
|
22775
|
+
* @summary Get Node.js build settings
|
|
22776
|
+
* @param {string} username
|
|
22777
|
+
* @param {string} domain Domain name
|
|
22778
|
+
* @param {*} [options] Override http request option.
|
|
22779
|
+
* @throws {RequiredError}
|
|
22780
|
+
*/
|
|
22781
|
+
getNodeJsBuildSettingsV1: (username: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22782
|
+
/**
|
|
22783
|
+
* Returns the Node.js application\'s runtime console log entries, oldest first, each with timestamp, level and message. On the first call send `period` (`1h`, `1d`, `1w` or `1m`) and optionally `levels` and `limit` (1-5000, default 1000); when more entries match than `limit`, the newest are kept. To poll for new entries send `total_lines + 1` from the previous response as `from_line` and omit `period`; `period` and `from_line` cannot be combined. Lines that are not JSON with a timestamp, level and message are skipped, so `logs` may hold fewer than `limit` entries while `total_lines` counts every raw line. Entries with a timestamp before `last_deployed_at` belong to the previous deployment. Returns an empty `logs` list when the application has not written a log file yet.
|
|
22784
|
+
* @summary Get Node.js runtime logs
|
|
22785
|
+
* @param {string} username
|
|
22786
|
+
* @param {string} domain Domain name
|
|
22787
|
+
* @param {GetNodeJsRuntimeLogsV1PeriodEnum} [period] Time window for the first fetch. Required when `from_line` is not sent.
|
|
22788
|
+
* @param {number} [fromLine] 1-based line of the log file to start from. For polling send `total_lines + 1` from the previous response. Cannot be combined with `period`.
|
|
22789
|
+
* @param {number} [limit] Maximum number of log entries to return. When more entries match, the newest are kept.
|
|
22790
|
+
* @param {Array<GetNodeJsRuntimeLogsV1LevelsEnum>} [levels] Return only entries with these log levels, sent as a comma-separated list, e.g. ERROR,WARN. Matching runs on the raw log line, so entries written with numeric levels (for example by pino) are excluded while this filter is set.
|
|
22791
|
+
* @param {*} [options] Override http request option.
|
|
22792
|
+
* @throws {RequiredError}
|
|
22793
|
+
*/
|
|
22794
|
+
getNodeJsRuntimeLogsV1: (username: string, domain: string, period?: GetNodeJsRuntimeLogsV1PeriodEnum, fromLine?: number, limit?: number, levels?: Array<GetNodeJsRuntimeLogsV1LevelsEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22508
22795
|
/**
|
|
22509
22796
|
* Retrieve a paginated list of Node.js build processes for a specific website. Each build represents a single run of the Node.js build pipeline. Use the `states` query parameter to filter results by build state (pending, running, completed, failed). Use the `uuid` from a build to poll its output via the `Get Node.js Build Logs` endpoint.
|
|
22510
22797
|
* @summary List NodeJS builds
|
|
@@ -22575,12 +22862,41 @@ export declare const HostingNodeJSApiAxiosParamCreator: (configuration?: Configu
|
|
|
22575
22862
|
* @throws {RequiredError}
|
|
22576
22863
|
*/
|
|
22577
22864
|
startNodeJsBuildV1: (username: string, domain: string, hostingV1NodeJsStartBuildRequest: HostingV1NodeJsStartBuildRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22865
|
+
/**
|
|
22866
|
+
* Replaces the build settings stored for the website. Send the full set: `node_version` is required and every nullable field you omit is stored as null. Creates the settings when none exist yet. This does not start a build. Stored settings drive Git auto-deployment builds; a build started through the API uses the values sent in that request, so to rebuild with corrected settings call `Start Node.js build` with the same values. Typical fixes: a wrong `app_type` after auto-detection, or a missing `entry_file` for express, fastify, nest, nuxt and hono apps.
|
|
22867
|
+
* @summary Update Node.js build settings
|
|
22868
|
+
* @param {string} username
|
|
22869
|
+
* @param {string} domain Domain name
|
|
22870
|
+
* @param {HostingV1NodeJsUpdateBuildSettingsRequest} hostingV1NodeJsUpdateBuildSettingsRequest
|
|
22871
|
+
* @param {*} [options] Override http request option.
|
|
22872
|
+
* @throws {RequiredError}
|
|
22873
|
+
*/
|
|
22874
|
+
updateNodeJsBuildSettingsV1: (username: string, domain: string, hostingV1NodeJsUpdateBuildSettingsRequest: HostingV1NodeJsUpdateBuildSettingsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22578
22875
|
};
|
|
22579
22876
|
/**
|
|
22580
22877
|
* HostingNodeJSApi - functional programming interface
|
|
22581
22878
|
* @export
|
|
22582
22879
|
*/
|
|
22583
22880
|
export declare const HostingNodeJSApiFp: (configuration?: Configuration) => {
|
|
22881
|
+
/**
|
|
22882
|
+
* Returns an AI analysis of why a build failed and how to fix it, based on the build logs, the project file list and package.json. Only builds in the `failed` state can be analysed; any other state returns 422. When no analysis could be produced both `analysis` and `solution` are null, in which case read `Get NodeJS build logs` instead. Each call runs the analysis again, so call it once per failed build and keep the result. Limited to 5 calls per minute per API client (429 above that).
|
|
22883
|
+
* @summary Analyse failed Node.js build
|
|
22884
|
+
* @param {string} username
|
|
22885
|
+
* @param {string} domain Domain name
|
|
22886
|
+
* @param {string} uuid Build UUID
|
|
22887
|
+
* @param {*} [options] Override http request option.
|
|
22888
|
+
* @throws {RequiredError}
|
|
22889
|
+
*/
|
|
22890
|
+
analyseFailedNodeJsBuildV1(username: string, domain: string, uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1NodeJsBuildAnalysisResource>>;
|
|
22891
|
+
/**
|
|
22892
|
+
* Empties the Node.js application\'s runtime log file. This cannot be undone, so confirm with the user before calling it. Returns success even when no log file exists yet. Use it before reproducing a problem so the next `Get Node.js runtime logs` call returns only fresh entries; start that call with `period` again instead of reusing a `from_line` from before the clear.
|
|
22893
|
+
* @summary Clear Node.js runtime logs
|
|
22894
|
+
* @param {string} username
|
|
22895
|
+
* @param {string} domain Domain name
|
|
22896
|
+
* @param {*} [options] Override http request option.
|
|
22897
|
+
* @throws {RequiredError}
|
|
22898
|
+
*/
|
|
22899
|
+
clearNodeJsRuntimeLogsV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
22584
22900
|
/**
|
|
22585
22901
|
* Retrieve logs from a specific Node.js build process. To stream live output while a build is running, poll this endpoint repeatedly while the build state is `running`, passing the previously returned `lines` count as `from_line` to fetch only new output since the last call. Log content may contain ANSI escape sequences (color codes).
|
|
22586
22902
|
* @summary Get NodeJS build logs
|
|
@@ -22592,6 +22908,16 @@ export declare const HostingNodeJSApiFp: (configuration?: Configuration) => {
|
|
|
22592
22908
|
* @throws {RequiredError}
|
|
22593
22909
|
*/
|
|
22594
22910
|
getNodeJSBuildLogsV1(username: string, domain: string, uuid: string, fromLine?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1NodeJsBuildLogsResource>>;
|
|
22911
|
+
/**
|
|
22912
|
+
* Returns one build by UUID: its state (`pending`, `running`, `completed`, `failed`), the options it ran with and timestamps. Poll this while a build is pending or running. When it is failed, read `Get NodeJS build logs` and `Analyse failed Node.js build` for the cause. Returns 404 when the UUID does not belong to a build of this website.
|
|
22913
|
+
* @summary Get Node.js build details
|
|
22914
|
+
* @param {string} username
|
|
22915
|
+
* @param {string} domain Domain name
|
|
22916
|
+
* @param {string} uuid Build UUID
|
|
22917
|
+
* @param {*} [options] Override http request option.
|
|
22918
|
+
* @throws {RequiredError}
|
|
22919
|
+
*/
|
|
22920
|
+
getNodeJsBuildDetailsV1(username: string, domain: string, uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1NodeJsBuildResource>>;
|
|
22595
22921
|
/**
|
|
22596
22922
|
* Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website\'s file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first.
|
|
22597
22923
|
* @summary Get Node.js build settings from archive
|
|
@@ -22602,6 +22928,28 @@ export declare const HostingNodeJSApiFp: (configuration?: Configuration) => {
|
|
|
22602
22928
|
* @throws {RequiredError}
|
|
22603
22929
|
*/
|
|
22604
22930
|
getNodeJsBuildSettingsFromArchiveV1(username: string, domain: string, archivePath: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1NodeJsBuildSettingsResource>>;
|
|
22931
|
+
/**
|
|
22932
|
+
* Returns the build settings stored for the website: framework (`app_type`), Node.js version, root and output directory, build script, entry file and package manager. Stored settings drive Git auto-deployment builds. A build started through the API uses the values sent in that request and saves them here only when no settings exist yet. Returns 404 until the first build or the first settings update stores them. Use this after a failed build to check whether the framework or the entry file were detected wrong, then fix them with the `Update Node.js build settings` endpoint.
|
|
22933
|
+
* @summary Get Node.js build settings
|
|
22934
|
+
* @param {string} username
|
|
22935
|
+
* @param {string} domain Domain name
|
|
22936
|
+
* @param {*} [options] Override http request option.
|
|
22937
|
+
* @throws {RequiredError}
|
|
22938
|
+
*/
|
|
22939
|
+
getNodeJsBuildSettingsV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1NodeJsStoredBuildSettingsResource>>;
|
|
22940
|
+
/**
|
|
22941
|
+
* Returns the Node.js application\'s runtime console log entries, oldest first, each with timestamp, level and message. On the first call send `period` (`1h`, `1d`, `1w` or `1m`) and optionally `levels` and `limit` (1-5000, default 1000); when more entries match than `limit`, the newest are kept. To poll for new entries send `total_lines + 1` from the previous response as `from_line` and omit `period`; `period` and `from_line` cannot be combined. Lines that are not JSON with a timestamp, level and message are skipped, so `logs` may hold fewer than `limit` entries while `total_lines` counts every raw line. Entries with a timestamp before `last_deployed_at` belong to the previous deployment. Returns an empty `logs` list when the application has not written a log file yet.
|
|
22942
|
+
* @summary Get Node.js runtime logs
|
|
22943
|
+
* @param {string} username
|
|
22944
|
+
* @param {string} domain Domain name
|
|
22945
|
+
* @param {GetNodeJsRuntimeLogsV1PeriodEnum} [period] Time window for the first fetch. Required when `from_line` is not sent.
|
|
22946
|
+
* @param {number} [fromLine] 1-based line of the log file to start from. For polling send `total_lines + 1` from the previous response. Cannot be combined with `period`.
|
|
22947
|
+
* @param {number} [limit] Maximum number of log entries to return. When more entries match, the newest are kept.
|
|
22948
|
+
* @param {Array<GetNodeJsRuntimeLogsV1LevelsEnum>} [levels] Return only entries with these log levels, sent as a comma-separated list, e.g. ERROR,WARN. Matching runs on the raw log line, so entries written with numeric levels (for example by pino) are excluded while this filter is set.
|
|
22949
|
+
* @param {*} [options] Override http request option.
|
|
22950
|
+
* @throws {RequiredError}
|
|
22951
|
+
*/
|
|
22952
|
+
getNodeJsRuntimeLogsV1(username: string, domain: string, period?: GetNodeJsRuntimeLogsV1PeriodEnum, fromLine?: number, limit?: number, levels?: Array<GetNodeJsRuntimeLogsV1LevelsEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1NodeJsRuntimeLogsResource>>;
|
|
22605
22953
|
/**
|
|
22606
22954
|
* Retrieve a paginated list of Node.js build processes for a specific website. Each build represents a single run of the Node.js build pipeline. Use the `states` query parameter to filter results by build state (pending, running, completed, failed). Use the `uuid` from a build to poll its output via the `Get Node.js Build Logs` endpoint.
|
|
22607
22955
|
* @summary List NodeJS builds
|
|
@@ -22672,12 +23020,41 @@ export declare const HostingNodeJSApiFp: (configuration?: Configuration) => {
|
|
|
22672
23020
|
* @throws {RequiredError}
|
|
22673
23021
|
*/
|
|
22674
23022
|
startNodeJsBuildV1(username: string, domain: string, hostingV1NodeJsStartBuildRequest: HostingV1NodeJsStartBuildRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1NodeJsBuildResource>>;
|
|
23023
|
+
/**
|
|
23024
|
+
* Replaces the build settings stored for the website. Send the full set: `node_version` is required and every nullable field you omit is stored as null. Creates the settings when none exist yet. This does not start a build. Stored settings drive Git auto-deployment builds; a build started through the API uses the values sent in that request, so to rebuild with corrected settings call `Start Node.js build` with the same values. Typical fixes: a wrong `app_type` after auto-detection, or a missing `entry_file` for express, fastify, nest, nuxt and hono apps.
|
|
23025
|
+
* @summary Update Node.js build settings
|
|
23026
|
+
* @param {string} username
|
|
23027
|
+
* @param {string} domain Domain name
|
|
23028
|
+
* @param {HostingV1NodeJsUpdateBuildSettingsRequest} hostingV1NodeJsUpdateBuildSettingsRequest
|
|
23029
|
+
* @param {*} [options] Override http request option.
|
|
23030
|
+
* @throws {RequiredError}
|
|
23031
|
+
*/
|
|
23032
|
+
updateNodeJsBuildSettingsV1(username: string, domain: string, hostingV1NodeJsUpdateBuildSettingsRequest: HostingV1NodeJsUpdateBuildSettingsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1NodeJsStoredBuildSettingsResource>>;
|
|
22675
23033
|
};
|
|
22676
23034
|
/**
|
|
22677
23035
|
* HostingNodeJSApi - factory interface
|
|
22678
23036
|
* @export
|
|
22679
23037
|
*/
|
|
22680
23038
|
export declare const HostingNodeJSApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
23039
|
+
/**
|
|
23040
|
+
* Returns an AI analysis of why a build failed and how to fix it, based on the build logs, the project file list and package.json. Only builds in the `failed` state can be analysed; any other state returns 422. When no analysis could be produced both `analysis` and `solution` are null, in which case read `Get NodeJS build logs` instead. Each call runs the analysis again, so call it once per failed build and keep the result. Limited to 5 calls per minute per API client (429 above that).
|
|
23041
|
+
* @summary Analyse failed Node.js build
|
|
23042
|
+
* @param {string} username
|
|
23043
|
+
* @param {string} domain Domain name
|
|
23044
|
+
* @param {string} uuid Build UUID
|
|
23045
|
+
* @param {*} [options] Override http request option.
|
|
23046
|
+
* @throws {RequiredError}
|
|
23047
|
+
*/
|
|
23048
|
+
analyseFailedNodeJsBuildV1(username: string, domain: string, uuid: string, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1NodeJsBuildAnalysisResource>;
|
|
23049
|
+
/**
|
|
23050
|
+
* Empties the Node.js application\'s runtime log file. This cannot be undone, so confirm with the user before calling it. Returns success even when no log file exists yet. Use it before reproducing a problem so the next `Get Node.js runtime logs` call returns only fresh entries; start that call with `period` again instead of reusing a `from_line` from before the clear.
|
|
23051
|
+
* @summary Clear Node.js runtime logs
|
|
23052
|
+
* @param {string} username
|
|
23053
|
+
* @param {string} domain Domain name
|
|
23054
|
+
* @param {*} [options] Override http request option.
|
|
23055
|
+
* @throws {RequiredError}
|
|
23056
|
+
*/
|
|
23057
|
+
clearNodeJsRuntimeLogsV1(username: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
22681
23058
|
/**
|
|
22682
23059
|
* Retrieve logs from a specific Node.js build process. To stream live output while a build is running, poll this endpoint repeatedly while the build state is `running`, passing the previously returned `lines` count as `from_line` to fetch only new output since the last call. Log content may contain ANSI escape sequences (color codes).
|
|
22683
23060
|
* @summary Get NodeJS build logs
|
|
@@ -22689,6 +23066,16 @@ export declare const HostingNodeJSApiFactory: (configuration?: Configuration, ba
|
|
|
22689
23066
|
* @throws {RequiredError}
|
|
22690
23067
|
*/
|
|
22691
23068
|
getNodeJSBuildLogsV1(username: string, domain: string, uuid: string, fromLine?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1NodeJsBuildLogsResource>;
|
|
23069
|
+
/**
|
|
23070
|
+
* Returns one build by UUID: its state (`pending`, `running`, `completed`, `failed`), the options it ran with and timestamps. Poll this while a build is pending or running. When it is failed, read `Get NodeJS build logs` and `Analyse failed Node.js build` for the cause. Returns 404 when the UUID does not belong to a build of this website.
|
|
23071
|
+
* @summary Get Node.js build details
|
|
23072
|
+
* @param {string} username
|
|
23073
|
+
* @param {string} domain Domain name
|
|
23074
|
+
* @param {string} uuid Build UUID
|
|
23075
|
+
* @param {*} [options] Override http request option.
|
|
23076
|
+
* @throws {RequiredError}
|
|
23077
|
+
*/
|
|
23078
|
+
getNodeJsBuildDetailsV1(username: string, domain: string, uuid: string, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1NodeJsBuildResource>;
|
|
22692
23079
|
/**
|
|
22693
23080
|
* Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website\'s file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first.
|
|
22694
23081
|
* @summary Get Node.js build settings from archive
|
|
@@ -22699,6 +23086,28 @@ export declare const HostingNodeJSApiFactory: (configuration?: Configuration, ba
|
|
|
22699
23086
|
* @throws {RequiredError}
|
|
22700
23087
|
*/
|
|
22701
23088
|
getNodeJsBuildSettingsFromArchiveV1(username: string, domain: string, archivePath: string, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1NodeJsBuildSettingsResource>;
|
|
23089
|
+
/**
|
|
23090
|
+
* Returns the build settings stored for the website: framework (`app_type`), Node.js version, root and output directory, build script, entry file and package manager. Stored settings drive Git auto-deployment builds. A build started through the API uses the values sent in that request and saves them here only when no settings exist yet. Returns 404 until the first build or the first settings update stores them. Use this after a failed build to check whether the framework or the entry file were detected wrong, then fix them with the `Update Node.js build settings` endpoint.
|
|
23091
|
+
* @summary Get Node.js build settings
|
|
23092
|
+
* @param {string} username
|
|
23093
|
+
* @param {string} domain Domain name
|
|
23094
|
+
* @param {*} [options] Override http request option.
|
|
23095
|
+
* @throws {RequiredError}
|
|
23096
|
+
*/
|
|
23097
|
+
getNodeJsBuildSettingsV1(username: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1NodeJsStoredBuildSettingsResource>;
|
|
23098
|
+
/**
|
|
23099
|
+
* Returns the Node.js application\'s runtime console log entries, oldest first, each with timestamp, level and message. On the first call send `period` (`1h`, `1d`, `1w` or `1m`) and optionally `levels` and `limit` (1-5000, default 1000); when more entries match than `limit`, the newest are kept. To poll for new entries send `total_lines + 1` from the previous response as `from_line` and omit `period`; `period` and `from_line` cannot be combined. Lines that are not JSON with a timestamp, level and message are skipped, so `logs` may hold fewer than `limit` entries while `total_lines` counts every raw line. Entries with a timestamp before `last_deployed_at` belong to the previous deployment. Returns an empty `logs` list when the application has not written a log file yet.
|
|
23100
|
+
* @summary Get Node.js runtime logs
|
|
23101
|
+
* @param {string} username
|
|
23102
|
+
* @param {string} domain Domain name
|
|
23103
|
+
* @param {GetNodeJsRuntimeLogsV1PeriodEnum} [period] Time window for the first fetch. Required when `from_line` is not sent.
|
|
23104
|
+
* @param {number} [fromLine] 1-based line of the log file to start from. For polling send `total_lines + 1` from the previous response. Cannot be combined with `period`.
|
|
23105
|
+
* @param {number} [limit] Maximum number of log entries to return. When more entries match, the newest are kept.
|
|
23106
|
+
* @param {Array<GetNodeJsRuntimeLogsV1LevelsEnum>} [levels] Return only entries with these log levels, sent as a comma-separated list, e.g. ERROR,WARN. Matching runs on the raw log line, so entries written with numeric levels (for example by pino) are excluded while this filter is set.
|
|
23107
|
+
* @param {*} [options] Override http request option.
|
|
23108
|
+
* @throws {RequiredError}
|
|
23109
|
+
*/
|
|
23110
|
+
getNodeJsRuntimeLogsV1(username: string, domain: string, period?: GetNodeJsRuntimeLogsV1PeriodEnum, fromLine?: number, limit?: number, levels?: Array<GetNodeJsRuntimeLogsV1LevelsEnum>, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1NodeJsRuntimeLogsResource>;
|
|
22702
23111
|
/**
|
|
22703
23112
|
* Retrieve a paginated list of Node.js build processes for a specific website. Each build represents a single run of the Node.js build pipeline. Use the `states` query parameter to filter results by build state (pending, running, completed, failed). Use the `uuid` from a build to poll its output via the `Get Node.js Build Logs` endpoint.
|
|
22704
23113
|
* @summary List NodeJS builds
|
|
@@ -22769,6 +23178,16 @@ export declare const HostingNodeJSApiFactory: (configuration?: Configuration, ba
|
|
|
22769
23178
|
* @throws {RequiredError}
|
|
22770
23179
|
*/
|
|
22771
23180
|
startNodeJsBuildV1(username: string, domain: string, hostingV1NodeJsStartBuildRequest: HostingV1NodeJsStartBuildRequest, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1NodeJsBuildResource>;
|
|
23181
|
+
/**
|
|
23182
|
+
* Replaces the build settings stored for the website. Send the full set: `node_version` is required and every nullable field you omit is stored as null. Creates the settings when none exist yet. This does not start a build. Stored settings drive Git auto-deployment builds; a build started through the API uses the values sent in that request, so to rebuild with corrected settings call `Start Node.js build` with the same values. Typical fixes: a wrong `app_type` after auto-detection, or a missing `entry_file` for express, fastify, nest, nuxt and hono apps.
|
|
23183
|
+
* @summary Update Node.js build settings
|
|
23184
|
+
* @param {string} username
|
|
23185
|
+
* @param {string} domain Domain name
|
|
23186
|
+
* @param {HostingV1NodeJsUpdateBuildSettingsRequest} hostingV1NodeJsUpdateBuildSettingsRequest
|
|
23187
|
+
* @param {*} [options] Override http request option.
|
|
23188
|
+
* @throws {RequiredError}
|
|
23189
|
+
*/
|
|
23190
|
+
updateNodeJsBuildSettingsV1(username: string, domain: string, hostingV1NodeJsUpdateBuildSettingsRequest: HostingV1NodeJsUpdateBuildSettingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1NodeJsStoredBuildSettingsResource>;
|
|
22772
23191
|
};
|
|
22773
23192
|
/**
|
|
22774
23193
|
* HostingNodeJSApi - object-oriented interface
|
|
@@ -22777,6 +23196,27 @@ export declare const HostingNodeJSApiFactory: (configuration?: Configuration, ba
|
|
|
22777
23196
|
* @extends {BaseAPI}
|
|
22778
23197
|
*/
|
|
22779
23198
|
export declare class HostingNodeJSApi extends BaseAPI {
|
|
23199
|
+
/**
|
|
23200
|
+
* Returns an AI analysis of why a build failed and how to fix it, based on the build logs, the project file list and package.json. Only builds in the `failed` state can be analysed; any other state returns 422. When no analysis could be produced both `analysis` and `solution` are null, in which case read `Get NodeJS build logs` instead. Each call runs the analysis again, so call it once per failed build and keep the result. Limited to 5 calls per minute per API client (429 above that).
|
|
23201
|
+
* @summary Analyse failed Node.js build
|
|
23202
|
+
* @param {string} username
|
|
23203
|
+
* @param {string} domain Domain name
|
|
23204
|
+
* @param {string} uuid Build UUID
|
|
23205
|
+
* @param {*} [options] Override http request option.
|
|
23206
|
+
* @throws {RequiredError}
|
|
23207
|
+
* @memberof HostingNodeJSApi
|
|
23208
|
+
*/
|
|
23209
|
+
analyseFailedNodeJsBuildV1(username: string, domain: string, uuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1NodeJsBuildAnalysisResource, any, {}, any>>;
|
|
23210
|
+
/**
|
|
23211
|
+
* Empties the Node.js application\'s runtime log file. This cannot be undone, so confirm with the user before calling it. Returns success even when no log file exists yet. Use it before reproducing a problem so the next `Get Node.js runtime logs` call returns only fresh entries; start that call with `period` again instead of reusing a `from_line` from before the clear.
|
|
23212
|
+
* @summary Clear Node.js runtime logs
|
|
23213
|
+
* @param {string} username
|
|
23214
|
+
* @param {string} domain Domain name
|
|
23215
|
+
* @param {*} [options] Override http request option.
|
|
23216
|
+
* @throws {RequiredError}
|
|
23217
|
+
* @memberof HostingNodeJSApi
|
|
23218
|
+
*/
|
|
23219
|
+
clearNodeJsRuntimeLogsV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
22780
23220
|
/**
|
|
22781
23221
|
* Retrieve logs from a specific Node.js build process. To stream live output while a build is running, poll this endpoint repeatedly while the build state is `running`, passing the previously returned `lines` count as `from_line` to fetch only new output since the last call. Log content may contain ANSI escape sequences (color codes).
|
|
22782
23222
|
* @summary Get NodeJS build logs
|
|
@@ -22789,6 +23229,17 @@ export declare class HostingNodeJSApi extends BaseAPI {
|
|
|
22789
23229
|
* @memberof HostingNodeJSApi
|
|
22790
23230
|
*/
|
|
22791
23231
|
getNodeJSBuildLogsV1(username: string, domain: string, uuid: string, fromLine?: number | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1NodeJsBuildLogsResource, any, {}, any>>;
|
|
23232
|
+
/**
|
|
23233
|
+
* Returns one build by UUID: its state (`pending`, `running`, `completed`, `failed`), the options it ran with and timestamps. Poll this while a build is pending or running. When it is failed, read `Get NodeJS build logs` and `Analyse failed Node.js build` for the cause. Returns 404 when the UUID does not belong to a build of this website.
|
|
23234
|
+
* @summary Get Node.js build details
|
|
23235
|
+
* @param {string} username
|
|
23236
|
+
* @param {string} domain Domain name
|
|
23237
|
+
* @param {string} uuid Build UUID
|
|
23238
|
+
* @param {*} [options] Override http request option.
|
|
23239
|
+
* @throws {RequiredError}
|
|
23240
|
+
* @memberof HostingNodeJSApi
|
|
23241
|
+
*/
|
|
23242
|
+
getNodeJsBuildDetailsV1(username: string, domain: string, uuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1NodeJsBuildResource, any, {}, any>>;
|
|
22792
23243
|
/**
|
|
22793
23244
|
* Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website\'s file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first.
|
|
22794
23245
|
* @summary Get Node.js build settings from archive
|
|
@@ -22800,6 +23251,30 @@ export declare class HostingNodeJSApi extends BaseAPI {
|
|
|
22800
23251
|
* @memberof HostingNodeJSApi
|
|
22801
23252
|
*/
|
|
22802
23253
|
getNodeJsBuildSettingsFromArchiveV1(username: string, domain: string, archivePath: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1NodeJsBuildSettingsResource, any, {}, any>>;
|
|
23254
|
+
/**
|
|
23255
|
+
* Returns the build settings stored for the website: framework (`app_type`), Node.js version, root and output directory, build script, entry file and package manager. Stored settings drive Git auto-deployment builds. A build started through the API uses the values sent in that request and saves them here only when no settings exist yet. Returns 404 until the first build or the first settings update stores them. Use this after a failed build to check whether the framework or the entry file were detected wrong, then fix them with the `Update Node.js build settings` endpoint.
|
|
23256
|
+
* @summary Get Node.js build settings
|
|
23257
|
+
* @param {string} username
|
|
23258
|
+
* @param {string} domain Domain name
|
|
23259
|
+
* @param {*} [options] Override http request option.
|
|
23260
|
+
* @throws {RequiredError}
|
|
23261
|
+
* @memberof HostingNodeJSApi
|
|
23262
|
+
*/
|
|
23263
|
+
getNodeJsBuildSettingsV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1NodeJsStoredBuildSettingsResource, any, {}, any>>;
|
|
23264
|
+
/**
|
|
23265
|
+
* Returns the Node.js application\'s runtime console log entries, oldest first, each with timestamp, level and message. On the first call send `period` (`1h`, `1d`, `1w` or `1m`) and optionally `levels` and `limit` (1-5000, default 1000); when more entries match than `limit`, the newest are kept. To poll for new entries send `total_lines + 1` from the previous response as `from_line` and omit `period`; `period` and `from_line` cannot be combined. Lines that are not JSON with a timestamp, level and message are skipped, so `logs` may hold fewer than `limit` entries while `total_lines` counts every raw line. Entries with a timestamp before `last_deployed_at` belong to the previous deployment. Returns an empty `logs` list when the application has not written a log file yet.
|
|
23266
|
+
* @summary Get Node.js runtime logs
|
|
23267
|
+
* @param {string} username
|
|
23268
|
+
* @param {string} domain Domain name
|
|
23269
|
+
* @param {GetNodeJsRuntimeLogsV1PeriodEnum} [period] Time window for the first fetch. Required when `from_line` is not sent.
|
|
23270
|
+
* @param {number} [fromLine] 1-based line of the log file to start from. For polling send `total_lines + 1` from the previous response. Cannot be combined with `period`.
|
|
23271
|
+
* @param {number} [limit] Maximum number of log entries to return. When more entries match, the newest are kept.
|
|
23272
|
+
* @param {Array<GetNodeJsRuntimeLogsV1LevelsEnum>} [levels] Return only entries with these log levels, sent as a comma-separated list, e.g. ERROR,WARN. Matching runs on the raw log line, so entries written with numeric levels (for example by pino) are excluded while this filter is set.
|
|
23273
|
+
* @param {*} [options] Override http request option.
|
|
23274
|
+
* @throws {RequiredError}
|
|
23275
|
+
* @memberof HostingNodeJSApi
|
|
23276
|
+
*/
|
|
23277
|
+
getNodeJsRuntimeLogsV1(username: string, domain: string, period?: GetNodeJsRuntimeLogsV1PeriodEnum, fromLine?: number, limit?: number, levels?: Array<GetNodeJsRuntimeLogsV1LevelsEnum>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1NodeJsRuntimeLogsResource, any, {}, any>>;
|
|
22803
23278
|
/**
|
|
22804
23279
|
* Retrieve a paginated list of Node.js build processes for a specific website. Each build represents a single run of the Node.js build pipeline. Use the `states` query parameter to filter results by build state (pending, running, completed, failed). Use the `uuid` from a build to poll its output via the `Get Node.js Build Logs` endpoint.
|
|
22805
23280
|
* @summary List NodeJS builds
|
|
@@ -22877,7 +23352,40 @@ export declare class HostingNodeJSApi extends BaseAPI {
|
|
|
22877
23352
|
* @memberof HostingNodeJSApi
|
|
22878
23353
|
*/
|
|
22879
23354
|
startNodeJsBuildV1(username: string, domain: string, hostingV1NodeJsStartBuildRequest: HostingV1NodeJsStartBuildRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1NodeJsBuildResource, any, {}, any>>;
|
|
23355
|
+
/**
|
|
23356
|
+
* Replaces the build settings stored for the website. Send the full set: `node_version` is required and every nullable field you omit is stored as null. Creates the settings when none exist yet. This does not start a build. Stored settings drive Git auto-deployment builds; a build started through the API uses the values sent in that request, so to rebuild with corrected settings call `Start Node.js build` with the same values. Typical fixes: a wrong `app_type` after auto-detection, or a missing `entry_file` for express, fastify, nest, nuxt and hono apps.
|
|
23357
|
+
* @summary Update Node.js build settings
|
|
23358
|
+
* @param {string} username
|
|
23359
|
+
* @param {string} domain Domain name
|
|
23360
|
+
* @param {HostingV1NodeJsUpdateBuildSettingsRequest} hostingV1NodeJsUpdateBuildSettingsRequest
|
|
23361
|
+
* @param {*} [options] Override http request option.
|
|
23362
|
+
* @throws {RequiredError}
|
|
23363
|
+
* @memberof HostingNodeJSApi
|
|
23364
|
+
*/
|
|
23365
|
+
updateNodeJsBuildSettingsV1(username: string, domain: string, hostingV1NodeJsUpdateBuildSettingsRequest: HostingV1NodeJsUpdateBuildSettingsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1NodeJsStoredBuildSettingsResource, any, {}, any>>;
|
|
22880
23366
|
}
|
|
23367
|
+
/**
|
|
23368
|
+
* @export
|
|
23369
|
+
*/
|
|
23370
|
+
export declare const GetNodeJsRuntimeLogsV1PeriodEnum: {
|
|
23371
|
+
readonly _1h: "1h";
|
|
23372
|
+
readonly _1d: "1d";
|
|
23373
|
+
readonly _1w: "1w";
|
|
23374
|
+
readonly _1m: "1m";
|
|
23375
|
+
};
|
|
23376
|
+
export type GetNodeJsRuntimeLogsV1PeriodEnum = typeof GetNodeJsRuntimeLogsV1PeriodEnum[keyof typeof GetNodeJsRuntimeLogsV1PeriodEnum];
|
|
23377
|
+
/**
|
|
23378
|
+
* @export
|
|
23379
|
+
*/
|
|
23380
|
+
export declare const GetNodeJsRuntimeLogsV1LevelsEnum: {
|
|
23381
|
+
readonly Log: "LOG";
|
|
23382
|
+
readonly Error: "ERROR";
|
|
23383
|
+
readonly Warn: "WARN";
|
|
23384
|
+
readonly Info: "INFO";
|
|
23385
|
+
readonly Debug: "DEBUG";
|
|
23386
|
+
readonly Trace: "TRACE";
|
|
23387
|
+
};
|
|
23388
|
+
export type GetNodeJsRuntimeLogsV1LevelsEnum = typeof GetNodeJsRuntimeLogsV1LevelsEnum[keyof typeof GetNodeJsRuntimeLogsV1LevelsEnum];
|
|
22881
23389
|
/**
|
|
22882
23390
|
* @export
|
|
22883
23391
|
*/
|
|
@@ -28505,11 +29013,20 @@ export declare const VPSFirewallApiAxiosParamCreator: (configuration?: Configura
|
|
|
28505
29013
|
*/
|
|
28506
29014
|
replaceAllFirewallRulesInGroupV1: (firewallId: number, vPSV1FirewallRulesReplaceRequest: VPSV1FirewallRulesReplaceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
28507
29015
|
/**
|
|
28508
|
-
* Sync a firewall
|
|
29016
|
+
* Sync a firewall\'s rules to every virtual machine it\'s assigned to. Firewall can lose sync with a virtual machine if the firewall has new rules added, removed or updated. Use this endpoint to apply updated firewall rules to all VPS instances assigned to the firewall.
|
|
29017
|
+
* @summary Sync firewall to all assigned VMs
|
|
29018
|
+
* @param {number} firewallId Firewall ID
|
|
29019
|
+
* @param {*} [options] Override http request option.
|
|
29020
|
+
* @throws {RequiredError}
|
|
29021
|
+
*/
|
|
29022
|
+
syncFirewallToAllAssignedVMsV1: (firewallId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
29023
|
+
/**
|
|
29024
|
+
* Deprecated: use `POST /api/vps/v1/firewall/{firewallId}/sync` instead, which syncs the firewall to all virtual machines assigned to it. Sync a firewall for a specified virtual machine. Firewall can lose sync with virtual machine if the firewall has new rules added, removed or updated. Use this endpoint to apply updated firewall rules to VPS instances.
|
|
28509
29025
|
* @summary Sync firewall
|
|
28510
29026
|
* @param {number} firewallId Firewall ID
|
|
28511
29027
|
* @param {number} virtualMachineId Virtual Machine ID
|
|
28512
29028
|
* @param {*} [options] Override http request option.
|
|
29029
|
+
* @deprecated
|
|
28513
29030
|
* @throws {RequiredError}
|
|
28514
29031
|
*/
|
|
28515
29032
|
syncFirewallV1: (firewallId: number, virtualMachineId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -28607,11 +29124,20 @@ export declare const VPSFirewallApiFp: (configuration?: Configuration) => {
|
|
|
28607
29124
|
*/
|
|
28608
29125
|
replaceAllFirewallRulesInGroupV1(firewallId: number, vPSV1FirewallRulesReplaceRequest: VPSV1FirewallRulesReplaceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VPSV1FirewallFirewallResource>>;
|
|
28609
29126
|
/**
|
|
28610
|
-
* Sync a firewall
|
|
29127
|
+
* Sync a firewall\'s rules to every virtual machine it\'s assigned to. Firewall can lose sync with a virtual machine if the firewall has new rules added, removed or updated. Use this endpoint to apply updated firewall rules to all VPS instances assigned to the firewall.
|
|
29128
|
+
* @summary Sync firewall to all assigned VMs
|
|
29129
|
+
* @param {number} firewallId Firewall ID
|
|
29130
|
+
* @param {*} [options] Override http request option.
|
|
29131
|
+
* @throws {RequiredError}
|
|
29132
|
+
*/
|
|
29133
|
+
syncFirewallToAllAssignedVMsV1(firewallId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
29134
|
+
/**
|
|
29135
|
+
* Deprecated: use `POST /api/vps/v1/firewall/{firewallId}/sync` instead, which syncs the firewall to all virtual machines assigned to it. Sync a firewall for a specified virtual machine. Firewall can lose sync with virtual machine if the firewall has new rules added, removed or updated. Use this endpoint to apply updated firewall rules to VPS instances.
|
|
28611
29136
|
* @summary Sync firewall
|
|
28612
29137
|
* @param {number} firewallId Firewall ID
|
|
28613
29138
|
* @param {number} virtualMachineId Virtual Machine ID
|
|
28614
29139
|
* @param {*} [options] Override http request option.
|
|
29140
|
+
* @deprecated
|
|
28615
29141
|
* @throws {RequiredError}
|
|
28616
29142
|
*/
|
|
28617
29143
|
syncFirewallV1(firewallId: number, virtualMachineId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VPSV1ActionActionResource>>;
|
|
@@ -28709,11 +29235,20 @@ export declare const VPSFirewallApiFactory: (configuration?: Configuration, base
|
|
|
28709
29235
|
*/
|
|
28710
29236
|
replaceAllFirewallRulesInGroupV1(firewallId: number, vPSV1FirewallRulesReplaceRequest: VPSV1FirewallRulesReplaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<VPSV1FirewallFirewallResource>;
|
|
28711
29237
|
/**
|
|
28712
|
-
* Sync a firewall
|
|
29238
|
+
* Sync a firewall\'s rules to every virtual machine it\'s assigned to. Firewall can lose sync with a virtual machine if the firewall has new rules added, removed or updated. Use this endpoint to apply updated firewall rules to all VPS instances assigned to the firewall.
|
|
29239
|
+
* @summary Sync firewall to all assigned VMs
|
|
29240
|
+
* @param {number} firewallId Firewall ID
|
|
29241
|
+
* @param {*} [options] Override http request option.
|
|
29242
|
+
* @throws {RequiredError}
|
|
29243
|
+
*/
|
|
29244
|
+
syncFirewallToAllAssignedVMsV1(firewallId: number, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
29245
|
+
/**
|
|
29246
|
+
* Deprecated: use `POST /api/vps/v1/firewall/{firewallId}/sync` instead, which syncs the firewall to all virtual machines assigned to it. Sync a firewall for a specified virtual machine. Firewall can lose sync with virtual machine if the firewall has new rules added, removed or updated. Use this endpoint to apply updated firewall rules to VPS instances.
|
|
28713
29247
|
* @summary Sync firewall
|
|
28714
29248
|
* @param {number} firewallId Firewall ID
|
|
28715
29249
|
* @param {number} virtualMachineId Virtual Machine ID
|
|
28716
29250
|
* @param {*} [options] Override http request option.
|
|
29251
|
+
* @deprecated
|
|
28717
29252
|
* @throws {RequiredError}
|
|
28718
29253
|
*/
|
|
28719
29254
|
syncFirewallV1(firewallId: number, virtualMachineId: number, options?: RawAxiosRequestConfig): AxiosPromise<VPSV1ActionActionResource>;
|
|
@@ -28822,11 +29357,21 @@ export declare class VPSFirewallApi extends BaseAPI {
|
|
|
28822
29357
|
*/
|
|
28823
29358
|
replaceAllFirewallRulesInGroupV1(firewallId: number, vPSV1FirewallRulesReplaceRequest: VPSV1FirewallRulesReplaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VPSV1FirewallFirewallResource, any, {}, any>>;
|
|
28824
29359
|
/**
|
|
28825
|
-
* Sync a firewall
|
|
29360
|
+
* Sync a firewall\'s rules to every virtual machine it\'s assigned to. Firewall can lose sync with a virtual machine if the firewall has new rules added, removed or updated. Use this endpoint to apply updated firewall rules to all VPS instances assigned to the firewall.
|
|
29361
|
+
* @summary Sync firewall to all assigned VMs
|
|
29362
|
+
* @param {number} firewallId Firewall ID
|
|
29363
|
+
* @param {*} [options] Override http request option.
|
|
29364
|
+
* @throws {RequiredError}
|
|
29365
|
+
* @memberof VPSFirewallApi
|
|
29366
|
+
*/
|
|
29367
|
+
syncFirewallToAllAssignedVMsV1(firewallId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
29368
|
+
/**
|
|
29369
|
+
* Deprecated: use `POST /api/vps/v1/firewall/{firewallId}/sync` instead, which syncs the firewall to all virtual machines assigned to it. Sync a firewall for a specified virtual machine. Firewall can lose sync with virtual machine if the firewall has new rules added, removed or updated. Use this endpoint to apply updated firewall rules to VPS instances.
|
|
28826
29370
|
* @summary Sync firewall
|
|
28827
29371
|
* @param {number} firewallId Firewall ID
|
|
28828
29372
|
* @param {number} virtualMachineId Virtual Machine ID
|
|
28829
29373
|
* @param {*} [options] Override http request option.
|
|
29374
|
+
* @deprecated
|
|
28830
29375
|
* @throws {RequiredError}
|
|
28831
29376
|
* @memberof VPSFirewallApi
|
|
28832
29377
|
*/
|