Links

DefaultApi

All URIs are relative to https://api.ionos.com/cloudapi/v6
Method
HTTP request
Description
GET /
Get API information

apiInfoGet

apiInfoGet(opts)
Get API information
Retrieves the API information such as API version.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
});
const api_instance = new ionoscloud.DefaultApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Get API information
api_instance
.apiInfoGet({
pretty: true,
depth: 56,
xContractNumber: 56
orderBy: "<property_name>"
maxResults: 2,
filters: filterMap
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]

Return type

Info

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json