@hostinger/sdk 1.53.2 → 1.54.1
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 +547 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +318 -1
- package/dist/api.js +439 -12
- 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 +318 -1
- package/dist/esm/api.js +423 -1
- 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/AgencyHostingSSLApi.md +238 -0
- package/docs/AgencyHostingV1SslSslStatusResource.md +24 -0
- package/docs/HostingDatabasesApi.md +62 -0
- package/docs/HostingV1DatabasesSetupDatabaseRequest.md +22 -0
- package/docs/HostingV1DatabasesWebsiteDatabaseConnectionResource.md +26 -0
- package/docs/HostingV1DatabasesWebsiteDatabaseResource.md +22 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/configuration.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.54.1
|
|
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
|
|
@@ -48,7 +48,7 @@ export class Configuration {
|
|
|
48
48
|
this.baseOptions = {
|
|
49
49
|
...param.baseOptions,
|
|
50
50
|
headers: {
|
|
51
|
-
'User-Agent': "hostinger-typescript-sdk/1.
|
|
51
|
+
'User-Agent': "hostinger-typescript-sdk/1.54.1",
|
|
52
52
|
...param.baseOptions?.headers,
|
|
53
53
|
},
|
|
54
54
|
};
|
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.54.1
|
|
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
|
|
@@ -810,6 +810,39 @@ export declare const AgencyHostingV1SetupsWebsiteSetupStatusResourceStatusEnum:
|
|
|
810
810
|
readonly Completed: "completed";
|
|
811
811
|
};
|
|
812
812
|
export type AgencyHostingV1SetupsWebsiteSetupStatusResourceStatusEnum = typeof AgencyHostingV1SetupsWebsiteSetupStatusResourceStatusEnum[keyof typeof AgencyHostingV1SetupsWebsiteSetupStatusResourceStatusEnum];
|
|
813
|
+
/**
|
|
814
|
+
*
|
|
815
|
+
* @export
|
|
816
|
+
* @interface AgencyHostingV1SslSslStatusResource
|
|
817
|
+
*/
|
|
818
|
+
export interface AgencyHostingV1SslSslStatusResource {
|
|
819
|
+
/**
|
|
820
|
+
* `installing` while a certificate setup is running or retrying, `active` when a valid certificate is in place (uploaded, platform-issued, or a lifetime certificate bought for the domain), `failed` when the last setup gave up and no valid certificate is in place, `expired` when the certificate has run out, `not_installed` when the domain has no certificate and no setup process.
|
|
821
|
+
* @type {string}
|
|
822
|
+
* @memberof AgencyHostingV1SslSslStatusResource
|
|
823
|
+
*/
|
|
824
|
+
'status': AgencyHostingV1SslSslStatusResourceStatusEnum;
|
|
825
|
+
/**
|
|
826
|
+
* Whether the certificate was uploaded by the customer instead of issued or sold by the platform.
|
|
827
|
+
* @type {boolean}
|
|
828
|
+
* @memberof AgencyHostingV1SslSslStatusResource
|
|
829
|
+
*/
|
|
830
|
+
'is_custom': boolean;
|
|
831
|
+
/**
|
|
832
|
+
* End of the validity period of the certificate in place; null when there is none or the uploaded certificate carries no expiry.
|
|
833
|
+
* @type {string}
|
|
834
|
+
* @memberof AgencyHostingV1SslSslStatusResource
|
|
835
|
+
*/
|
|
836
|
+
'expires_at': string | null;
|
|
837
|
+
}
|
|
838
|
+
export declare const AgencyHostingV1SslSslStatusResourceStatusEnum: {
|
|
839
|
+
readonly NotInstalled: "not_installed";
|
|
840
|
+
readonly Installing: "installing";
|
|
841
|
+
readonly Failed: "failed";
|
|
842
|
+
readonly Active: "active";
|
|
843
|
+
readonly Expired: "expired";
|
|
844
|
+
};
|
|
845
|
+
export type AgencyHostingV1SslSslStatusResourceStatusEnum = typeof AgencyHostingV1SslSslStatusResourceStatusEnum[keyof typeof AgencyHostingV1SslSslStatusResourceStatusEnum];
|
|
813
846
|
/**
|
|
814
847
|
* Build Node.js assets from an already-uploaded archive
|
|
815
848
|
* @export
|
|
@@ -6828,6 +6861,75 @@ export interface HostingV1DatabasesRemoteConnectionsRemoteConnectionResource {
|
|
|
6828
6861
|
*/
|
|
6829
6862
|
'ip': string;
|
|
6830
6863
|
}
|
|
6864
|
+
/**
|
|
6865
|
+
*
|
|
6866
|
+
* @export
|
|
6867
|
+
* @interface HostingV1DatabasesSetupDatabaseRequest
|
|
6868
|
+
*/
|
|
6869
|
+
export interface HostingV1DatabasesSetupDatabaseRequest {
|
|
6870
|
+
/**
|
|
6871
|
+
* Optional database name. Generated when omitted. Letters, digits and underscores; must not start with an underscore. Up to 14 characters without the account username prefix (`u123456789_`), which is added automatically when missing. With the prefix the full name is 12 to 25 characters.
|
|
6872
|
+
* @type {string}
|
|
6873
|
+
* @memberof HostingV1DatabasesSetupDatabaseRequest
|
|
6874
|
+
*/
|
|
6875
|
+
'name': string;
|
|
6876
|
+
/**
|
|
6877
|
+
* Optional database user. Generated when omitted. Letters, digits and underscores; must not start with an underscore. Up to 14 characters without the account username prefix (`u123456789_`), which is added automatically when missing. With the prefix the full user is 12 to 25 characters.
|
|
6878
|
+
* @type {string}
|
|
6879
|
+
* @memberof HostingV1DatabasesSetupDatabaseRequest
|
|
6880
|
+
*/
|
|
6881
|
+
'user': string;
|
|
6882
|
+
}
|
|
6883
|
+
/**
|
|
6884
|
+
*
|
|
6885
|
+
* @export
|
|
6886
|
+
* @interface HostingV1DatabasesWebsiteDatabaseConnectionResource
|
|
6887
|
+
*/
|
|
6888
|
+
export interface HostingV1DatabasesWebsiteDatabaseConnectionResource {
|
|
6889
|
+
/**
|
|
6890
|
+
* Database name, as written into DB_NAME
|
|
6891
|
+
* @type {string}
|
|
6892
|
+
* @memberof HostingV1DatabasesWebsiteDatabaseConnectionResource
|
|
6893
|
+
*/
|
|
6894
|
+
'name': string;
|
|
6895
|
+
/**
|
|
6896
|
+
* Database user, as written into DB_USER
|
|
6897
|
+
* @type {string}
|
|
6898
|
+
* @memberof HostingV1DatabasesWebsiteDatabaseConnectionResource
|
|
6899
|
+
*/
|
|
6900
|
+
'user': string;
|
|
6901
|
+
/**
|
|
6902
|
+
* MySQL host as written into DB_HOST. The application connects over the loopback.
|
|
6903
|
+
* @type {string}
|
|
6904
|
+
* @memberof HostingV1DatabasesWebsiteDatabaseConnectionResource
|
|
6905
|
+
*/
|
|
6906
|
+
'host': string;
|
|
6907
|
+
/**
|
|
6908
|
+
* MySQL port as written into DB_PORT
|
|
6909
|
+
* @type {number}
|
|
6910
|
+
* @memberof HostingV1DatabasesWebsiteDatabaseConnectionResource
|
|
6911
|
+
*/
|
|
6912
|
+
'port': number;
|
|
6913
|
+
}
|
|
6914
|
+
/**
|
|
6915
|
+
*
|
|
6916
|
+
* @export
|
|
6917
|
+
* @interface HostingV1DatabasesWebsiteDatabaseResource
|
|
6918
|
+
*/
|
|
6919
|
+
export interface HostingV1DatabasesWebsiteDatabaseResource {
|
|
6920
|
+
/**
|
|
6921
|
+
*
|
|
6922
|
+
* @type {HostingV1DatabasesWebsiteDatabaseConnectionResource}
|
|
6923
|
+
* @memberof HostingV1DatabasesWebsiteDatabaseResource
|
|
6924
|
+
*/
|
|
6925
|
+
'database': HostingV1DatabasesWebsiteDatabaseConnectionResource;
|
|
6926
|
+
/**
|
|
6927
|
+
* Names of the environment variables written for this database. Values are never returned.
|
|
6928
|
+
* @type {Array<string>}
|
|
6929
|
+
* @memberof HostingV1DatabasesWebsiteDatabaseResource
|
|
6930
|
+
*/
|
|
6931
|
+
'env_var_keys': Array<string>;
|
|
6932
|
+
}
|
|
6831
6933
|
/**
|
|
6832
6934
|
*
|
|
6833
6935
|
* @export
|
|
@@ -17770,6 +17872,180 @@ export declare class AgencyHostingPHPApi extends BaseAPI {
|
|
|
17770
17872
|
*/
|
|
17771
17873
|
updateWebsitePHPVersionV1(websiteUid: string, agencyHostingV1PhpUpdateVersionRequest: AgencyHostingV1PhpUpdateVersionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
17772
17874
|
}
|
|
17875
|
+
/**
|
|
17876
|
+
* AgencyHostingSSLApi - axios parameter creator
|
|
17877
|
+
* @export
|
|
17878
|
+
*/
|
|
17879
|
+
export declare const AgencyHostingSSLApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
17880
|
+
/**
|
|
17881
|
+
* Returns the SSL state of one domain of an Agency Plan website: the certificate `status`, whether the certificate was uploaded by the customer, and when it stops being valid. `installing` means a certificate setup is running or retrying; the `ssl_setup` entry of `List website processes` shows the same progress. `active` means a valid certificate is in place: uploaded by the customer, issued by the platform, or a lifetime certificate bought for the domain. `failed` means the last setup gave up and no valid certificate is in place. `expired` means the certificate has run out. `not_installed` means the domain has no certificate and no setup process. Returns 404 when the website or the domain does not exist.
|
|
17882
|
+
* @summary Get website SSL status
|
|
17883
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
17884
|
+
* @param {string} domain Domain name
|
|
17885
|
+
* @param {*} [options] Override http request option.
|
|
17886
|
+
* @throws {RequiredError}
|
|
17887
|
+
*/
|
|
17888
|
+
getWebsiteSSLStatusV1: (websiteUid: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
17889
|
+
/**
|
|
17890
|
+
* Starts a Let\'s Encrypt certificate setup for the domain and returns at once; the setup runs in the background. `Get website SSL status` reports `installing` while it runs, then `active` or `failed`; the `ssl_setup` entry of `List website processes` shows the same progress. Returns 422 when the domain already has a platform certificate that is not expired, when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), or when the domain hit its limit of three setups per seven days. Returns 429 when the same domain was requested less than a minute ago, 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
|
|
17891
|
+
* @summary Install website SSL
|
|
17892
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
17893
|
+
* @param {string} domain Domain name
|
|
17894
|
+
* @param {*} [options] Override http request option.
|
|
17895
|
+
* @throws {RequiredError}
|
|
17896
|
+
*/
|
|
17897
|
+
installWebsiteSSLV1: (websiteUid: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
17898
|
+
/**
|
|
17899
|
+
* Replaces the Let\'s Encrypt certificate of the domain: the current platform certificate, when one is recorded, is revoked and removed, then a new setup starts in the background. Returns at once; `Get website SSL status` reports `installing` while it runs, then `active` or `failed`. Returns 422 for free subdomains, when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), or when the domain hit its limit of three setups per seven days. Returns 429 when the same domain was requested less than a minute ago, and 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
|
|
17900
|
+
* @summary Reinstall website SSL
|
|
17901
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
17902
|
+
* @param {string} domain Domain name
|
|
17903
|
+
* @param {*} [options] Override http request option.
|
|
17904
|
+
* @throws {RequiredError}
|
|
17905
|
+
*/
|
|
17906
|
+
reinstallWebsiteSSLV1: (websiteUid: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
17907
|
+
/**
|
|
17908
|
+
* Removes the platform-issued Let\'s Encrypt certificate of the domain: the certificate is revoked and deleted before the response, so the domain is no longer served with a platform certificate until a new setup completes. Also succeeds when the domain has no platform certificate to remove. Uploaded (custom) certificates are not affected. Returns 422 when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), 429 when the same domain was requested less than a minute ago, and 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
|
|
17909
|
+
* @summary Uninstall website SSL
|
|
17910
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
17911
|
+
* @param {string} domain Domain name
|
|
17912
|
+
* @param {*} [options] Override http request option.
|
|
17913
|
+
* @throws {RequiredError}
|
|
17914
|
+
*/
|
|
17915
|
+
uninstallWebsiteSSLV1: (websiteUid: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
17916
|
+
};
|
|
17917
|
+
/**
|
|
17918
|
+
* AgencyHostingSSLApi - functional programming interface
|
|
17919
|
+
* @export
|
|
17920
|
+
*/
|
|
17921
|
+
export declare const AgencyHostingSSLApiFp: (configuration?: Configuration) => {
|
|
17922
|
+
/**
|
|
17923
|
+
* Returns the SSL state of one domain of an Agency Plan website: the certificate `status`, whether the certificate was uploaded by the customer, and when it stops being valid. `installing` means a certificate setup is running or retrying; the `ssl_setup` entry of `List website processes` shows the same progress. `active` means a valid certificate is in place: uploaded by the customer, issued by the platform, or a lifetime certificate bought for the domain. `failed` means the last setup gave up and no valid certificate is in place. `expired` means the certificate has run out. `not_installed` means the domain has no certificate and no setup process. Returns 404 when the website or the domain does not exist.
|
|
17924
|
+
* @summary Get website SSL status
|
|
17925
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
17926
|
+
* @param {string} domain Domain name
|
|
17927
|
+
* @param {*} [options] Override http request option.
|
|
17928
|
+
* @throws {RequiredError}
|
|
17929
|
+
*/
|
|
17930
|
+
getWebsiteSSLStatusV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AgencyHostingV1SslSslStatusResource>>;
|
|
17931
|
+
/**
|
|
17932
|
+
* Starts a Let\'s Encrypt certificate setup for the domain and returns at once; the setup runs in the background. `Get website SSL status` reports `installing` while it runs, then `active` or `failed`; the `ssl_setup` entry of `List website processes` shows the same progress. Returns 422 when the domain already has a platform certificate that is not expired, when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), or when the domain hit its limit of three setups per seven days. Returns 429 when the same domain was requested less than a minute ago, 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
|
|
17933
|
+
* @summary Install website SSL
|
|
17934
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
17935
|
+
* @param {string} domain Domain name
|
|
17936
|
+
* @param {*} [options] Override http request option.
|
|
17937
|
+
* @throws {RequiredError}
|
|
17938
|
+
*/
|
|
17939
|
+
installWebsiteSSLV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
17940
|
+
/**
|
|
17941
|
+
* Replaces the Let\'s Encrypt certificate of the domain: the current platform certificate, when one is recorded, is revoked and removed, then a new setup starts in the background. Returns at once; `Get website SSL status` reports `installing` while it runs, then `active` or `failed`. Returns 422 for free subdomains, when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), or when the domain hit its limit of three setups per seven days. Returns 429 when the same domain was requested less than a minute ago, and 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
|
|
17942
|
+
* @summary Reinstall website SSL
|
|
17943
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
17944
|
+
* @param {string} domain Domain name
|
|
17945
|
+
* @param {*} [options] Override http request option.
|
|
17946
|
+
* @throws {RequiredError}
|
|
17947
|
+
*/
|
|
17948
|
+
reinstallWebsiteSSLV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
17949
|
+
/**
|
|
17950
|
+
* Removes the platform-issued Let\'s Encrypt certificate of the domain: the certificate is revoked and deleted before the response, so the domain is no longer served with a platform certificate until a new setup completes. Also succeeds when the domain has no platform certificate to remove. Uploaded (custom) certificates are not affected. Returns 422 when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), 429 when the same domain was requested less than a minute ago, and 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
|
|
17951
|
+
* @summary Uninstall website SSL
|
|
17952
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
17953
|
+
* @param {string} domain Domain name
|
|
17954
|
+
* @param {*} [options] Override http request option.
|
|
17955
|
+
* @throws {RequiredError}
|
|
17956
|
+
*/
|
|
17957
|
+
uninstallWebsiteSSLV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
17958
|
+
};
|
|
17959
|
+
/**
|
|
17960
|
+
* AgencyHostingSSLApi - factory interface
|
|
17961
|
+
* @export
|
|
17962
|
+
*/
|
|
17963
|
+
export declare const AgencyHostingSSLApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
17964
|
+
/**
|
|
17965
|
+
* Returns the SSL state of one domain of an Agency Plan website: the certificate `status`, whether the certificate was uploaded by the customer, and when it stops being valid. `installing` means a certificate setup is running or retrying; the `ssl_setup` entry of `List website processes` shows the same progress. `active` means a valid certificate is in place: uploaded by the customer, issued by the platform, or a lifetime certificate bought for the domain. `failed` means the last setup gave up and no valid certificate is in place. `expired` means the certificate has run out. `not_installed` means the domain has no certificate and no setup process. Returns 404 when the website or the domain does not exist.
|
|
17966
|
+
* @summary Get website SSL status
|
|
17967
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
17968
|
+
* @param {string} domain Domain name
|
|
17969
|
+
* @param {*} [options] Override http request option.
|
|
17970
|
+
* @throws {RequiredError}
|
|
17971
|
+
*/
|
|
17972
|
+
getWebsiteSSLStatusV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<AgencyHostingV1SslSslStatusResource>;
|
|
17973
|
+
/**
|
|
17974
|
+
* Starts a Let\'s Encrypt certificate setup for the domain and returns at once; the setup runs in the background. `Get website SSL status` reports `installing` while it runs, then `active` or `failed`; the `ssl_setup` entry of `List website processes` shows the same progress. Returns 422 when the domain already has a platform certificate that is not expired, when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), or when the domain hit its limit of three setups per seven days. Returns 429 when the same domain was requested less than a minute ago, 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
|
|
17975
|
+
* @summary Install website SSL
|
|
17976
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
17977
|
+
* @param {string} domain Domain name
|
|
17978
|
+
* @param {*} [options] Override http request option.
|
|
17979
|
+
* @throws {RequiredError}
|
|
17980
|
+
*/
|
|
17981
|
+
installWebsiteSSLV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
17982
|
+
/**
|
|
17983
|
+
* Replaces the Let\'s Encrypt certificate of the domain: the current platform certificate, when one is recorded, is revoked and removed, then a new setup starts in the background. Returns at once; `Get website SSL status` reports `installing` while it runs, then `active` or `failed`. Returns 422 for free subdomains, when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), or when the domain hit its limit of three setups per seven days. Returns 429 when the same domain was requested less than a minute ago, and 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
|
|
17984
|
+
* @summary Reinstall website SSL
|
|
17985
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
17986
|
+
* @param {string} domain Domain name
|
|
17987
|
+
* @param {*} [options] Override http request option.
|
|
17988
|
+
* @throws {RequiredError}
|
|
17989
|
+
*/
|
|
17990
|
+
reinstallWebsiteSSLV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
17991
|
+
/**
|
|
17992
|
+
* Removes the platform-issued Let\'s Encrypt certificate of the domain: the certificate is revoked and deleted before the response, so the domain is no longer served with a platform certificate until a new setup completes. Also succeeds when the domain has no platform certificate to remove. Uploaded (custom) certificates are not affected. Returns 422 when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), 429 when the same domain was requested less than a minute ago, and 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
|
|
17993
|
+
* @summary Uninstall website SSL
|
|
17994
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
17995
|
+
* @param {string} domain Domain name
|
|
17996
|
+
* @param {*} [options] Override http request option.
|
|
17997
|
+
* @throws {RequiredError}
|
|
17998
|
+
*/
|
|
17999
|
+
uninstallWebsiteSSLV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
18000
|
+
};
|
|
18001
|
+
/**
|
|
18002
|
+
* AgencyHostingSSLApi - object-oriented interface
|
|
18003
|
+
* @export
|
|
18004
|
+
* @class AgencyHostingSSLApi
|
|
18005
|
+
* @extends {BaseAPI}
|
|
18006
|
+
*/
|
|
18007
|
+
export declare class AgencyHostingSSLApi extends BaseAPI {
|
|
18008
|
+
/**
|
|
18009
|
+
* Returns the SSL state of one domain of an Agency Plan website: the certificate `status`, whether the certificate was uploaded by the customer, and when it stops being valid. `installing` means a certificate setup is running or retrying; the `ssl_setup` entry of `List website processes` shows the same progress. `active` means a valid certificate is in place: uploaded by the customer, issued by the platform, or a lifetime certificate bought for the domain. `failed` means the last setup gave up and no valid certificate is in place. `expired` means the certificate has run out. `not_installed` means the domain has no certificate and no setup process. Returns 404 when the website or the domain does not exist.
|
|
18010
|
+
* @summary Get website SSL status
|
|
18011
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
18012
|
+
* @param {string} domain Domain name
|
|
18013
|
+
* @param {*} [options] Override http request option.
|
|
18014
|
+
* @throws {RequiredError}
|
|
18015
|
+
* @memberof AgencyHostingSSLApi
|
|
18016
|
+
*/
|
|
18017
|
+
getWebsiteSSLStatusV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AgencyHostingV1SslSslStatusResource, any, {}, any>>;
|
|
18018
|
+
/**
|
|
18019
|
+
* Starts a Let\'s Encrypt certificate setup for the domain and returns at once; the setup runs in the background. `Get website SSL status` reports `installing` while it runs, then `active` or `failed`; the `ssl_setup` entry of `List website processes` shows the same progress. Returns 422 when the domain already has a platform certificate that is not expired, when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), or when the domain hit its limit of three setups per seven days. Returns 429 when the same domain was requested less than a minute ago, 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
|
|
18020
|
+
* @summary Install website SSL
|
|
18021
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
18022
|
+
* @param {string} domain Domain name
|
|
18023
|
+
* @param {*} [options] Override http request option.
|
|
18024
|
+
* @throws {RequiredError}
|
|
18025
|
+
* @memberof AgencyHostingSSLApi
|
|
18026
|
+
*/
|
|
18027
|
+
installWebsiteSSLV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
18028
|
+
/**
|
|
18029
|
+
* Replaces the Let\'s Encrypt certificate of the domain: the current platform certificate, when one is recorded, is revoked and removed, then a new setup starts in the background. Returns at once; `Get website SSL status` reports `installing` while it runs, then `active` or `failed`. Returns 422 for free subdomains, when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), or when the domain hit its limit of three setups per seven days. Returns 429 when the same domain was requested less than a minute ago, and 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
|
|
18030
|
+
* @summary Reinstall website SSL
|
|
18031
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
18032
|
+
* @param {string} domain Domain name
|
|
18033
|
+
* @param {*} [options] Override http request option.
|
|
18034
|
+
* @throws {RequiredError}
|
|
18035
|
+
* @memberof AgencyHostingSSLApi
|
|
18036
|
+
*/
|
|
18037
|
+
reinstallWebsiteSSLV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
18038
|
+
/**
|
|
18039
|
+
* Removes the platform-issued Let\'s Encrypt certificate of the domain: the certificate is revoked and deleted before the response, so the domain is no longer served with a platform certificate until a new setup completes. Also succeeds when the domain has no platform certificate to remove. Uploaded (custom) certificates are not affected. Returns 422 when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), 429 when the same domain was requested less than a minute ago, and 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
|
|
18040
|
+
* @summary Uninstall website SSL
|
|
18041
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
18042
|
+
* @param {string} domain Domain name
|
|
18043
|
+
* @param {*} [options] Override http request option.
|
|
18044
|
+
* @throws {RequiredError}
|
|
18045
|
+
* @memberof AgencyHostingSSLApi
|
|
18046
|
+
*/
|
|
18047
|
+
uninstallWebsiteSSLV1(websiteUid: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
18048
|
+
}
|
|
17773
18049
|
/**
|
|
17774
18050
|
* AgencyHostingWebsiteSetupsApi - axios parameter creator
|
|
17775
18051
|
* @export
|
|
@@ -22603,6 +22879,16 @@ export declare const HostingDatabasesApiAxiosParamCreator: (configuration?: Conf
|
|
|
22603
22879
|
* @throws {RequiredError}
|
|
22604
22880
|
*/
|
|
22605
22881
|
repairDatabaseV1: (username: string, name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22882
|
+
/**
|
|
22883
|
+
* Creates a new MySQL database for the website and writes its connection details into the website\'s environment variables, then restarts the application. The platform generates the password (and the database name and user, unless supplied). The password is never returned; the application reads it from the environment. Written variables: `DB_HOST`, `DB_PORT`, `DB_NAME`, `DB_USER`, `DB_PASSWORD` and `DATABASE_URL` (`mysql://user:password@host:port/name`, user and password percent-encoded). Existing variables are kept. If the website already has any variable with one of these names the call fails with 422 and nothing is created; the `Replace Node.js environment variables` endpoint removes them. After this call the variables are ordinary environment variables: the `Replace Node.js environment variables` endpoint changes or removes them like any other. A restart is enough for apps that read environment variables at process start, such as Express or NestJS. Frameworks that bake variables into the build output (Next.js, `NEXT_PUBLIC_*`) see the new values only after a fresh build (`Start Node.js build` endpoint). A password in the request is ignored; the platform always generates it. The optional `name` and `user` are identifiers, not secrets.
|
|
22884
|
+
* @summary Setup website database
|
|
22885
|
+
* @param {string} username
|
|
22886
|
+
* @param {string} domain Domain name
|
|
22887
|
+
* @param {HostingV1DatabasesSetupDatabaseRequest} [hostingV1DatabasesSetupDatabaseRequest]
|
|
22888
|
+
* @param {*} [options] Override http request option.
|
|
22889
|
+
* @throws {RequiredError}
|
|
22890
|
+
*/
|
|
22891
|
+
setupWebsiteDatabaseV1: (username: string, domain: string, hostingV1DatabasesSetupDatabaseRequest?: HostingV1DatabasesSetupDatabaseRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22606
22892
|
};
|
|
22607
22893
|
/**
|
|
22608
22894
|
* HostingDatabasesApi - functional programming interface
|
|
@@ -22697,6 +22983,16 @@ export declare const HostingDatabasesApiFp: (configuration?: Configuration) => {
|
|
|
22697
22983
|
* @throws {RequiredError}
|
|
22698
22984
|
*/
|
|
22699
22985
|
repairDatabaseV1(username: string, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
22986
|
+
/**
|
|
22987
|
+
* Creates a new MySQL database for the website and writes its connection details into the website\'s environment variables, then restarts the application. The platform generates the password (and the database name and user, unless supplied). The password is never returned; the application reads it from the environment. Written variables: `DB_HOST`, `DB_PORT`, `DB_NAME`, `DB_USER`, `DB_PASSWORD` and `DATABASE_URL` (`mysql://user:password@host:port/name`, user and password percent-encoded). Existing variables are kept. If the website already has any variable with one of these names the call fails with 422 and nothing is created; the `Replace Node.js environment variables` endpoint removes them. After this call the variables are ordinary environment variables: the `Replace Node.js environment variables` endpoint changes or removes them like any other. A restart is enough for apps that read environment variables at process start, such as Express or NestJS. Frameworks that bake variables into the build output (Next.js, `NEXT_PUBLIC_*`) see the new values only after a fresh build (`Start Node.js build` endpoint). A password in the request is ignored; the platform always generates it. The optional `name` and `user` are identifiers, not secrets.
|
|
22988
|
+
* @summary Setup website database
|
|
22989
|
+
* @param {string} username
|
|
22990
|
+
* @param {string} domain Domain name
|
|
22991
|
+
* @param {HostingV1DatabasesSetupDatabaseRequest} [hostingV1DatabasesSetupDatabaseRequest]
|
|
22992
|
+
* @param {*} [options] Override http request option.
|
|
22993
|
+
* @throws {RequiredError}
|
|
22994
|
+
*/
|
|
22995
|
+
setupWebsiteDatabaseV1(username: string, domain: string, hostingV1DatabasesSetupDatabaseRequest?: HostingV1DatabasesSetupDatabaseRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1DatabasesWebsiteDatabaseResource>>;
|
|
22700
22996
|
};
|
|
22701
22997
|
/**
|
|
22702
22998
|
* HostingDatabasesApi - factory interface
|
|
@@ -22791,6 +23087,16 @@ export declare const HostingDatabasesApiFactory: (configuration?: Configuration,
|
|
|
22791
23087
|
* @throws {RequiredError}
|
|
22792
23088
|
*/
|
|
22793
23089
|
repairDatabaseV1(username: string, name: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
23090
|
+
/**
|
|
23091
|
+
* Creates a new MySQL database for the website and writes its connection details into the website\'s environment variables, then restarts the application. The platform generates the password (and the database name and user, unless supplied). The password is never returned; the application reads it from the environment. Written variables: `DB_HOST`, `DB_PORT`, `DB_NAME`, `DB_USER`, `DB_PASSWORD` and `DATABASE_URL` (`mysql://user:password@host:port/name`, user and password percent-encoded). Existing variables are kept. If the website already has any variable with one of these names the call fails with 422 and nothing is created; the `Replace Node.js environment variables` endpoint removes them. After this call the variables are ordinary environment variables: the `Replace Node.js environment variables` endpoint changes or removes them like any other. A restart is enough for apps that read environment variables at process start, such as Express or NestJS. Frameworks that bake variables into the build output (Next.js, `NEXT_PUBLIC_*`) see the new values only after a fresh build (`Start Node.js build` endpoint). A password in the request is ignored; the platform always generates it. The optional `name` and `user` are identifiers, not secrets.
|
|
23092
|
+
* @summary Setup website database
|
|
23093
|
+
* @param {string} username
|
|
23094
|
+
* @param {string} domain Domain name
|
|
23095
|
+
* @param {HostingV1DatabasesSetupDatabaseRequest} [hostingV1DatabasesSetupDatabaseRequest]
|
|
23096
|
+
* @param {*} [options] Override http request option.
|
|
23097
|
+
* @throws {RequiredError}
|
|
23098
|
+
*/
|
|
23099
|
+
setupWebsiteDatabaseV1(username: string, domain: string, hostingV1DatabasesSetupDatabaseRequest?: HostingV1DatabasesSetupDatabaseRequest, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1DatabasesWebsiteDatabaseResource>;
|
|
22794
23100
|
};
|
|
22795
23101
|
/**
|
|
22796
23102
|
* HostingDatabasesApi - object-oriented interface
|
|
@@ -22896,6 +23202,17 @@ export declare class HostingDatabasesApi extends BaseAPI {
|
|
|
22896
23202
|
* @memberof HostingDatabasesApi
|
|
22897
23203
|
*/
|
|
22898
23204
|
repairDatabaseV1(username: string, name: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
23205
|
+
/**
|
|
23206
|
+
* Creates a new MySQL database for the website and writes its connection details into the website\'s environment variables, then restarts the application. The platform generates the password (and the database name and user, unless supplied). The password is never returned; the application reads it from the environment. Written variables: `DB_HOST`, `DB_PORT`, `DB_NAME`, `DB_USER`, `DB_PASSWORD` and `DATABASE_URL` (`mysql://user:password@host:port/name`, user and password percent-encoded). Existing variables are kept. If the website already has any variable with one of these names the call fails with 422 and nothing is created; the `Replace Node.js environment variables` endpoint removes them. After this call the variables are ordinary environment variables: the `Replace Node.js environment variables` endpoint changes or removes them like any other. A restart is enough for apps that read environment variables at process start, such as Express or NestJS. Frameworks that bake variables into the build output (Next.js, `NEXT_PUBLIC_*`) see the new values only after a fresh build (`Start Node.js build` endpoint). A password in the request is ignored; the platform always generates it. The optional `name` and `user` are identifiers, not secrets.
|
|
23207
|
+
* @summary Setup website database
|
|
23208
|
+
* @param {string} username
|
|
23209
|
+
* @param {string} domain Domain name
|
|
23210
|
+
* @param {HostingV1DatabasesSetupDatabaseRequest} [hostingV1DatabasesSetupDatabaseRequest]
|
|
23211
|
+
* @param {*} [options] Override http request option.
|
|
23212
|
+
* @throws {RequiredError}
|
|
23213
|
+
* @memberof HostingDatabasesApi
|
|
23214
|
+
*/
|
|
23215
|
+
setupWebsiteDatabaseV1(username: string, domain: string, hostingV1DatabasesSetupDatabaseRequest?: HostingV1DatabasesSetupDatabaseRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1DatabasesWebsiteDatabaseResource, any, {}, any>>;
|
|
22899
23216
|
}
|
|
22900
23217
|
/**
|
|
22901
23218
|
* HostingDatacentersApi - axios parameter creator
|