ContractApi
All URIs are relative to https://api.ionos.com/cloudapi/v5
contractsGet
contractsGet(opts)
Retrieve a Contract
Retrieves the attributes of user's contract.
Examples
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.ContractApi(config);
// Retrieve a Contract
api_instance
.contractsGet({
pretty: true,
depth: 56,
xContractNumber: 56
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));
Parameters
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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's children are included - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
Last updated