ContractResourcesApi
Last updated
Last updated
All URIs are relative to https://api.ionos.com/cloudapi/v6
Method | HTTP request | Description |
---|---|---|
Contracts contractsGet(pretty, depth, xContractNumber)
Get Contract Information
Retrieves the properties of the user's contract. This operation allows you to obtain the resource limits and the general contract information.
Name | Type | Description | Notes |
---|---|---|---|
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the contractsGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use contractsGet instead
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
GET /contracts
Get Contract Information
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
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's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
orderBy
String
Sorts the results alphanumerically in ascending order based on the specified property.
[optional]
maxResults
Integer
Limits the number of results returned.
[optional]
filters
Map<String, String>
Limit results to those containing a matching value for a specific property.
[optional]