259 lines
25 KiB
TypeScript
259 lines
25 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
|
|||
|
|
*
|
|||
|
|
* 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 { IsosGet200Response } from '../model/isosGet200Response';
|
|||
|
|
import { IsosIdGet200Response } from '../model/isosIdGet200Response';
|
|||
|
|
|
|||
|
|
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 ISOsApiApiKeys {
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
export class ISOsApi {
|
|||
|
|
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: ISOsApiApiKeys, value: string) {
|
|||
|
|
(this.authentications as any)[ISOsApiApiKeys[key]].apiKey = value;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
set accessToken(accessToken: string | (() => string)) {
|
|||
|
|
this.authentications.APIToken.accessToken = accessToken;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
public addInterceptor(interceptor: Interceptor) {
|
|||
|
|
this.interceptors.push(interceptor);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Returns all available ISO objects.
|
|||
|
|
* @summary Get all ISOs
|
|||
|
|
* @param name Can be used to filter ISOs by their name. The response will only contain the ISO matching the specified name.
|
|||
|
|
* @param architecture Return only ISOs with the given architecture.
|
|||
|
|
* @param includeArchitectureWildcard Include Images with wildcard architecture (architecture is null). Works only if architecture filter is specified.
|
|||
|
|
* @param page Page to load.
|
|||
|
|
* @param perPage Items to load per page.
|
|||
|
|
*/
|
|||
|
|
public async isosGet (name?: string, architecture?: string, includeArchitectureWildcard?: boolean, page?: number, perPage?: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: IsosGet200Response; }> {
|
|||
|
|
const localVarPath = this.basePath + '/isos';
|
|||
|
|
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 (name !== undefined) {
|
|||
|
|
localVarQueryParameters['name'] = ObjectSerializer.serialize(name, "string");
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (architecture !== undefined) {
|
|||
|
|
localVarQueryParameters['architecture'] = ObjectSerializer.serialize(architecture, "string");
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (includeArchitectureWildcard !== undefined) {
|
|||
|
|
localVarQueryParameters['include_architecture_wildcard'] = ObjectSerializer.serialize(includeArchitectureWildcard, "boolean");
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
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: IsosGet200Response; }>((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, "IsosGet200Response");
|
|||
|
|
resolve({ response: response, body: body });
|
|||
|
|
} else {
|
|||
|
|
reject(new HttpError(response, body, response.statusCode));
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
}
|
|||
|
|
/**
|
|||
|
|
* Returns a specific ISO object.
|
|||
|
|
* @summary Get an ISO
|
|||
|
|
* @param id ID of the ISO
|
|||
|
|
*/
|
|||
|
|
public async isosIdGet (id: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: IsosIdGet200Response; }> {
|
|||
|
|
const localVarPath = this.basePath + '/isos/{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 isosIdGet.');
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
(<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: IsosIdGet200Response; }>((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, "IsosIdGet200Response");
|
|||
|
|
resolve({ response: response, body: body });
|
|||
|
|
} else {
|
|||
|
|
reject(new HttpError(response, body, response.statusCode));
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
});
|
|||
|
|
}
|
|||
|
|
}
|