hostinger-api-sdk 1.38.0 → 1.39.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api.ts +1019 -5
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +646 -5
- package/dist/api.js +712 -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 +646 -5
- package/dist/esm/api.js +702 -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/AgencyHostingFilesApi.md +54 -0
- package/docs/HostingFilesApi.md +56 -0
- package/docs/HostingNodeJSApi.md +124 -1
- package/docs/HostingV1FilesGenerateUploadUrlRequest.md +22 -0
- package/docs/HostingV1FilesUploadUrlResource.md +24 -0
- package/docs/HostingV1NodeJsBuildSettingsResource.md +34 -0
- package/docs/HostingV1NodeJsGetBuildSettingsRequest.md +20 -0
- package/docs/HostingV1NodeJsStartBuildRequest.md +36 -0
- package/docs/HostingV1NodeJsStartBuildRequestSourceOptions.md +21 -0
- package/docs/HostingV1WebsitesDeployArchiveRequest.md +20 -0
- package/docs/HostingWebsitesApi.md +62 -0
- package/docs/WordPressInstallationsApi.md +62 -0
- package/docs/WordPressPluginsApi.md +62 -0
- package/docs/WordPressThemesApi.md +62 -0
- package/docs/WordPressV1InstallationsImportWordPressRequest.md +22 -0
- package/docs/WordPressV1PluginsDeployPluginRequest.md +22 -0
- package/docs/WordPressV1ThemesDeployThemeRequest.md +24 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/base.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.41.0
|
|
5
5
|
*
|
|
6
6
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
7
7
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
package/dist/esm/base.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.41.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.41.0
|
|
5
5
|
*
|
|
6
6
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
7
7
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
package/dist/esm/common.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.41.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.41.0
|
|
5
5
|
*
|
|
6
6
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
7
7
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.41.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -13,7 +13,7 @@ export class Configuration {
|
|
|
13
13
|
var _a;
|
|
14
14
|
this.accessToken = param.accessToken;
|
|
15
15
|
this.basePath = param.basePath;
|
|
16
|
-
this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({ 'User-Agent': "hostinger-typescript-sdk/1.
|
|
16
|
+
this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({ 'User-Agent': "hostinger-typescript-sdk/1.39.0" }, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
|
|
17
17
|
this.formDataCtor = param.formDataCtor;
|
|
18
18
|
}
|
|
19
19
|
/**
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.41.0
|
|
5
5
|
*
|
|
6
6
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
7
7
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
package/dist/esm/index.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.41.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.41.0
|
|
5
5
|
*
|
|
6
6
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
7
7
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
package/dist/index.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* Hostinger API
|
|
6
6
|
*
|
|
7
|
-
* API Version: 1.
|
|
7
|
+
* API Version: 1.41.0
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
10
10
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -4,8 +4,62 @@ All URIs are relative to *https://developers.hostinger.com*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**generateUploadURLV1**](#generateuploadurlv1) | **POST** /api/agency-hosting/v1/websites/{website_uid}/files/upload-urls | Generate upload URL|
|
|
7
8
|
|[**importWebsiteFromArchiveV1**](#importwebsitefromarchivev1) | **POST** /api/agency-hosting/v1/websites/{website_uid}/files/import-archive | Import website from archive|
|
|
8
9
|
|
|
10
|
+
# **generateUploadURLV1**
|
|
11
|
+
> AgencyHostingV1FilesUploadUrlResource generateUploadURLV1()
|
|
12
|
+
|
|
13
|
+
Generate a file browser upload URL with authentication credentials for uploading files to an Agency Plan website\'s file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s file storage via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside the website\'s file storage, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
14
|
+
|
|
15
|
+
### Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import {
|
|
19
|
+
AgencyHostingFilesApi,
|
|
20
|
+
Configuration
|
|
21
|
+
} from 'hostinger-api-sdk';
|
|
22
|
+
|
|
23
|
+
const configuration = new Configuration();
|
|
24
|
+
const apiInstance = new AgencyHostingFilesApi(configuration);
|
|
25
|
+
|
|
26
|
+
let websiteUid: string; //Agency Plan website UID (default to undefined)
|
|
27
|
+
|
|
28
|
+
const { status, data } = await apiInstance.generateUploadURLV1(
|
|
29
|
+
websiteUid
|
|
30
|
+
);
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Parameters
|
|
34
|
+
|
|
35
|
+
|Name | Type | Description | Notes|
|
|
36
|
+
|------------- | ------------- | ------------- | -------------|
|
|
37
|
+
| **websiteUid** | [**string**] | Agency Plan website UID | defaults to undefined|
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
### Return type
|
|
41
|
+
|
|
42
|
+
**AgencyHostingV1FilesUploadUrlResource**
|
|
43
|
+
|
|
44
|
+
### Authorization
|
|
45
|
+
|
|
46
|
+
[apiToken](../README.md#apiToken)
|
|
47
|
+
|
|
48
|
+
### HTTP request headers
|
|
49
|
+
|
|
50
|
+
- **Content-Type**: Not defined
|
|
51
|
+
- **Accept**: application/json
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
### HTTP response details
|
|
55
|
+
| Status code | Description | Response headers |
|
|
56
|
+
|-------------|-------------|------------------|
|
|
57
|
+
|**200** | Success response | - |
|
|
58
|
+
|**401** | Unauthenticated response | - |
|
|
59
|
+
|**500** | Error response | - |
|
|
60
|
+
|
|
61
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
62
|
+
|
|
9
63
|
# **importWebsiteFromArchiveV1**
|
|
10
64
|
> CommonSuccessEmptyResource importWebsiteFromArchiveV1(agencyHostingV1FilesImportArchiveRequest)
|
|
11
65
|
|
package/docs/HostingFilesApi.md
CHANGED
|
@@ -4,9 +4,65 @@ All URIs are relative to *https://developers.hostinger.com*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**generateUploadURLV1**](#generateuploadurlv1) | **POST** /api/hosting/v1/files/upload-urls | Generate upload URL|
|
|
7
8
|
|[**getWebsiteFileContentV1**](#getwebsitefilecontentv1) | **GET** /api/hosting/v1/accounts/{username}/domains/{domain}/files/content | Get website file content|
|
|
8
9
|
|[**listWebsiteFilesAndDirectoriesV1**](#listwebsitefilesanddirectoriesv1) | **GET** /api/hosting/v1/accounts/{username}/domains/{domain}/files | List website files and directories|
|
|
9
10
|
|
|
11
|
+
# **generateUploadURLV1**
|
|
12
|
+
> HostingV1FilesUploadUrlResource generateUploadURLV1(hostingV1FilesGenerateUploadUrlRequest)
|
|
13
|
+
|
|
14
|
+
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 ```
|
|
15
|
+
|
|
16
|
+
### Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import {
|
|
20
|
+
HostingFilesApi,
|
|
21
|
+
Configuration,
|
|
22
|
+
HostingV1FilesGenerateUploadUrlRequest
|
|
23
|
+
} from 'hostinger-api-sdk';
|
|
24
|
+
|
|
25
|
+
const configuration = new Configuration();
|
|
26
|
+
const apiInstance = new HostingFilesApi(configuration);
|
|
27
|
+
|
|
28
|
+
let hostingV1FilesGenerateUploadUrlRequest: HostingV1FilesGenerateUploadUrlRequest; //
|
|
29
|
+
|
|
30
|
+
const { status, data } = await apiInstance.generateUploadURLV1(
|
|
31
|
+
hostingV1FilesGenerateUploadUrlRequest
|
|
32
|
+
);
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Parameters
|
|
36
|
+
|
|
37
|
+
|Name | Type | Description | Notes|
|
|
38
|
+
|------------- | ------------- | ------------- | -------------|
|
|
39
|
+
| **hostingV1FilesGenerateUploadUrlRequest** | **HostingV1FilesGenerateUploadUrlRequest**| | |
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
### Return type
|
|
43
|
+
|
|
44
|
+
**HostingV1FilesUploadUrlResource**
|
|
45
|
+
|
|
46
|
+
### Authorization
|
|
47
|
+
|
|
48
|
+
[apiToken](../README.md#apiToken)
|
|
49
|
+
|
|
50
|
+
### HTTP request headers
|
|
51
|
+
|
|
52
|
+
- **Content-Type**: application/json
|
|
53
|
+
- **Accept**: application/json
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
### HTTP response details
|
|
57
|
+
| Status code | Description | Response headers |
|
|
58
|
+
|-------------|-------------|------------------|
|
|
59
|
+
|**200** | Success response | - |
|
|
60
|
+
|**422** | Validation error response | - |
|
|
61
|
+
|**401** | Unauthenticated response | - |
|
|
62
|
+
|**500** | Error response | - |
|
|
63
|
+
|
|
64
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
65
|
+
|
|
10
66
|
# **getWebsiteFileContentV1**
|
|
11
67
|
> HostingV1FilesFileContentResource getWebsiteFileContentV1()
|
|
12
68
|
|
package/docs/HostingNodeJSApi.md
CHANGED
|
@@ -6,15 +6,17 @@ All URIs are relative to *https://developers.hostinger.com*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**createNodeJSBuildFromArchiveV1**](#createnodejsbuildfromarchivev1) | **POST** /api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/from-archive | Create NodeJS build from archive|
|
|
8
8
|
|[**getNodeJSBuildLogsV1**](#getnodejsbuildlogsv1) | **GET** /api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/{uuid}/logs | Get NodeJS build logs|
|
|
9
|
+
|[**getNodeJsBuildSettingsFromArchiveV1**](#getnodejsbuildsettingsfromarchivev1) | **GET** /api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/settings/from-archive | Get Node.js build settings from archive|
|
|
9
10
|
|[**listNodeJSBuildsV1**](#listnodejsbuildsv1) | **GET** /api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds | List NodeJS builds|
|
|
10
11
|
|[**listNodeJsVulnerabilitiesV1**](#listnodejsvulnerabilitiesv1) | **GET** /api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/vulnerabilities | List Node.js vulnerabilities|
|
|
11
12
|
|[**patchNodeJsVulnerabilitiesV1**](#patchnodejsvulnerabilitiesv1) | **POST** /api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/vulnerabilities/patch | Patch Node.js vulnerabilities|
|
|
12
13
|
|[**restartNodeJsApplicationV1**](#restartnodejsapplicationv1) | **POST** /api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/server/restart | Restart Node.js application|
|
|
14
|
+
|[**startNodeJsBuildV1**](#startnodejsbuildv1) | **POST** /api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds | Start Node.js build|
|
|
13
15
|
|
|
14
16
|
# **createNodeJSBuildFromArchiveV1**
|
|
15
17
|
> HostingV1NodeJsBuildResource createNodeJSBuildFromArchiveV1(hostingV1NodeJsCreateFromArchiveRequest)
|
|
16
18
|
|
|
17
|
-
Upload a project archive, auto-detect build settings, and immediately start a Node.js build. This is the recommended single-step approach for deploying a Node.js application. The archive is uploaded to the website\'s file storage, build settings are auto-detected from the package.json inside the archive, and the build process starts automatically. Optional override fields take precedence over auto-detected values. Maximum archive size is 50MB. Before archiving, exclude `node_modules/` and any build output directories (e.g. `dist/`, `.next/`, `build/`) — they are not needed because the build process runs the install step automatically, and including them unnecessarily increases the archive size. This also helps keep the archive well under the 50MB limit. Example (zip): ``` zip -r archive.zip . --exclude \"node_modules/_*\" --exclude \"dist/_*\" ``` The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
19
|
+
Upload a project archive, auto-detect build settings, and immediately start a Node.js build. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This is the recommended single-step approach for deploying a Node.js application. The archive is uploaded to the website\'s file storage, build settings are auto-detected from the package.json inside the archive, and the build process starts automatically. Optional override fields take precedence over auto-detected values. Maximum archive size is 50MB. Before archiving, exclude `node_modules/` and any build output directories (e.g. `dist/`, `.next/`, `build/`) — they are not needed because the build process runs the install step automatically, and including them unnecessarily increases the archive size. This also helps keep the archive well under the 50MB limit. Example (zip): ``` zip -r archive.zip . --exclude \"node_modules/_*\" --exclude \"dist/_*\" ``` The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
18
20
|
|
|
19
21
|
### Example
|
|
20
22
|
|
|
@@ -125,6 +127,66 @@ const { status, data } = await apiInstance.getNodeJSBuildLogsV1(
|
|
|
125
127
|
- **Accept**: application/json
|
|
126
128
|
|
|
127
129
|
|
|
130
|
+
### HTTP response details
|
|
131
|
+
| Status code | Description | Response headers |
|
|
132
|
+
|-------------|-------------|------------------|
|
|
133
|
+
|**200** | Success response | - |
|
|
134
|
+
|**422** | Validation error response | - |
|
|
135
|
+
|**401** | Unauthenticated response | - |
|
|
136
|
+
|**500** | Error response | - |
|
|
137
|
+
|
|
138
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
139
|
+
|
|
140
|
+
# **getNodeJsBuildSettingsFromArchiveV1**
|
|
141
|
+
> HostingV1NodeJsBuildSettingsResource getNodeJsBuildSettingsFromArchiveV1()
|
|
142
|
+
|
|
143
|
+
Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website\'s file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To upload an archive and start a build in one step without inspecting settings first, use the `Create Node.js Build from Archive` endpoint instead.
|
|
144
|
+
|
|
145
|
+
### Example
|
|
146
|
+
|
|
147
|
+
```typescript
|
|
148
|
+
import {
|
|
149
|
+
HostingNodeJSApi,
|
|
150
|
+
Configuration
|
|
151
|
+
} from 'hostinger-api-sdk';
|
|
152
|
+
|
|
153
|
+
const configuration = new Configuration();
|
|
154
|
+
const apiInstance = new HostingNodeJSApi(configuration);
|
|
155
|
+
|
|
156
|
+
let username: string; // (default to undefined)
|
|
157
|
+
let domain: string; //Domain name (default to undefined)
|
|
158
|
+
let archivePath: string; //The path to the archive file relative to the document root of the vhost (default to undefined)
|
|
159
|
+
|
|
160
|
+
const { status, data } = await apiInstance.getNodeJsBuildSettingsFromArchiveV1(
|
|
161
|
+
username,
|
|
162
|
+
domain,
|
|
163
|
+
archivePath
|
|
164
|
+
);
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
### Parameters
|
|
168
|
+
|
|
169
|
+
|Name | Type | Description | Notes|
|
|
170
|
+
|------------- | ------------- | ------------- | -------------|
|
|
171
|
+
| **username** | [**string**] | | defaults to undefined|
|
|
172
|
+
| **domain** | [**string**] | Domain name | defaults to undefined|
|
|
173
|
+
| **archivePath** | [**string**] | The path to the archive file relative to the document root of the vhost | defaults to undefined|
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
### Return type
|
|
177
|
+
|
|
178
|
+
**HostingV1NodeJsBuildSettingsResource**
|
|
179
|
+
|
|
180
|
+
### Authorization
|
|
181
|
+
|
|
182
|
+
[apiToken](../README.md#apiToken)
|
|
183
|
+
|
|
184
|
+
### HTTP request headers
|
|
185
|
+
|
|
186
|
+
- **Content-Type**: Not defined
|
|
187
|
+
- **Accept**: application/json
|
|
188
|
+
|
|
189
|
+
|
|
128
190
|
### HTTP response details
|
|
129
191
|
| Status code | Description | Response headers |
|
|
130
192
|
|-------------|-------------|------------------|
|
|
@@ -376,3 +438,64 @@ const { status, data } = await apiInstance.restartNodeJsApplicationV1(
|
|
|
376
438
|
|
|
377
439
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
378
440
|
|
|
441
|
+
# **startNodeJsBuildV1**
|
|
442
|
+
> HostingV1NodeJsBuildResource startNodeJsBuildV1(hostingV1NodeJsStartBuildRequest)
|
|
443
|
+
|
|
444
|
+
Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. The `source_type` must be `archive` and `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint. To upload an archive and start a build in one step, use the `Create Node.js Build from Archive` endpoint instead. The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
445
|
+
|
|
446
|
+
### Example
|
|
447
|
+
|
|
448
|
+
```typescript
|
|
449
|
+
import {
|
|
450
|
+
HostingNodeJSApi,
|
|
451
|
+
Configuration,
|
|
452
|
+
HostingV1NodeJsStartBuildRequest
|
|
453
|
+
} from 'hostinger-api-sdk';
|
|
454
|
+
|
|
455
|
+
const configuration = new Configuration();
|
|
456
|
+
const apiInstance = new HostingNodeJSApi(configuration);
|
|
457
|
+
|
|
458
|
+
let username: string; // (default to undefined)
|
|
459
|
+
let domain: string; //Domain name (default to undefined)
|
|
460
|
+
let hostingV1NodeJsStartBuildRequest: HostingV1NodeJsStartBuildRequest; //
|
|
461
|
+
|
|
462
|
+
const { status, data } = await apiInstance.startNodeJsBuildV1(
|
|
463
|
+
username,
|
|
464
|
+
domain,
|
|
465
|
+
hostingV1NodeJsStartBuildRequest
|
|
466
|
+
);
|
|
467
|
+
```
|
|
468
|
+
|
|
469
|
+
### Parameters
|
|
470
|
+
|
|
471
|
+
|Name | Type | Description | Notes|
|
|
472
|
+
|------------- | ------------- | ------------- | -------------|
|
|
473
|
+
| **hostingV1NodeJsStartBuildRequest** | **HostingV1NodeJsStartBuildRequest**| | |
|
|
474
|
+
| **username** | [**string**] | | defaults to undefined|
|
|
475
|
+
| **domain** | [**string**] | Domain name | defaults to undefined|
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
### Return type
|
|
479
|
+
|
|
480
|
+
**HostingV1NodeJsBuildResource**
|
|
481
|
+
|
|
482
|
+
### Authorization
|
|
483
|
+
|
|
484
|
+
[apiToken](../README.md#apiToken)
|
|
485
|
+
|
|
486
|
+
### HTTP request headers
|
|
487
|
+
|
|
488
|
+
- **Content-Type**: application/json
|
|
489
|
+
- **Accept**: application/json
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
### HTTP response details
|
|
493
|
+
| Status code | Description | Response headers |
|
|
494
|
+
|-------------|-------------|------------------|
|
|
495
|
+
|**200** | Success response | - |
|
|
496
|
+
|**422** | Validation error response | - |
|
|
497
|
+
|**401** | Unauthenticated response | - |
|
|
498
|
+
|**500** | Error response | - |
|
|
499
|
+
|
|
500
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
501
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# HostingV1FilesGenerateUploadUrlRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**username** | **string** | Account username | [default to undefined]
|
|
9
|
+
**domain** | **string** | Website domain | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { HostingV1FilesGenerateUploadUrlRequest } from 'hostinger-api-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: HostingV1FilesGenerateUploadUrlRequest = {
|
|
17
|
+
username,
|
|
18
|
+
domain,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# HostingV1FilesUploadUrlResource
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**url** | **string** | The TUS upload endpoint URL to send upload requests to | [default to undefined]
|
|
9
|
+
**auth_key** | **string** | Authentication token to pass as the `X-Auth` header in TUS upload requests | [default to undefined]
|
|
10
|
+
**rest_auth_key** | **string** | Authentication token to pass as the `X-Auth-Rest` header in TUS upload requests | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { HostingV1FilesUploadUrlResource } from 'hostinger-api-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: HostingV1FilesUploadUrlResource = {
|
|
18
|
+
url,
|
|
19
|
+
auth_key,
|
|
20
|
+
rest_auth_key,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# HostingV1NodeJsBuildSettingsResource
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**app_type** | **string** | Node.js application type | [default to undefined]
|
|
9
|
+
**node_version** | **number** | Node.js version | [default to undefined]
|
|
10
|
+
**root_directory** | **string** | Application root directory | [default to undefined]
|
|
11
|
+
**output_directory** | **string** | Build output directory | [default to undefined]
|
|
12
|
+
**build_script** | **string** | The npm script to run to build the application | [default to undefined]
|
|
13
|
+
**entry_file** | **string** | The main entry point file for the application | [default to undefined]
|
|
14
|
+
**package_manager** | **string** | Package manager | [default to undefined]
|
|
15
|
+
**available_scripts** | **Array<string>** | The scripts configured in the package.json file | [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { HostingV1NodeJsBuildSettingsResource } from 'hostinger-api-sdk';
|
|
21
|
+
|
|
22
|
+
const instance: HostingV1NodeJsBuildSettingsResource = {
|
|
23
|
+
app_type,
|
|
24
|
+
node_version,
|
|
25
|
+
root_directory,
|
|
26
|
+
output_directory,
|
|
27
|
+
build_script,
|
|
28
|
+
entry_file,
|
|
29
|
+
package_manager,
|
|
30
|
+
available_scripts,
|
|
31
|
+
};
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# HostingV1NodeJsGetBuildSettingsRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**archive_path** | **string** | The path to the archive file relative to the document root of the vhost | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { HostingV1NodeJsGetBuildSettingsRequest } from 'hostinger-api-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: HostingV1NodeJsGetBuildSettingsRequest = {
|
|
16
|
+
archive_path,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# HostingV1NodeJsStartBuildRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**node_version** | **number** | Node.js version | [default to undefined]
|
|
9
|
+
**app_type** | **string** | Node.js application type | [default to undefined]
|
|
10
|
+
**root_directory** | **string** | Application root directory (where package.json is located) relative to public_html | [default to undefined]
|
|
11
|
+
**output_directory** | **string** | Build output directory relative to the root directory | [default to undefined]
|
|
12
|
+
**build_script** | **string** | Build script that will be ran to build the application | [default to undefined]
|
|
13
|
+
**entry_file** | **string** | The main entry point file for the application | [optional] [default to undefined]
|
|
14
|
+
**package_manager** | **string** | Package manager | [optional] [default to undefined]
|
|
15
|
+
**source_type** | **string** | The source type of the files | [default to undefined]
|
|
16
|
+
**source_options** | [**HostingV1NodeJsStartBuildRequestSourceOptions**](HostingV1NodeJsStartBuildRequestSourceOptions.md) | | [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { HostingV1NodeJsStartBuildRequest } from 'hostinger-api-sdk';
|
|
22
|
+
|
|
23
|
+
const instance: HostingV1NodeJsStartBuildRequest = {
|
|
24
|
+
node_version,
|
|
25
|
+
app_type,
|
|
26
|
+
root_directory,
|
|
27
|
+
output_directory,
|
|
28
|
+
build_script,
|
|
29
|
+
entry_file,
|
|
30
|
+
package_manager,
|
|
31
|
+
source_type,
|
|
32
|
+
source_options,
|
|
33
|
+
};
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# HostingV1NodeJsStartBuildRequestSourceOptions
|
|
2
|
+
|
|
3
|
+
Source-specific options
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**archive_path** | **string** | The path to the archive file relative to the document root of the vhost (required if source is \"archive\") | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { HostingV1NodeJsStartBuildRequestSourceOptions } from 'hostinger-api-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: HostingV1NodeJsStartBuildRequestSourceOptions = {
|
|
17
|
+
archive_path,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# HostingV1WebsitesDeployArchiveRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**archive_path** | **string** | Relative path to the archive file from website root directory | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { HostingV1WebsitesDeployArchiveRequest } from 'hostinger-api-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: HostingV1WebsitesDeployArchiveRequest = {
|
|
16
|
+
archive_path,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -6,6 +6,7 @@ All URIs are relative to *https://developers.hostinger.com*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**createWebsiteV1**](#createwebsitev1) | **POST** /api/hosting/v1/websites | Create website|
|
|
8
8
|
|[**deleteWebsiteV1**](#deletewebsitev1) | **DELETE** /api/hosting/v1/websites/{domain} | Delete website|
|
|
9
|
+
|[**deployStaticSiteArchiveV1**](#deploystaticsitearchivev1) | **POST** /api/hosting/v1/accounts/{username}/websites/{domain}/deploy | Deploy static site archive|
|
|
9
10
|
|[**listWebsitesV1**](#listwebsitesv1) | **GET** /api/hosting/v1/websites | List websites|
|
|
10
11
|
|
|
11
12
|
# **createWebsiteV1**
|
|
@@ -117,6 +118,67 @@ const { status, data } = await apiInstance.deleteWebsiteV1(
|
|
|
117
118
|
|
|
118
119
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
119
120
|
|
|
121
|
+
# **deployStaticSiteArchiveV1**
|
|
122
|
+
> CommonSuccessEmptyResource deployStaticSiteArchiveV1(hostingV1WebsitesDeployArchiveRequest)
|
|
123
|
+
|
|
124
|
+
Deploy a static application from an archive file. WARNING: this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This endpoint allows you to deploy a static application from an archive file that has been uploaded to the website\'s directory. This only works for static sites (pre-built HTML/CSS/JS with no build step). For Node.js applications, use `Create NodeJS build from archive` instead, or `Start Node.js build` if the archive is already uploaded. For WordPress sites, use `Import WordPress website`.
|
|
125
|
+
|
|
126
|
+
### Example
|
|
127
|
+
|
|
128
|
+
```typescript
|
|
129
|
+
import {
|
|
130
|
+
HostingWebsitesApi,
|
|
131
|
+
Configuration,
|
|
132
|
+
HostingV1WebsitesDeployArchiveRequest
|
|
133
|
+
} from 'hostinger-api-sdk';
|
|
134
|
+
|
|
135
|
+
const configuration = new Configuration();
|
|
136
|
+
const apiInstance = new HostingWebsitesApi(configuration);
|
|
137
|
+
|
|
138
|
+
let username: string; // (default to undefined)
|
|
139
|
+
let domain: string; //Domain name (default to undefined)
|
|
140
|
+
let hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest; //
|
|
141
|
+
|
|
142
|
+
const { status, data } = await apiInstance.deployStaticSiteArchiveV1(
|
|
143
|
+
username,
|
|
144
|
+
domain,
|
|
145
|
+
hostingV1WebsitesDeployArchiveRequest
|
|
146
|
+
);
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
### Parameters
|
|
150
|
+
|
|
151
|
+
|Name | Type | Description | Notes|
|
|
152
|
+
|------------- | ------------- | ------------- | -------------|
|
|
153
|
+
| **hostingV1WebsitesDeployArchiveRequest** | **HostingV1WebsitesDeployArchiveRequest**| | |
|
|
154
|
+
| **username** | [**string**] | | defaults to undefined|
|
|
155
|
+
| **domain** | [**string**] | Domain name | defaults to undefined|
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
### Return type
|
|
159
|
+
|
|
160
|
+
**CommonSuccessEmptyResource**
|
|
161
|
+
|
|
162
|
+
### Authorization
|
|
163
|
+
|
|
164
|
+
[apiToken](../README.md#apiToken)
|
|
165
|
+
|
|
166
|
+
### HTTP request headers
|
|
167
|
+
|
|
168
|
+
- **Content-Type**: application/json
|
|
169
|
+
- **Accept**: application/json
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
### HTTP response details
|
|
173
|
+
| Status code | Description | Response headers |
|
|
174
|
+
|-------------|-------------|------------------|
|
|
175
|
+
|**200** | Success response | - |
|
|
176
|
+
|**422** | Validation error response | - |
|
|
177
|
+
|**401** | Unauthenticated response | - |
|
|
178
|
+
|**500** | Error response | - |
|
|
179
|
+
|
|
180
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
181
|
+
|
|
120
182
|
# **listWebsitesV1**
|
|
121
183
|
> HostingListWebsitesV1200Response listWebsitesV1()
|
|
122
184
|
|