API docs by Redocly

Reseller API (2.0)

Download OpenAPI specification:Download

API allowing resellers to create and manage contracts

Admin

Get all admin users of the contract

You can retrieve a complete list of admin users of the contract

Authorizations:
BasicAuthenticationTokenAuthentication
path Parameters
contractNumber
required
integer <int64>

Responses

Response samples

Content type
application/json
[]

Create new admin user for contract

Authorizations:
BasicAuthenticationTokenAuthentication
path Parameters
contractNumber
required
integer <int64>
Request Body schema: application/json
firstName
required
string

first name of the user

lastName
required
string

last name of the user

email
required
string

email of the user

password
required
string

password of the user

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{}

Find admin by ID

Authorizations:
BasicAuthenticationTokenAuthentication
path Parameters
contractNumber
required
integer <int64>
adminId
required
integer <int64>

Responses

Response samples

Content type
application/json
{}

Delete admin user

This method call will remove admin user from the contract. This is a highly destructive method and must be used with caution.

Authorizations:
BasicAuthenticationTokenAuthentication
path Parameters
contractNumber
required
integer <int64>
adminId
required
integer <int64>

Responses

Response samples

Content type
application/json
{ }

Partially update admin user

You can use this method to partially update admin user properties (firstName and/or lastName and/or email)

Authorizations:
BasicAuthenticationTokenAuthentication
path Parameters
contractNumber
required
integer <int64>
adminId
required
integer <int64>
Request Body schema: application/json
firstName
required
string

first name of the user

lastName
required
string

last name of the user

email
required
string

email of the user

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string"
}

Response samples

Content type
application/json
{}

Contract

Get all contracts

Retrieve a paginated list of contracts, provisioned under the Master Reseller contract. Default limit is the first 50 items; use pagination query parameters for listing more items.

Authorizations:
BasicAuthenticationTokenAuthentication
query Parameters
offset
integer <int32> >= 0
Default: 0

The first element (from the complete list of the elements) to include in the response (used together with limit for pagination).

limit
integer <int32> [ 1 .. 5000 ]
Default: 50

The maximum number of elements to return (use together with offset for pagination).

filter.status
string

Filter the list by contract status [BILLABLE, CEASED, REJECTED].

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "offset": 0,
  • "limit": 1000,
  • "_links": {
    }
}

Create new contract

Authorizations:
BasicAuthenticationTokenAuthentication
Request Body schema: application/json
name
required
string

name of the contract

resellerReference
string

reseller reference of the contract

required
object (ResourceLimits)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "resellerReference": "string",
  • "resourceLimits": {
    }
}

Response samples

Content type
application/json
{
  • "id": "15514",
  • "href": "https://api.ionos.com/reseller/v2/contract/15514",
  • "name": "string",
  • "resellerReference": "string",
  • "status": "string",
  • "resourceLimits": {
    }
}

Update contract name

Authorizations:
BasicAuthenticationTokenAuthentication
path Parameters
contractNumber
required
integer <int64>
Request Body schema: text/plain
string

Responses

Response samples

Content type
application/json
{
  • "id": "15514",
  • "href": "https://api.ionos.com/reseller/v2/contract/15514",
  • "name": "string",
  • "resellerReference": "string",
  • "status": "string",
  • "resourceLimits": {
    }
}

Update resource limits for contract

Authorizations:
BasicAuthenticationTokenAuthentication
path Parameters
contractNumber
required
integer <int64>
Request Body schema: application/json
ramServerMax
required
integer <int32>

maximum ram per virtual machine

cpuServerMax
required
integer <int32>

maximum number of cpu per virtual machine

hddVolumeMaxSize
required
integer <int32>

maximum hdd volume size

ssdVolumeMaxSize
required
integer <int32>

maximum ssd volume size

ramContractMax
required
integer <int32>

maximum ram per contract

cpuContractMax
required
integer <int32>

maximum cpu per contract

hddVolumeContractMaxSize
required
integer <int32>

maximum hhd volume per contract

ssdVolumeContractMaxSize
required
integer <int32>

maximum ssd volume per contract

ips
required
integer <int32>

maximum ips per contract

Responses

Request samples

Content type
application/json
{
  • "ramServerMax": 0,
  • "cpuServerMax": 0,
  • "hddVolumeMaxSize": 0,
  • "ssdVolumeMaxSize": 0,
  • "ramContractMax": 0,
  • "cpuContractMax": 0,
  • "hddVolumeContractMaxSize": 0,
  • "ssdVolumeContractMaxSize": 0,
  • "ips": 0
}

Response samples

Content type
application/json
{
  • "id": "15514",
  • "href": "https://api.ionos.com/reseller/v2/contract/15514",
  • "name": "string",
  • "resellerReference": "string",
  • "status": "string",
  • "resourceLimits": {
    }
}

Find contract by ID

Authorizations:
BasicAuthenticationTokenAuthentication
path Parameters
contractNumber
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": "15514",
  • "href": "https://api.ionos.com/reseller/v2/contract/15514",
  • "name": "string",
  • "resellerReference": "string",
  • "status": "string",
  • "resourceLimits": {
    }
}

Update contract

Authorizations:
BasicAuthenticationTokenAuthentication
path Parameters
contractNumber
required
integer <int64>
Request Body schema: application/json
name
required
string

name of the contract

resellerReference
string

reseller reference of the contract

required
object (ResourceLimits)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "resellerReference": "string",
  • "resourceLimits": {
    }
}

Response samples

Content type
application/json
{
  • "id": "15514",
  • "href": "https://api.ionos.com/reseller/v2/contract/15514",
  • "name": "string",
  • "resellerReference": "string",
  • "status": "string",
  • "resourceLimits": {
    }
}

/