InformationApi

All URIs are relative to https://api.ionos.com

getInfo

getInfo

Get the Service API Information

Retrieves the service API information.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs-cert-manager');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.InformationApi(config);
// Get the Service API Information
api_instance
  .getInfo()
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

This endpoint does not need any parameter.

Return type

ApiInfoDto

Authorization

basicAuth, tokenAuth

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

getJsonOpenApiSpec

any getJsonOpenApiSpec

Get the Open API Documentation JSON

Displays the Open API documentation in the JSON format.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs-cert-manager');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.InformationApi(config);
// Get the Open API Documentation JSON
api_instance
  .getJsonOpenApiSpec()
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

This endpoint does not need any parameter.

Return type

any

Authorization

basicAuth, tokenAuth

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

getYamlOpenApiSpec

any getYamlOpenApiSpec

Get the Open API Documentation YAML

Displays the Open API documentation in the YAML format.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs-cert-manager');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.InformationApi(config);
// Get the Open API Documentation YAML
api_instance
  .getYamlOpenApiSpec()
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

This endpoint does not need any parameter.

Return type

any

Authorization

basicAuth, tokenAuth

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/yaml

Last updated