2123 lines
121 KiB
TypeScript
2123 lines
121 KiB
TypeScript
/**
|
||
* Hetzner Cloud API
|
||
* This is the official documentation for the Hetzner Cloud API. ## Introduction The Hetzner Cloud API operates over HTTPS and uses JSON as its data format. The API is a RESTful API and utilizes HTTP methods and HTTP status codes to specify requests and responses. As an alternative to working directly with our API you may also consider to use: - Our CLI program [hcloud](https://github.com/hetznercloud/cli) - Our [library for Go](https://github.com/hetznercloud/hcloud-go) - Our [library for Python](https://github.com/hetznercloud/hcloud-python) Also you can find a [list of libraries, tools, and integrations on GitHub](https://github.com/hetznercloud/awesome-hcloud). If you are developing integrations based on our API and your product is Open Source you may be eligible for a free one time €50 (excl. VAT) credit on your account. Please contact us via the the support page on your Cloud Console and let us know the following: - The type of integration you would like to develop - Link to the GitHub repo you will use for the Project - Link to some other Open Source work you have already done (if you have done so) ## Getting Started To get started using the API you first need an API token. Sign in into the [Hetzner Cloud Console](https://console.hetzner.cloud/) choose a Project, go to `Security` → `API Tokens`, and generate a new token. Make sure to copy the token because it won’t be shown to you again. A token is bound to a Project, to interact with the API of another Project you have to create a new token inside the Project. Let’s say your new token is `LRK9DAWQ1ZAEFSrCNEEzLCUwhYX1U3g7wMg4dTlkkDC96fyDuyJ39nVbVjCKSDfj`. You’re now ready to do your first request against the API. To get a list of all Servers in your Project, issue the example request on the right side using [curl](https://curl.se/). Make sure to replace the token in the example command with the token you have just created. Since your Project probably does not contain any Servers yet, the example response will look like the response on the right side. We will almost always provide a resource root like `servers` inside the example response. A response can also contain a `meta` object with information like [Pagination](#pagination). **Example Request** ```bash curl -H \"Authorization: Bearer LRK9DAWQ1ZAEFSrCNEEzLCUwhYX1U3g7wMg4dTlkkDC96fyDuyJ39nVbVjCKSDfj\" \\ https://api.hetzner.cloud/v1/servers ``` **Example Response** ```json { \"servers\": [], \"meta\": { \"pagination\": { \"page\": 1, \"per_page\": 25, \"previous_page\": null, \"next_page\": null, \"last_page\": 1, \"total_entries\": 0 } } } ``` ## Authentication All requests to the Hetzner Cloud API must be authenticated via a API token. Include your secret API token in every request you send to the API with the `Authorization` HTTP header. To create a new API token for your Project, switch into the [Hetzner Cloud Console](https://console.hetzner.cloud/) choose a Project, go to `Security` → `API Tokens`, and generate a new token. **Example Authorization header** ```http Authorization: Bearer LRK9DAWQ1ZAEFSrCNEEzLCUwhYX1U3g7wMg4dTlkkDC96fyDuyJ39nVbVjCKSDfj ``` ## Errors Errors are indicated by HTTP status codes. Further, the response of the request which generated the error contains an error code, an error message, and, optionally, error details. The schema of the error details object depends on the error code. The error response contains the following keys: | Keys | Meaning | | --------- | --------------------------------------------------------------------- | | `code` | Short string indicating the type of error (machine-parsable) | | `message` | Textual description on what has gone wrong | | `details` | An object providing for details on the error (schema depends on code) | **Example response** ```json { \"error\": { \"code\": \"invalid_input\", \"message\": \"invalid input in field \'broken_field\': is too long\", \"details\": { \"fields\": [ { \"name\": \"broken_field\", \"messages\": [\"is too long\"] } ] } } } ``` ### Error Codes | Code | Description | | ------------------------- | -------------------------------------------------------------------------------- | | `forbidden` | Insufficient permissions for this request | | `unauthorized` | Request was made with an invalid or unknown token | | `invalid_input` | Error while parsing or processing the input | | `json_error` | Invalid JSON input in your request | | `locked` | The item you are trying to access is locked (there is already an Action running) | | `not_found` | Entity not found | | `rate_limit_exceeded` | Error when sending too many requests | | `resource_limit_exceeded` | Error when exceeding the maximum quantity of a resource for an account | | `resource_unavailable` | The requested resource is currently unavailable | | `server_error` | Error within the API backend | | `service_error` | Error within a service | | `uniqueness_error` | One or more of the objects fields must be unique | | `protected` | The Action you are trying to start is protected for this resource | | `maintenance` | Cannot perform operation due to maintenance | | `conflict` | The resource has changed during the request, please retry | | `unsupported_error` | The corresponding resource does not support the Action | | `token_readonly` | The token is only allowed to perform GET requests | | `unavailable` | A service or product is currently not available | **invalid_input** ```json { \"error\": { \"code\": \"invalid_input\", \"message\": \"invalid input in field \'broken_field\': is too long\", \"details\": { \"fields\": [ { \"name\": \"broken_field\", \"messages\": [\"is too long\"] } ] } } } ``` **uniqueness_error** ```json { \"error\": { \"code\": \"uniqueness_error\", \"message\": \"SSH key with the same fingerprint already exists\", \"details\": { \"fields\": [ { \"name\": \"public_key\" } ] } } } ``` **resource_limit_exceeded** ```json { \"error\": { \"code\": \"resource_limit_exceeded\", \"message\": \"project limit exceeded\", \"details\": { \"limits\": [ { \"name\": \"project_limit\" } ] } } } ``` ## Labels Labels are `key/value` pairs that can be attached to all resources. Valid label keys have two segments: an optional prefix and name, separated by a slash (`/`). The name segment is required and must be a string of 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots (`.`), not longer than 253 characters in total, followed by a slash (`/`). Valid label values must be a string of 63 characters or less and must be empty or begin and end with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. The `hetzner.cloud/` prefix is reserved and cannot be used. **Example Labels** ```json { \"labels\": { \"environment\": \"development\", \"service\": \"backend\", \"example.com/my\": \"label\", \"just-a-key\": \"\" } } ``` ## Label Selector For resources with labels, you can filter resources by their labels using the label selector query language. | Expression | Meaning | | -------------------- | ---------------------------------------------------- | | `k==v` / `k=v` | Value of key `k` does equal value `v` | | `k!=v` | Value of key `k` does not equal value `v` | | `k` | Key `k` is present | | `!k` | Key `k` is not present | | `k in (v1,v2,v3)` | Value of key `k` is `v1`, `v2`, or `v3` | | `k notin (v1,v2,v3)` | Value of key `k` is neither `v1`, nor `v2`, nor `v3` | | `k1==v,!k2` | Value of key `k1` is `v` and key `k2` is not present | ### Examples - Returns all resources that have a `env=production` label and that don\'t have a `type=database` label: `env=production,type!=database` - Returns all resources that have a `env=testing` or `env=staging` label: `env in (testing,staging)` - Returns all resources that don\'t have a `type` label: `!type` ## Pagination Responses which return multiple items support pagination. If they do support pagination, it can be controlled with following query string parameters: - A `page` parameter specifies the page to fetch. The number of the first page is 1. - A `per_page` parameter specifies the number of items returned per page. The default value is 25, the maximum value is 50 except otherwise specified in the documentation. Responses contain a `Link` header with pagination information. Additionally, if the response body is JSON and the root object is an object, that object has a `pagination` object inside the `meta` object with pagination information: **Example Pagination** ```json { \"servers\": [...], \"meta\": { \"pagination\": { \"page\": 2, \"per_page\": 25, \"previous_page\": 1, \"next_page\": 3, \"last_page\": 4, \"total_entries\": 100 } } } ``` The keys `previous_page`, `next_page`, `last_page`, and `total_entries` may be `null` when on the first page, last page, or when the total number of entries is unknown. **Example Pagination Link header** ```http Link: <https://api.hetzner.cloud/v1/actions?page=2&per_page=5>; rel=\"prev\", <https://api.hetzner.cloud/v1/actions?page=4&per_page=5>; rel=\"next\", <https://api.hetzner.cloud/v1/actions?page=6&per_page=5>; rel=\"last\" ``` Line breaks have been added for display purposes only and responses may only contain some of the above `rel` values. ## Rate Limiting All requests, whether they are authenticated or not, are subject to rate limiting. If you have reached your limit, your requests will be handled with a `429 Too Many Requests` error. Burst requests are allowed. Responses contain serveral headers which provide information about your current rate limit status. - The `RateLimit-Limit` header contains the total number of requests you can perform per hour. - The `RateLimit-Remaining` header contains the number of requests remaining in the current rate limit time frame. - The `RateLimit-Reset` header contains a UNIX timestamp of the point in time when your rate limit will have recovered and you will have the full number of requests available again. The default limit is 3600 requests per hour and per Project. The number of remaining requests increases gradually. For example, when your limit is 3600 requests per hour, the number of remaining requests will increase by 1 every second. ## Server Metadata Your Server can discover metadata about itself by doing a HTTP request to specific URLs. The following data is available: | Data | Format | Contents | | ----------------- | ------ | ------------------------------------------------------------ | | hostname | text | Name of the Server as set in the api | | instance-id | number | ID of the server | | public-ipv4 | text | Primary public IPv4 address | | private-networks | yaml | Details about the private networks the Server is attached to | | availability-zone | text | Name of the availability zone that Server runs in | | region | text | Network zone, e.g. eu-central | **Example: Summary** ```bash $ curl http://169.254.169.254/hetzner/v1/metadata ``` ```yaml availability-zone: hel1-dc2 hostname: my-server instance-id: 42 public-ipv4: 1.2.3.4 region: eu-central ``` **Example: Hostname** ```bash $ curl http://169.254.169.254/hetzner/v1/metadata/hostname my-server ``` **Example: Instance ID** ```bash $ curl http://169.254.169.254/hetzner/v1/metadata/instance-id 42 ``` **Example: Public IPv4** ```bash $ curl http://169.254.169.254/hetzner/v1/metadata/public-ipv4 1.2.3.4 ``` **Example: Private Networks** ```bash $ curl http://169.254.169.254/hetzner/v1/metadata/private-networks ``` ```yaml - ip: 10.0.0.2 alias_ips: [10.0.0.3, 10.0.0.4] interface_num: 1 mac_address: 86:00:00:2a:7d:e0 network_id: 1234 network_name: nw-test1 network: 10.0.0.0/8 subnet: 10.0.0.0/24 gateway: 10.0.0.1 - ip: 192.168.0.2 alias_ips: [] interface_num: 2 mac_address: 86:00:00:2a:7d:e1 network_id: 4321 network_name: nw-test2 network: 192.168.0.0/16 subnet: 192.168.0.0/24 gateway: 192.168.0.1 ``` **Example: Availability Zone** ```bash $ curl http://169.254.169.254/hetzner/v1/metadata/availability-zone hel1-dc2 ``` **Example: Region** ```bash $ curl http://169.254.169.254/hetzner/v1/metadata/region eu-central ``` ## Sorting Some responses which return multiple items support sorting. If they do support sorting the documentation states which fields can be used for sorting. You specify sorting with the `sort` query string parameter. You can sort by multiple fields. You can set the sort direction by appending `:asc` or `:desc` to the field name. By default, ascending sorting is used. **Example: Sorting** ``` https://api.hetzner.cloud/v1/actions?sort=status https://api.hetzner.cloud/v1/actions?sort=status:asc https://api.hetzner.cloud/v1/actions?sort=status:desc https://api.hetzner.cloud/v1/actions?sort=status:asc&sort=command:desc ``` ## Deprecation Notices You can find all announced deprecations in our [Changelog](/changelog).
|
||
*
|
||
* The version of the OpenAPI document: 1.0.0
|
||
*
|
||
*
|
||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||
* https://openapi-generator.tech
|
||
* Do not edit the class manually.
|
||
*/
|
||
|
||
|
||
import localVarRequest from 'request';
|
||
import http from 'http';
|
||
|
||
/* tslint:disable:no-unused-locals */
|
||
import { ActionResponse } from '../model/actionResponse';
|
||
import { ActionsResponse } from '../model/actionsResponse';
|
||
import { AddToPlacementGroupRequest } from '../model/addToPlacementGroupRequest';
|
||
import { AttachToNetworkRequest } from '../model/attachToNetworkRequest';
|
||
import { CreateImageRequest } from '../model/createImageRequest';
|
||
import { DetachFromNetworkRequest } from '../model/detachFromNetworkRequest';
|
||
import { RebuildServerRequest } from '../model/rebuildServerRequest';
|
||
import { ServersIdActionsAttachIsoPostRequest } from '../model/serversIdActionsAttachIsoPostRequest';
|
||
import { ServersIdActionsChangeAliasIpsPostRequest } from '../model/serversIdActionsChangeAliasIpsPostRequest';
|
||
import { ServersIdActionsChangeDnsPtrPostRequest } from '../model/serversIdActionsChangeDnsPtrPostRequest';
|
||
import { ServersIdActionsChangeProtectionPostRequest } from '../model/serversIdActionsChangeProtectionPostRequest';
|
||
import { ServersIdActionsChangeTypePostRequest } from '../model/serversIdActionsChangeTypePostRequest';
|
||
import { ServersIdActionsCreateImagePost201Response } from '../model/serversIdActionsCreateImagePost201Response';
|
||
import { ServersIdActionsEnableRescuePost201Response } from '../model/serversIdActionsEnableRescuePost201Response';
|
||
import { ServersIdActionsEnableRescuePostRequest } from '../model/serversIdActionsEnableRescuePostRequest';
|
||
import { ServersIdActionsRebuildPost201Response } from '../model/serversIdActionsRebuildPost201Response';
|
||
import { ServersIdActionsRequestConsolePost201Response } from '../model/serversIdActionsRequestConsolePost201Response';
|
||
|
||
import { ObjectSerializer, Authentication, VoidAuth, Interceptor } from '../model/models';
|
||
import { HttpBasicAuth, HttpBearerAuth, ApiKeyAuth, OAuth } from '../model/models';
|
||
|
||
import { HttpError, RequestFile } from './apis';
|
||
|
||
let defaultBasePath = 'https://api.hetzner.cloud/v1';
|
||
|
||
// ===============================================
|
||
// This file is autogenerated - Please do not edit
|
||
// ===============================================
|
||
|
||
export enum ServerActionsApiApiKeys {
|
||
}
|
||
|
||
export class ServerActionsApi {
|
||
protected _basePath = defaultBasePath;
|
||
protected _defaultHeaders : any = {};
|
||
protected _useQuerystring : boolean = false;
|
||
|
||
protected authentications = {
|
||
'default': <Authentication>new VoidAuth(),
|
||
'APIToken': new HttpBearerAuth(),
|
||
}
|
||
|
||
protected interceptors: Interceptor[] = [];
|
||
|
||
constructor(basePath?: string);
|
||
constructor(basePathOrUsername: string, password?: string, basePath?: string) {
|
||
if (password) {
|
||
if (basePath) {
|
||
this.basePath = basePath;
|
||
}
|
||
} else {
|
||
if (basePathOrUsername) {
|
||
this.basePath = basePathOrUsername
|
||
}
|
||
}
|
||
}
|
||
|
||
set useQuerystring(value: boolean) {
|
||
this._useQuerystring = value;
|
||
}
|
||
|
||
set basePath(basePath: string) {
|
||
this._basePath = basePath;
|
||
}
|
||
|
||
set defaultHeaders(defaultHeaders: any) {
|
||
this._defaultHeaders = defaultHeaders;
|
||
}
|
||
|
||
get defaultHeaders() {
|
||
return this._defaultHeaders;
|
||
}
|
||
|
||
get basePath() {
|
||
return this._basePath;
|
||
}
|
||
|
||
public setDefaultAuthentication(auth: Authentication) {
|
||
this.authentications.default = auth;
|
||
}
|
||
|
||
public setApiKey(key: ServerActionsApiApiKeys, value: string) {
|
||
(this.authentications as any)[ServerActionsApiApiKeys[key]].apiKey = value;
|
||
}
|
||
|
||
set accessToken(accessToken: string | (() => string)) {
|
||
this.authentications.APIToken.accessToken = accessToken;
|
||
}
|
||
|
||
public addInterceptor(interceptor: Interceptor) {
|
||
this.interceptors.push(interceptor);
|
||
}
|
||
|
||
/**
|
||
* Returns all Action objects. You can `sort` the results by using the sort URI parameter, and filter them with the `status` and `id` parameter.
|
||
* @summary Get all Actions
|
||
* @param id Can be used multiple times, the response will contain only Actions with specified IDs.
|
||
* @param sort Can be used multiple times.
|
||
* @param status Can be used multiple times, the response will contain only Actions with specified statuses
|
||
* @param page Page to load.
|
||
* @param perPage Items to load per page.
|
||
*/
|
||
public async serversActionsGet (id?: number, sort?: 'id' | 'id:asc' | 'id:desc' | 'command' | 'command:asc' | 'command:desc' | 'status' | 'status:asc' | 'status:desc' | 'started' | 'started:asc' | 'started:desc' | 'finished' | 'finished:asc' | 'finished:desc', status?: 'running' | 'success' | 'error', page?: number, perPage?: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionsResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/actions';
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
if (id !== undefined) {
|
||
localVarQueryParameters['id'] = ObjectSerializer.serialize(id, "number");
|
||
}
|
||
|
||
if (sort !== undefined) {
|
||
localVarQueryParameters['sort'] = ObjectSerializer.serialize(sort, "'id' | 'id:asc' | 'id:desc' | 'command' | 'command:asc' | 'command:desc' | 'status' | 'status:asc' | 'status:desc' | 'started' | 'started:asc' | 'started:desc' | 'finished' | 'finished:asc' | 'finished:desc'");
|
||
}
|
||
|
||
if (status !== undefined) {
|
||
localVarQueryParameters['status'] = ObjectSerializer.serialize(status, "'running' | 'success' | 'error'");
|
||
}
|
||
|
||
if (page !== undefined) {
|
||
localVarQueryParameters['page'] = ObjectSerializer.serialize(page, "number");
|
||
}
|
||
|
||
if (perPage !== undefined) {
|
||
localVarQueryParameters['per_page'] = ObjectSerializer.serialize(perPage, "number");
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'GET',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionsResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionsResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Returns a specific Action object.
|
||
* @summary Get an Action
|
||
* @param id ID of the Action.
|
||
*/
|
||
public async serversActionsIdGet (id: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/actions/{id}'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversActionsIdGet.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'GET',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Returns a specific Action object for a Server.
|
||
* @summary Get an Action for a Server
|
||
* @param id ID of the Server
|
||
* @param actionId ID of the Action
|
||
*/
|
||
public async serversIdActionsActionIdGet (id: number, actionId: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/{action_id}'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)))
|
||
.replace('{' + 'action_id' + '}', encodeURIComponent(String(actionId)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsActionIdGet.');
|
||
}
|
||
|
||
// verify required parameter 'actionId' is not null or undefined
|
||
if (actionId === null || actionId === undefined) {
|
||
throw new Error('Required parameter actionId was null or undefined when calling serversIdActionsActionIdGet.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'GET',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Adds a Server to a Placement Group. Server must be powered off for this command to succeed. #### Call specific error codes | Code | Description | |-------------------------------|----------------------------------------------------------------------| | `server_not_stopped` | The action requires a stopped server |
|
||
* @summary Add a Server to a Placement Group
|
||
* @param id ID of the Server
|
||
* @param addToPlacementGroupRequest
|
||
*/
|
||
public async serversIdActionsAddToPlacementGroupPost (id: number, addToPlacementGroupRequest?: AddToPlacementGroupRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/add_to_placement_group'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsAddToPlacementGroupPost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
body: ObjectSerializer.serialize(addToPlacementGroupRequest, "AddToPlacementGroupRequest")
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Attaches an ISO to a Server. The Server will immediately see it as a new disk. An already attached ISO will automatically be detached before the new ISO is attached. Servers with attached ISOs have a modified boot order: They will try to boot from the ISO first before falling back to hard disk.
|
||
* @summary Attach an ISO to a Server
|
||
* @param id ID of the Server
|
||
* @param serversIdActionsAttachIsoPostRequest
|
||
*/
|
||
public async serversIdActionsAttachIsoPost (id: number, serversIdActionsAttachIsoPostRequest?: ServersIdActionsAttachIsoPostRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/attach_iso'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsAttachIsoPost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
body: ObjectSerializer.serialize(serversIdActionsAttachIsoPostRequest, "ServersIdActionsAttachIsoPostRequest")
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Attaches a Server to a network. This will complement the fixed public Server interface by adding an additional ethernet interface to the Server which is connected to the specified network. The Server will get an IP auto assigned from a subnet of type `server` in the same `network_zone`. Using the `alias_ips` attribute you can also define one or more additional IPs to the Servers. Please note that you will have to configure these IPs by hand on your Server since only the primary IP will be given out by DHCP. **Call specific error codes** | Code | Description | |----------------------------------|-----------------------------------------------------------------------| | `server_already_attached` | The server is already attached to the network | | `ip_not_available` | The provided Network IP is not available | | `no_subnet_available` | No Subnet or IP is available for the Server within the network | | `networks_overlap` | The network IP range overlaps with one of the server networks |
|
||
* @summary Attach a Server to a Network
|
||
* @param id ID of the Server
|
||
* @param attachToNetworkRequest
|
||
*/
|
||
public async serversIdActionsAttachToNetworkPost (id: number, attachToNetworkRequest?: AttachToNetworkRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/attach_to_network'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsAttachToNetworkPost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
body: ObjectSerializer.serialize(attachToNetworkRequest, "AttachToNetworkRequest")
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Changes the alias IPs of an already attached Network. Note that the existing aliases for the specified Network will be replaced with these provided in the request body. So if you want to add an alias IP, you have to provide the existing ones from the Network plus the new alias IP in the request body.
|
||
* @summary Change alias IPs of a Network
|
||
* @param id ID of the Server
|
||
* @param serversIdActionsChangeAliasIpsPostRequest
|
||
*/
|
||
public async serversIdActionsChangeAliasIpsPost (id: number, serversIdActionsChangeAliasIpsPostRequest?: ServersIdActionsChangeAliasIpsPostRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/change_alias_ips'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsChangeAliasIpsPost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
body: ObjectSerializer.serialize(serversIdActionsChangeAliasIpsPostRequest, "ServersIdActionsChangeAliasIpsPostRequest")
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Changes the hostname that will appear when getting the hostname belonging to the primary IPs (IPv4 and IPv6) of this Server. Floating IPs assigned to the Server are not affected by this.
|
||
* @summary Change reverse DNS entry for this Server
|
||
* @param id ID of the Server
|
||
* @param serversIdActionsChangeDnsPtrPostRequest Select the IP address for which to change the DNS entry by passing `ip`. It can be either IPv4 or IPv6. The target hostname is set by passing `dns_ptr`.
|
||
*/
|
||
public async serversIdActionsChangeDnsPtrPost (id: number, serversIdActionsChangeDnsPtrPostRequest?: ServersIdActionsChangeDnsPtrPostRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/change_dns_ptr'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsChangeDnsPtrPost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
body: ObjectSerializer.serialize(serversIdActionsChangeDnsPtrPostRequest, "ServersIdActionsChangeDnsPtrPostRequest")
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Changes the protection configuration of the Server.
|
||
* @summary Change Server Protection
|
||
* @param id ID of the Server
|
||
* @param serversIdActionsChangeProtectionPostRequest
|
||
*/
|
||
public async serversIdActionsChangeProtectionPost (id: number, serversIdActionsChangeProtectionPostRequest?: ServersIdActionsChangeProtectionPostRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/change_protection'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsChangeProtectionPost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
body: ObjectSerializer.serialize(serversIdActionsChangeProtectionPostRequest, "ServersIdActionsChangeProtectionPostRequest")
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Changes the type (Cores, RAM and disk sizes) of a Server. Server must be powered off for this command to succeed. This copies the content of its disk, and starts it again. You can only migrate to Server types with the same `storage_type` and equal or bigger disks. Shrinking disks is not possible as it might destroy data. If the disk gets upgraded, the Server type can not be downgraded any more. If you plan to downgrade the Server type, set `upgrade_disk` to `false`. #### Call specific error codes | Code | Description | |-------------------------------|----------------------------------------------------------------------| | `invalid_server_type` | The server type does not fit for the given server or is deprecated | | `server_not_stopped` | The action requires a stopped server |
|
||
* @summary Change the Type of a Server
|
||
* @param id ID of the Server
|
||
* @param serversIdActionsChangeTypePostRequest
|
||
*/
|
||
public async serversIdActionsChangeTypePost (id: number, serversIdActionsChangeTypePostRequest?: ServersIdActionsChangeTypePostRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/change_type'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsChangeTypePost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
body: ObjectSerializer.serialize(serversIdActionsChangeTypePostRequest, "ServersIdActionsChangeTypePostRequest")
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Creates an Image (snapshot) from a Server by copying the contents of its disks. This creates a snapshot of the current state of the disk and copies it into an Image. If the Server is currently running you must make sure that its disk content is consistent. Otherwise, the created Image may not be readable. To make sure disk content is consistent, we recommend to shut down the Server prior to creating an Image. You can either create a `backup` Image that is bound to the Server and therefore will be deleted when the Server is deleted, or you can create an `snapshot` Image which is completely independent of the Server it was created from and will survive Server deletion. Backup Images are only available when the backup option is enabled for the Server. Snapshot Images are billed on a per GB basis.
|
||
* @summary Create Image from a Server
|
||
* @param id ID of the Server
|
||
* @param createImageRequest
|
||
*/
|
||
public async serversIdActionsCreateImagePost (id: number, createImageRequest?: CreateImageRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ServersIdActionsCreateImagePost201Response; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/create_image'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsCreateImagePost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
body: ObjectSerializer.serialize(createImageRequest, "CreateImageRequest")
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ServersIdActionsCreateImagePost201Response; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ServersIdActionsCreateImagePost201Response");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Detaches a Server from a network. The interface for this network will vanish.
|
||
* @summary Detach a Server from a Network
|
||
* @param id ID of the Server
|
||
* @param detachFromNetworkRequest
|
||
*/
|
||
public async serversIdActionsDetachFromNetworkPost (id: number, detachFromNetworkRequest?: DetachFromNetworkRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/detach_from_network'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsDetachFromNetworkPost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
body: ObjectSerializer.serialize(detachFromNetworkRequest, "DetachFromNetworkRequest")
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Detaches an ISO from a Server. In case no ISO Image is attached to the Server, the status of the returned Action is immediately set to `success`
|
||
* @summary Detach an ISO from a Server
|
||
* @param id ID of the Server
|
||
*/
|
||
public async serversIdActionsDetachIsoPost (id: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/detach_iso'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsDetachIsoPost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Disables the automatic backup option and deletes all existing Backups for a Server. No more additional charges for backups will be made. Caution: This immediately removes all existing backups for the Server!
|
||
* @summary Disable Backups for a Server
|
||
* @param id ID of the Server
|
||
*/
|
||
public async serversIdActionsDisableBackupPost (id: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/disable_backup'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsDisableBackupPost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Disables the Hetzner Rescue System for a Server. This makes a Server start from its disks on next reboot. Rescue Mode is automatically disabled when you first boot into it or if you do not use it for 60 minutes. Disabling rescue mode will not reboot your Server — you will have to do this yourself.
|
||
* @summary Disable Rescue Mode for a Server
|
||
* @param id ID of the Server
|
||
*/
|
||
public async serversIdActionsDisableRescuePost (id: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/disable_rescue'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsDisableRescuePost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Enables and configures the automatic daily backup option for the Server. Enabling automatic backups will increase the price of the Server by 20%. In return, you will get seven slots where Images of type backup can be stored. Backups are automatically created daily.
|
||
* @summary Enable and Configure Backups for a Server
|
||
* @param id ID of the Server
|
||
*/
|
||
public async serversIdActionsEnableBackupPost (id: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/enable_backup'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsEnableBackupPost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Enable the Hetzner Rescue System for this Server. The next time a Server with enabled rescue mode boots it will start a special minimal Linux distribution designed for repair and reinstall. In case a Server cannot boot on its own you can use this to access a Server’s disks. Rescue Mode is automatically disabled when you first boot into it or if you do not use it for 60 minutes. Enabling rescue mode will not [reboot](https://docs.hetzner.cloud/#server-actions-soft-reboot-a-server) your Server — you will have to do this yourself.
|
||
* @summary Enable Rescue Mode for a Server
|
||
* @param id ID of the Server
|
||
* @param serversIdActionsEnableRescuePostRequest
|
||
*/
|
||
public async serversIdActionsEnableRescuePost (id: number, serversIdActionsEnableRescuePostRequest?: ServersIdActionsEnableRescuePostRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ServersIdActionsEnableRescuePost201Response; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/enable_rescue'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsEnableRescuePost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
body: ObjectSerializer.serialize(serversIdActionsEnableRescuePostRequest, "ServersIdActionsEnableRescuePostRequest")
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ServersIdActionsEnableRescuePost201Response; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ServersIdActionsEnableRescuePost201Response");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Returns all Action objects for a Server. You can `sort` the results by using the sort URI parameter, and filter them with the `status` parameter.
|
||
* @summary Get all Actions for a Server
|
||
* @param id ID of the Action.
|
||
* @param sort Can be used multiple times.
|
||
* @param status Can be used multiple times, the response will contain only Actions with specified statuses
|
||
* @param page Page to load.
|
||
* @param perPage Items to load per page.
|
||
*/
|
||
public async serversIdActionsGet (id: number, sort?: 'id' | 'id:asc' | 'id:desc' | 'command' | 'command:asc' | 'command:desc' | 'status' | 'status:asc' | 'status:desc' | 'started' | 'started:asc' | 'started:desc' | 'finished' | 'finished:asc' | 'finished:desc', status?: 'running' | 'success' | 'error', page?: number, perPage?: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionsResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsGet.');
|
||
}
|
||
|
||
if (sort !== undefined) {
|
||
localVarQueryParameters['sort'] = ObjectSerializer.serialize(sort, "'id' | 'id:asc' | 'id:desc' | 'command' | 'command:asc' | 'command:desc' | 'status' | 'status:asc' | 'status:desc' | 'started' | 'started:asc' | 'started:desc' | 'finished' | 'finished:asc' | 'finished:desc'");
|
||
}
|
||
|
||
if (status !== undefined) {
|
||
localVarQueryParameters['status'] = ObjectSerializer.serialize(status, "'running' | 'success' | 'error'");
|
||
}
|
||
|
||
if (page !== undefined) {
|
||
localVarQueryParameters['page'] = ObjectSerializer.serialize(page, "number");
|
||
}
|
||
|
||
if (perPage !== undefined) {
|
||
localVarQueryParameters['per_page'] = ObjectSerializer.serialize(perPage, "number");
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'GET',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionsResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionsResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Cuts power to the Server. This forcefully stops it without giving the Server operating system time to gracefully stop. May lead to data loss, equivalent to pulling the power cord. Power off should only be used when shutdown does not work.
|
||
* @summary Power off a Server
|
||
* @param id ID of the Server
|
||
*/
|
||
public async serversIdActionsPoweroffPost (id: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/poweroff'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsPoweroffPost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Starts a Server by turning its power on.
|
||
* @summary Power on a Server
|
||
* @param id ID of the Server
|
||
*/
|
||
public async serversIdActionsPoweronPost (id: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/poweron'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsPoweronPost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Reboots a Server gracefully by sending an ACPI request. The Server operating system must support ACPI and react to the request, otherwise the Server will not reboot.
|
||
* @summary Soft-reboot a Server
|
||
* @param id ID of the Server
|
||
*/
|
||
public async serversIdActionsRebootPost (id: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/reboot'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsRebootPost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Rebuilds a Server overwriting its disk with the content of an Image, thereby **destroying all data** on the target Server The Image can either be one you have created earlier (`backup` or `snapshot` Image) or it can be a completely fresh `system` Image provided by us. You can get a list of all available Images with `GET /images`. Your Server will automatically be powered off before the rebuild command executes.
|
||
* @summary Rebuild a Server from an Image
|
||
* @param id ID of the Server
|
||
* @param rebuildServerRequest To select which Image to rebuild from you can either pass an ID or a name as the `image` argument. Passing a name only works for `system` Images since the other Image types do not have a name set.
|
||
*/
|
||
public async serversIdActionsRebuildPost (id: number, rebuildServerRequest?: RebuildServerRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ServersIdActionsRebuildPost201Response; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/rebuild'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsRebuildPost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
body: ObjectSerializer.serialize(rebuildServerRequest, "RebuildServerRequest")
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ServersIdActionsRebuildPost201Response; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ServersIdActionsRebuildPost201Response");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Removes a Server from a Placement Group.
|
||
* @summary Remove from Placement Group
|
||
* @param id ID of the Server
|
||
*/
|
||
public async serversIdActionsRemoveFromPlacementGroupPost (id: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/remove_from_placement_group'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsRemoveFromPlacementGroupPost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Requests credentials for remote access via VNC over websocket to keyboard, monitor, and mouse for a Server. The provided URL is valid for 1 minute, after this period a new url needs to be created to connect to the Server. How long the connection is open after the initial connect is not subject to this timeout.
|
||
* @summary Request Console for a Server
|
||
* @param id ID of the Server
|
||
*/
|
||
public async serversIdActionsRequestConsolePost (id: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ServersIdActionsRequestConsolePost201Response; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/request_console'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsRequestConsolePost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ServersIdActionsRequestConsolePost201Response; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ServersIdActionsRequestConsolePost201Response");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Resets the root password. Only works for Linux systems that are running the qemu guest agent. Server must be powered on (status `running`) in order for this operation to succeed. This will generate a new password for this Server and return it. If this does not succeed you can use the rescue system to netboot the Server and manually change your Server password by hand.
|
||
* @summary Reset root Password of a Server
|
||
* @param id ID of the Server
|
||
*/
|
||
public async serversIdActionsResetPasswordPost (id: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ServersIdActionsEnableRescuePost201Response; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/reset_password'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsResetPasswordPost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ServersIdActionsEnableRescuePost201Response; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ServersIdActionsEnableRescuePost201Response");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Cuts power to a Server and starts it again. This forcefully stops it without giving the Server operating system time to gracefully stop. This may lead to data loss, it’s equivalent to pulling the power cord and plugging it in again. Reset should only be used when reboot does not work.
|
||
* @summary Reset a Server
|
||
* @param id ID of the Server
|
||
*/
|
||
public async serversIdActionsResetPost (id: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/reset'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsResetPost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
/**
|
||
* Shuts down a Server gracefully by sending an ACPI shutdown request. The Server operating system must support ACPI and react to the request, otherwise the Server will not shut down. Please note that the `action` status in this case only reflects whether the action was sent to the server. It does not mean that the server actually shut down successfully. If you need to ensure that the server is off, use the `poweroff` action
|
||
* @summary Shutdown a Server
|
||
* @param id ID of the Server
|
||
*/
|
||
public async serversIdActionsShutdownPost (id: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: ActionResponse; }> {
|
||
const localVarPath = this.basePath + '/servers/{id}/actions/shutdown'
|
||
.replace('{' + 'id' + '}', encodeURIComponent(String(id)));
|
||
let localVarQueryParameters: any = {};
|
||
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
||
const produces = ['application/json'];
|
||
// give precedence to 'application/json'
|
||
if (produces.indexOf('application/json') >= 0) {
|
||
localVarHeaderParams.Accept = 'application/json';
|
||
} else {
|
||
localVarHeaderParams.Accept = produces.join(',');
|
||
}
|
||
let localVarFormParams: any = {};
|
||
|
||
// verify required parameter 'id' is not null or undefined
|
||
if (id === null || id === undefined) {
|
||
throw new Error('Required parameter id was null or undefined when calling serversIdActionsShutdownPost.');
|
||
}
|
||
|
||
(<any>Object).assign(localVarHeaderParams, options.headers);
|
||
|
||
let localVarUseFormData = false;
|
||
|
||
let localVarRequestOptions: localVarRequest.Options = {
|
||
method: 'POST',
|
||
qs: localVarQueryParameters,
|
||
headers: localVarHeaderParams,
|
||
uri: localVarPath,
|
||
useQuerystring: this._useQuerystring,
|
||
json: true,
|
||
};
|
||
|
||
let authenticationPromise = Promise.resolve();
|
||
if (this.authentications.APIToken.accessToken) {
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.APIToken.applyToRequest(localVarRequestOptions));
|
||
}
|
||
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
||
|
||
let interceptorPromise = authenticationPromise;
|
||
for (const interceptor of this.interceptors) {
|
||
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
||
}
|
||
|
||
return interceptorPromise.then(() => {
|
||
if (Object.keys(localVarFormParams).length) {
|
||
if (localVarUseFormData) {
|
||
(<any>localVarRequestOptions).formData = localVarFormParams;
|
||
} else {
|
||
localVarRequestOptions.form = localVarFormParams;
|
||
}
|
||
}
|
||
return new Promise<{ response: http.IncomingMessage; body: ActionResponse; }>((resolve, reject) => {
|
||
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
||
if (error) {
|
||
reject(error);
|
||
} else {
|
||
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
||
body = ObjectSerializer.deserialize(body, "ActionResponse");
|
||
resolve({ response: response, body: body });
|
||
} else {
|
||
reject(new HttpError(response, body, response.statusCode));
|
||
}
|
||
}
|
||
});
|
||
});
|
||
});
|
||
}
|
||
}
|