API docs by Redocly

Tenantos API Documentation (1.0.0)

Download OpenAPI specification:

Tenantos API

/api/aliasRoles

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

POST api/aliasRoles

The available permissions can be requested via the api/permissions endpoint.

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
name
required
string
permissionlist
Array of strings

Array of single permissions.

permissionsets
Array of strings

Array of permission groups.

userId
integer

Request samples

Content type
application/json
{
  • "name": "est",
  • "permissionlist": [
    ],
  • "permissionsets": [
    ],
  • "userId": 4
}

/api/aliasRoles/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 6

The ID of the role.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "message": "success"
}

PUT api/aliasRoles/{id}

The available permissions can be requested via the api/permissions endpoint.

Authorizations:
default
path Parameters
id
required
integer
Example: 6

The ID of the role.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
name
string
permissionlist
Array of strings

Array of single permissions.

permissionsets
Array of strings

Array of permission groups.

serversIndexDisablePermissionChecks
boolean

Request samples

Content type
application/json
{
  • "name": "recusandae",
  • "permissionlist": [
    ],
  • "permissionsets": [
    ],
  • "serversIndexDisablePermissionChecks": true
}

/api/aliasRoles/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 6

The ID of the role.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

/api/aliasUsers

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

POST api/aliasUsers

API parameters are the same as for the POST api/users endpoint.

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

/api/aliasUsers/{id}

Authorizations:
default
path Parameters
id
required
string
Example: quia

The ID of the aliasUser.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
object
accountstatus
string

Must be one of enabled or disabled.

role_id
integer

Request samples

Content type
application/json
{
  • "user_alias_assignments": [ ],
  • "accountstatus": "disabled",
  • "role_id": 3
}

/api/aliasUsers/{id}

Authorizations:
default
path Parameters
id
required
string
Example: quia

The ID of the aliasUser.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

/api/system/brands/{brand}/logos/store

Authorizations:
default
path Parameters
brand
required
string
Example: ipsam

The brand.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: multipart/form-data
Accept
string
Example: application/json
Request Body schema: multipart/form-data
optional
lightlogo
string <binary>

Must be an image. Must not be greater than 512 kilobytes.

darklogo
string <binary>

Must be an image. Must not be greater than 512 kilobytes.

favicon
string <binary>

Must be an image. Must not be greater than 512 kilobytes.

/api/system/brands/{brand}/logos/delete

Authorizations:
default
path Parameters
brand
required
string
Example: maxime

The brand.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
lightlogo
boolean
darklogo
boolean
favicon
boolean

Request samples

Content type
application/json
{
  • "lightlogo": true,
  • "darklogo": true,
  • "favicon": true
}

/api/system/brands

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/system/brands

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
domain
required
string

The domain for the new brand.

Request samples

Content type
application/json
{
  • "domain": "app.domain.com"
}

/api/system/brands/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the brand.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/system/brands/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the brand.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
login_page_text
string

Text which is shown above the login form.

page_title
string

The page title.

top_navbar_header_title
string

Text which is shown at the left sidebar.

object

Custom color scheme for this brand.

user_id
integer

The owner of the brand. The owner is usually a reseller.

languageOverrides
object

The owner of the brand. The owner is usually a reseller.

navbar_text_instead_logo
boolean
navbar_logo_always_dark
boolean
loginpage_text_instead_logo
boolean
loginpage_logo_always_dark
boolean
loginpage_logo_above_form
boolean
loginpage_show_text_within_form
boolean
navbar_logo_max_height
integer
loginpage_logo_max_height
integer
theme_flat_buttons
boolean
theme_cards_elevation
integer

Must be at least 0. Must not be greater than 25.

theme_cards_outlined
boolean
theme_top_bar_full_length
boolean
theme_serverpage_notes_importantNotes_showOnTop
boolean
default_theme_mode
string

Must be one of light or dark.

Array of objects

Request samples

Content type
application/json
{
  • "login_page_text": "Login To App",
  • "page_title": "Tenantos",
  • "top_navbar_header_title": "Tenantos",
  • "color_scheme": {
    },
  • "user_id": 14,
  • "languageOverrides": {
    },
  • "navbar_text_instead_logo": true,
  • "navbar_logo_always_dark": false,
  • "loginpage_text_instead_logo": true,
  • "loginpage_logo_always_dark": false,
  • "loginpage_logo_above_form": true,
  • "loginpage_show_text_within_form": true,
  • "navbar_logo_max_height": 4,
  • "loginpage_logo_max_height": 6,
  • "theme_flat_buttons": true,
  • "theme_cards_elevation": 19,
  • "theme_cards_outlined": false,
  • "theme_top_bar_full_length": true,
  • "theme_serverpage_notes_importantNotes_showOnTop": true,
  • "default_theme_mode": "dark",
  • "availableLanguages": [
    ]
}

/api/system/brands/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the brand.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

/api/externalProviders

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/externalProviders

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
provider
required
string

Must be one of proxmox, hetznercloud, hetznerdedicated, vmwarevsphere, ovhdedicated, novoserve, interserver, mylocdedicated, innov4web, tailormadeservers, gthost, reliablesite, leaseweb, hostkey, tenantos, or generic.

name
required
string

User definable name. Should be an easily identifiable name.

apiUrl
string
apiUser
string
apiPassword
string
meta
Array of strings

Depending on the provider, additional meta information must be set.

Request samples

Content type
application/json
{
  • "provider": "novoserve",
  • "name": "Host-01",
  • "apiUrl": "proxmox01.domain.com",
  • "apiUser": "root",
  • "apiPassword": "secret",
  • "meta": [ ]
}

/api/externalProviders/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the provider.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/externalProviders/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the provider.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
name
string

User definable name. Should be an easily identifiable name.

apiUrl
string
apiUser
string
apiPassword
string
meta
Array of strings

Depending on the provider, additional meta information must be set.

Request samples

Content type
application/json
{
  • "name": "Host-01",
  • "apiUrl": "proxmox01.domain.com",
  • "apiUser": "root",
  • "apiPassword": "secret",
  • "meta": [ ]
}

/api/externalProviders/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the provider.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Files

To some objects files can be attached (e.g. server comments). This endpoint is used to download and delete these files.

/api/files/{fileId}/download

Authorizations:
default
path Parameters
fileId
required
string
Example: voluptatem
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "message": "Exception",
  • "result": "Access to this file denied or file not found."
}

/api/files/{fileId}

Authorizations:
default
path Parameters
fileId
required
string
Example: neque
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

IP Management

These API endpoints are, by default, only accessible as admin and are not intended for normal users.

/api/ip/massaction

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
mode
required
string

Must be one of reserve, unreserve, delete.

ips
required
Array of strings

An array of IPs or subnets with CIDR where the action should be performed:

type
required
string

Must be one of singleIp or subnet. Use singleIp if the listed values at the "ips" param are IP addresses, or subnet if the values are subnets.

Request samples

Content type
application/json
{
  • "mode": "reserve",
  • "ips": [
    ],
  • "type": "singleIp"
}

/api/ip/reserve

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
adminIp
required
string

Must be a valid IP address or a subnet with CIDR.

type
required
string

Must be one of singleIp or subnet.

Request samples

Content type
application/json
{
  • "adminIp": "10.10.10.20",
  • "type": "singleIp"
}

/api/ip/unreserve

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
adminIp
required
string

Must be a valid IP address or a subnet with CIDR.

type
required
string

Must be one of singleIp or subnet.

Request samples

Content type
application/json
{
  • "adminIp": "10.10.10.20",
  • "type": "singleIp"
}

POST api/ip/comment

If a user wants to create a comment for an IP, the PUT api/servers/{server_id}/ipassignments/{id} endpoint can be used.

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
comment
string

The comment to store. Leave blank to remove the existing comment.

adminIp
required
string

Must be a valid IP address or a subnet with CIDR.

type
required
string

Must be one of singleIp or subnet.

Request samples

Content type
application/json
{
  • "comment": "VPN IP",
  • "adminIp": "10.10.10.20",
  • "type": "singleIp"
}

/api/ip/delete

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
adminIp
required
string
type
required
string

Must be one of singleIp or subnet.

Request samples

Content type
application/json
{
  • "adminIp": "quasi",
  • "type": "subnet"
}

/api/inventorycomponents/customfields

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/inventorycomponents/customfields

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
name
required
string

The name of the custom field.

type
required
string

Must be one of input, checkbox, or dropdown.

availableValues
Array of strings

If the type is dropdown, the submitted values are attached to the custom field.

Request samples

Content type
application/json
{
  • "name": "Datacenter",
  • "type": "dropdown",
  • "availableValues": [
    ]
}

/api/inventorycomponents/customfields/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the inventory component custom field.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/inventorycomponents/customfields/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the inventory component custom field.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
name
string

The name of the custom field.

type
string

Must be one of input, checkbox, or dropdown.

availableValues
Array of strings

If the type is dropdown, the submitted values are attached to the custom field.

Request samples

Content type
application/json
{
  • "name": "Datacenter",
  • "type": "dropdown",
  • "availableValues": [
    ]
}

/api/inventorycomponents/customfields/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the inventory component custom field.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

/api/inventorycomponents

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/inventorycomponents

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
groupname
required
string

The name of the group. For example, "Hardware". Any name can be entered.

description
required
string

A short description.

componentname
required
string

The name of the component.

customfieldsRelations
Array of strings

Multiple custom fields can be attached to a component.

valueType
required
string

The type of the value. Must be one of text, mb (megabyte) or MHz.

Request samples

Content type
application/json
{
  • "groupname": "Software",
  • "description": "Software licenses",
  • "componentname": "Software name",
  • "customfieldsRelations": [
    ],
  • "valueType": "text"
}

/api/inventorycomponents/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the inventory component.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/inventorycomponents/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the inventory component.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
groupname
string

The name of the group. For example, "Hardware". Any name can be entered.

description
string

A short description.

componentname
string

The name of the component.

customfieldsRelations
Array of strings

Multiple custom fields can be attached to a component.

valueType
string

The type of the value. Must be one of text, mb (megabyte) or MHz.

Request samples

Content type
application/json
{
  • "groupname": "Software",
  • "description": "Software licenses",
  • "componentname": "Software name",
  • "customfieldsRelations": [
    ],
  • "valueType": "text"
}

/api/inventorycomponents/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the inventory component.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

POST api/networkDevices/{networkDevice}/actions/testConnectivity

Tests if the connection between the Tenantos main server and the network device does work.

Authorizations:
default
path Parameters
networkDevice
required
integer
Example: 8

The ID of the network device.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
useCache
boolean

The last status of network devices is cached for at least 15 minutes. Submit true to receive the cached status (for faster response).

Request samples

Content type
application/json
{
  • "useCache": true
}

/api/networkDevices

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "EX3200",
  • "host": "192.168.188.223",
  • "deviceType": "snmp_switch",
  • "snmpCommunity": "Aks8gkjsa8a2",
  • "snmpVersion": "2c",
  • "agentId": 1,
  • "features": [
    ],
  • "meta": {
    },
  • "username": "",
  • "password": "",
  • "port": null,
  • "statusCache": [ ],
  • "snmpAuthAlgo": null,
  • "snmpAuthLevel": null,
  • "snmpCryptoAlgo": null,
  • "snmpCryptoPassword": "",
  • "enableAdvancedManagement": 1,
  • "managementVendor": "juniperSsh",
  • "managementPort": "22",
  • "managementUser": "root",
  • "managementPassword": "secret",
  • "rootType": "snmp_switch",
  • "extendedDetailsAvailable": true
}

/api/networkDevices

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
deviceType
required
string

Must be one of snmp_switch, telejetDigiOne, apc, apcCpdu, racktivityEnergySwitch, racktivityPowerManager, cyberpowerAts, cyberpowerEpdu2, dellrPdu, enlogicv1, intertechSw, intertechSm, intertechSa, azepdu, geistV5, raritanDominionSX, raritanDominionKXII, raritanDominionKXIII, raritanDominionPduMib1, sentry4, sentry3, or ipoman.

name
required
string
host
required
string

The hostname or IP of the device.

port
integer

This field is required when deviceType is telejetDigiOne. Must be between 1 and 65535.

username
string

This field is required when deviceType is telejetDigiOne.

password
string

Optional field. Currently only available for telejet.

snmpCommunity
string

This field is required when deviceType is snmp_switch, apc, apcCpdu, racktivityEnergySwitch, racktivityPowerManager, cyberpowerAts, cyberpowerEpdu2, dellrPdu, enlogicv1, intertechSw, intertechSm, intertechSa, azepdu, geistV5, raritanDominionPduMib1, sentry4, sentry3, or ipoman.

snmpVersion
string

This field is required when deviceType is snmp_switch. The SNMP version for PDUs is detected automatically.

snmpAuthAlgo
string

Must be one of SHA, SHA-224, SHA-256, SHA-384, SHA-512, or MD5. Only used if SNMP v3 is used.

snmpAuthLevel
string

Must be one of noAuthNoPriv, authNoPriv, or authPriv. Only used if SNMP v3 is used.

snmpCryptoAlgo
string

Must be one of AES or DES. Only used if SNMP v3 is used.

snmpCryptoPassword
string

The SNMP v3 crypto password. Only used if SNMP v3 is used.

enableAdvancedManagement
boolean
managementVendor
string
managementPort
integer

Must be between 0 and 65535.

managementUser
string
managementPassword
string
agentId
required
integer

The specificated agent will handle the connection.

features
Array of strings

Some devices have additional features available.

meta
object

Some devices support additional meta flags.

Request samples

Content type
application/json
{
  • "deviceType": "snmp_switch",
  • "name": "nisi",
  • "host": "switch01.domain.com",
  • "port": null,
  • "username": null,
  • "password": null,
  • "snmpCommunity": "et",
  • "snmpVersion": "2c",
  • "snmpAuthAlgo": null,
  • "snmpAuthLevel": null,
  • "snmpCryptoAlgo": null,
  • "snmpCryptoPassword": null,
  • "enableAdvancedManagement": false,
  • "managementVendor": "tempora",
  • "managementPort": 50454,
  • "managementUser": "modi",
  • "managementPassword": "ratione",
  • "agentId": 1,
  • "features": [
    ],
  • "meta": {
    }
}

/api/networkDevices/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 2

The ID of the network device.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/networkDevices/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 2

The ID of the network device.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
deviceType
string

Must be one of snmp_switch, telejetDigiOne, apc, apcCpdu, racktivityEnergySwitch, racktivityPowerManager, cyberpowerAts, cyberpowerEpdu2, dellrPdu, raritanDominionPduMib1, sentry4, sentry3, enlogicv1, intertechSw, intertechSm, intertechSa, azepdu, geistV5, raritanDominionSX, raritanDominionKXII, raritanDominionKXIII, or ipoman.

name
string
host
string

The hostname or IP of the device.

port
integer

This field is required when deviceType is telejetDigiOne. Must be between 1 and 65535.

username
string

This field is required when deviceType is telejetDigiOne.

password
string

Optional field. Currently only available for telejet.

snmpCommunity
string

This field is required when deviceType is snmp_switch, apc, apcCpdu, racktivityEnergySwitch, racktivityPowerManager, cyberpowerAts, cyberpowerEpdu2, dellrPdu, enlogicv1, intertechSw, intertechSm, intertechSa, azepdu, geistV5, raritanDominionPduMib1, sentry4, sentry3, or ipoman.

snmpAuthAlgo
string

Must be one of SHA, SHA-224, SHA-256, SHA-384, SHA-512, or MD5. Only used if SNMP v3 is used.

snmpAuthLevel
string

Must be one of noAuthNoPriv, authNoPriv, or authPriv. Only used if SNMP v3 is used.

snmpCryptoAlgo
string

Must be one of AES or DES. Only used if SNMP v3 is used.

snmpCryptoPassword
string

The SNMP v3 crypto password. Only used if SNMP v3 is used.

snmpVersion
string

This field is required when deviceType is snmp_switch. The SNMP version for PDUs is detected automatically.

enableAdvancedManagement
boolean
managementVendor
string
managementPort
integer

Must be between 0 and 65535.

managementUser
string
managementPassword
string
agentId
integer

The specificated agent will handle the connection.

features
Array of strings

Some devices have additional features available.

meta
object

Some devices support additional meta flags.

Request samples

Content type
application/json
{
  • "deviceType": "snmp_switch",
  • "name": "eos",
  • "host": "switch01.domain.com",
  • "port": null,
  • "username": null,
  • "password": null,
  • "snmpCommunity": "laborum",
  • "snmpAuthAlgo": null,
  • "snmpAuthLevel": null,
  • "snmpCryptoAlgo": null,
  • "snmpCryptoPassword": null,
  • "snmpVersion": "2c",
  • "enableAdvancedManagement": true,
  • "managementVendor": "eveniet",
  • "managementPort": 31852,
  • "managementUser": "repellendus",
  • "managementPassword": "velit",
  • "agentId": 1,
  • "features": [
    ],
  • "meta": {
    }
}

/api/networkDevices/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 2

The ID of the network device.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

/api/networkDevices/{networkDevice}/actions/{networkDeviceAction}

Authorizations:
default
path Parameters
networkDevice
required
integer
Examples:
  • - When the value is omitted
  • 1 - When the value is present

Optional parameter. The ID of the network device.

networkDeviceAction
required
string
Examples:
  • - When the value is omitted
  • getFeatures - When the value is present

Optional parameter. The action to execute. Use getFeatures to see the available actions. The features depend on the network device type.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/networkDevices/{networkDevice}/extendedDetails

Authorizations:
default
path Parameters
networkDevice
required
string
Example: assumenda

The networkDevice.

id
required
integer
Example: 2

The ID of the network device.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

Others

/api/system/version

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

/api/system/listTimezones

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

GET api/ping

This endpoint provides a simple and resource-efficient way to check if the API is reachable.

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "pong",
  • "message": "success"
}

/api/system/listTimeDateFormats

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

GET api/system/settingsAfterLogin

This endpoint is queried by the browser after logging in into the Tenantos web interface. The response contains various settings for the user interface, such as which checkboxes should be activated by default.

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

GET api/system/ui/uiLanguage

This endpoint is queried by the browser before and after logging into the Tenantos interface. The response contains the language files and may differ depending on the brand/domain.

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

GET api/system/ui/settings

This endpoint is queried by the browser before logging into the Tenantos interface. The response contains various settings for the user interface, such as the color scheme and various texts. The response may differ depending on the brand/domain.

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/system/ui/version

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

PXE Basic Operations

/api/pxe/profiles/{pxeProfileId}/duplicate

Authorizations:
default
path Parameters
pxeProfileId
required
integer
Example: 16

The ID of the PXE profile which should be duplicated.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
name
required
string

Request samples

Content type
application/json
{
  • "name": "sit"
}

/api/pxe/scripts/{pxeScriptId}/duplicate

Authorizations:
default
path Parameters
pxeScriptId
required
integer
Example: 18

The ID of the PXE script which should be duplicated.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
name
required
string

Request samples

Content type
application/json
{
  • "name": "eaque"
}

/api/pxe/disklayouts/{pxeDisklayoutId}/duplicate

Authorizations:
default
path Parameters
pxeDisklayoutId
required
integer
Example: 9

The ID of the PXE script which should be duplicated.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
name
required
string

Request samples

Content type
application/json
{
  • "name": "est"
}

POST api/os/list

Normally the available profiles are queried via the api/servers/{server}/provisioning/getProfiles endpoint, but there are situations where all available profiles need to be queried (e.g. for billing integrations).

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
type
required
string

Must be one of pxe.

Request samples

Content type
application/json
{
  • "type": "pxe"
}

/api/pxe/disklayouts

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/pxe/disklayouts

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
tags
required
Array of strings

Must have at least 1 item. The disk layout is linked to the operating systems via tags.

disklayout
string

The kickstart or preseed configuration.

name
required
string
min_disks
integer

The profile will only be offered if the server has the specificated minimum amount of disks. Leave empty to always offer.

isDisabled
boolean
offer_if_has_tag
Array of strings
dont_offer_if_has_tag
Array of strings
offer_if_user_has_role
Array of strings
dont_offer_if_user_has_role
Array of strings
allow_for_vps
boolean
allow_for_dedicated
boolean
hw_raid_handling
string

Must be one of always_offer, only_offer_if_hw_raid, or dont_offer_if_hw_raid.

Request samples

Content type
application/json
{
  • "tags": [
    ],
  • "disklayout": "autopart --type=lvm",
  • "name": "accusamus",
  • "min_disks": 3,
  • "isDisabled": true,
  • "offer_if_has_tag": [
    ],
  • "dont_offer_if_has_tag": [
    ],
  • "offer_if_user_has_role": [
    ],
  • "dont_offer_if_user_has_role": [
    ],
  • "allow_for_vps": true,
  • "allow_for_dedicated": false,
  • "hw_raid_handling": "dont_offer_if_hw_raid"
}

/api/pxe/disklayouts/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 2

The ID of the disk layout.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/pxe/disklayouts/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 2

The ID of the disk layout.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
tags
Array of strings

The disk layout is linked to the operating systems via tags.

disklayout
string

The kickstart or preseed configuration.

name
string
min_disks
integer

The profile will only be offered if the server has the specificated minimum amount of disks. Leave empty to always offer.

isDisabled
boolean
offer_if_has_tag
Array of strings
dont_offer_if_has_tag
Array of strings
offer_if_user_has_role
Array of strings
dont_offer_if_user_has_role
Array of strings
partition_size_boot
integer

Must be at least 100.

partition_size_efi
integer

Must be at least 100.

allow_for_vps
boolean
allow_for_dedicated
boolean
hw_raid_handling
string

Must be one of always_offer, only_offer_if_hw_raid, or dont_offer_if_hw_raid.

Request samples

Content type
application/json
{
  • "tags": [
    ],
  • "disklayout": "autopart --type=lvm",
  • "name": "adipisci",
  • "min_disks": 3,
  • "isDisabled": true,
  • "offer_if_has_tag": [
    ],
  • "dont_offer_if_has_tag": [
    ],
  • "offer_if_user_has_role": [
    ],
  • "dont_offer_if_user_has_role": [
    ],
  • "partition_size_boot": 13,
  • "partition_size_efi": 94,
  • "allow_for_vps": true,
  • "allow_for_dedicated": false,
  • "hw_raid_handling": "always_offer"
}

/api/pxe/disklayouts/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 2

The ID of the disk layout.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

GET api/pxe/tags

Returns all available PXE tags (aggregated from all PXE profiles).

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/pxe/tags/getPxeProfilesByTags

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
tags
required
Array of strings

Request samples

Content type
application/json
{
  • "tags": [
    ]
}

GET api/pxe/profiles/{pxeProfileId}/clearcache

Deletes all cached OS data from all remote agents for this profile. Tenantos caches the files necessary for the installation of the respective operating system.

Windows operating system installation files cannot be deleted because Windows is imported from an ISO and not downloaded from a remote server.

Authorizations:
default
path Parameters
pxeProfileId
required
integer
Example: 1

The ID of the PXE profile.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "ok",
  • "message": "success"
}

/api/pxe/profiles

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/pxe/profiles

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
tags
required
Array of strings
osName
required
string
pxeType
required
string

Must be one of preseed,kickstart,autoinstall,windows,grml,vmware.

pxeConfig
required
string

The iPXE boot configuration.

defaultDiskLayout
string

optional The disk layout configuration.

packages
string

A list of packages which should be installed.

language
string
autoInstallTemplate
string

The answer file for the OS installer.

timezone
string
mirrorUrl
string

The URL to the OS mirror.

additionalDriversUrl
string

Must be a valid URL.

cacheDirectory
required
string

The OS files will be stored in this directory.

networkConfigMode
string

Must be a valid network mode.

httpdirectory
string
version
string

The version of the operating system. Only required for Ubuntu / Windows.

customFirstBoot
string

Script will be executed on first operating system boot.

customPostScript
string

Script will be executed on after the installation has been completed, but within the installer environment.

isDisabled
boolean
allow_ssh_keys
boolean
allow_set_hostname
boolean
allow_for_vps
boolean
allow_for_dedicated
boolean
set_root_password
boolean
updateServerHardwareInventory
boolean
mark_installation_completed_event
string

Must be one of afterBaseInstall, firstBootBeforeScriptExecution, firstBootAfterScriptExecution, or onFirstPxeFileAccess.

default_disklayout_template
integer
fallback_to_default_disklayout_if_unset
boolean
enforced_default_disklayout_template
boolean
default_run_scripts
Array of strings
enforced_default_run_scripts
boolean
default_run_scripts_hide_others
boolean
configure_all_ipvfour_ask_user
boolean
configure_all_ipvfour_enforce
boolean
configure_ipvfour_even_if_outside_of_gateway
boolean
configure_all_ipvsix_ask_user
boolean
configure_all_ipvsix_enforce
boolean
offer_if_has_tag
Array of strings
dont_offer_if_has_tag
Array of strings
offer_if_user_has_role
Array of strings
dont_offer_if_user_has_role
Array of strings
windows_activation_key
string
windows_use_empty_activation_key
boolean
windows_key_location_userdata
boolean
windows_key_location_specialize
boolean
windows_bypass_system_requirements_check
boolean
windows_skip_oobe
boolean
pxe_enable_comboot
boolean
ipxe_bios_file
string
ipxe_efi_file
string
licensekey
string
keep_dhcp_minutes
integer

Must be at least 1. Must not be greater than 6000.

pxe_file_caching_policy
string

Must be one of smartCaching, dailyCleanup, clearBeforeInstallation, or keepAsLongAsPossible.

Request samples

Content type
application/json
{
  • "tags": [
    ],
  • "osName": "nobis",
  • "pxeType": "kickstart",
  • "pxeConfig": "#!ipxe",
  • "defaultDiskLayout": "autopart --type=lvm",
  • "packages": "kexec-tools",
  • "language": "sequi",
  • "autoInstallTemplate": "network --bootproto=static",
  • "timezone": "sed",
  • "mirrorUrl": "http://mirror.fra10.de.leaseweb.net/centos/8-stream/BaseOS/x86_64/os",
  • "additionalDriversUrl": "https://domain.com/drivers",
  • "cacheDirectory": "centos8",
  • "networkConfigMode": "default",
  • "httpdirectory": "vel",
  • "version": "voluptate",
  • "customFirstBoot": "touch /root/123",
  • "customPostScript": "touch /root/123",
  • "isDisabled": true,
  • "allow_ssh_keys": true,
  • "allow_set_hostname": true,
  • "allow_for_vps": true,
  • "allow_for_dedicated": false,
  • "set_root_password": true,
  • "updateServerHardwareInventory": false,
  • "mark_installation_completed_event": "firstBootAfterScriptExecution",
  • "default_disklayout_template": 4,
  • "fallback_to_default_disklayout_if_unset": false,
  • "enforced_default_disklayout_template": false,
  • "default_run_scripts": [
    ],
  • "enforced_default_run_scripts": true,
  • "default_run_scripts_hide_others": false,
  • "configure_all_ipvfour_ask_user": false,
  • "configure_all_ipvfour_enforce": true,
  • "configure_ipvfour_even_if_outside_of_gateway": true,
  • "configure_all_ipvsix_ask_user": true,
  • "configure_all_ipvsix_enforce": false,
  • "offer_if_has_tag": [
    ],
  • "dont_offer_if_has_tag": [
    ],
  • "offer_if_user_has_role": [
    ],
  • "dont_offer_if_user_has_role": [
    ],
  • "windows_activation_key": "ipsam",
  • "windows_use_empty_activation_key": false,
  • "windows_key_location_userdata": false,
  • "windows_key_location_specialize": false,
  • "windows_bypass_system_requirements_check": true,
  • "windows_skip_oobe": true,
  • "pxe_enable_comboot": true,
  • "ipxe_bios_file": "facere",
  • "ipxe_efi_file": "atque",
  • "licensekey": "voluptatem",
  • "keep_dhcp_minutes": 4340,
  • "pxe_file_caching_policy": "keepAsLongAsPossible"
}

/api/pxe/profiles/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 2

The ID of the PXE profile.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/pxe/profiles/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 2

The ID of the PXE profile.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
tags
Array of strings
osName
string
pxeType
required
string

Must be one of preseed,kickstart,autoinstall,windows,grml,vmware.

pxeConfig
string

The iPXE boot configuration.

defaultDiskLayout
string

optional The disk layout configuration.

packages
string

A list of packages which should be installed.

language
string
autoInstallTemplate
string

The answer file for the OS installer.

timezone
string
mirrorUrl
string

The URL to the OS mirror.

additionalDriversUrl
string

Must be a valid URL.

cacheDirectory
string

The OS files will be stored in this directory.

networkConfigMode
string
httpdirectory
string
version
string

The version of the operating system. Only required for Ubuntu / Windows.

customFirstBoot
string

Script will be executed on first operating system boot.

customPostScript
string

Script will be executed on after the installation has been completed, but within the installer environment.

isDisabled
boolean
allow_ssh_keys
boolean
allow_for_vps
boolean
allow_for_dedicated
boolean
allow_set_hostname
boolean
set_root_password
boolean
updateServerHardwareInventory
boolean
mark_installation_completed_event
string

Must be one of afterBaseInstall, firstBootBeforeScriptExecution, firstBootAfterScriptExecution, or onFirstPxeFileAccess.

default_disklayout_template
integer
fallback_to_default_disklayout_if_unset
boolean
enforced_default_disklayout_template
boolean
default_run_scripts
Array of strings
enforced_default_run_scripts
boolean
default_run_scripts_hide_others
boolean
configure_all_ipvfour_ask_user
boolean
configure_all_ipvfour_enforce
boolean
configure_ipvfour_even_if_outside_of_gateway
boolean
configure_all_ipvsix_ask_user
boolean
configure_all_ipvsix_enforce
boolean
offer_if_has_tag
Array of strings
dont_offer_if_has_tag
Array of strings
offer_if_user_has_role
Array of strings
dont_offer_if_user_has_role
Array of strings
windows_activation_key
string
windows_use_empty_activation_key
boolean
windows_key_location_userdata
boolean
windows_key_location_specialize
boolean
windows_bypass_system_requirements_check
boolean
windows_skip_oobe
boolean
pxe_enable_comboot
boolean
ipxe_bios_file
string
ipxe_efi_file
string
licensekey
string
keep_dhcp_minutes
integer

Must be at least 1. Must not be greater than 6000.

pxe_file_caching_policy
string

Must be one of smartCaching, dailyCleanup, clearBeforeInstallation, or keepAsLongAsPossible.

Request samples

Content type
application/json
{
  • "tags": [
    ],
  • "osName": "rerum",
  • "pxeType": "kickstart",
  • "pxeConfig": "#!ipxe",
  • "defaultDiskLayout": "autopart --type=lvm",
  • "packages": "kexec-tools",
  • "language": "iste",
  • "autoInstallTemplate": "network --bootproto=static",
  • "timezone": "sint",
  • "mirrorUrl": "http://mirror.fra10.de.leaseweb.net/centos/8-stream/BaseOS/x86_64/os",
  • "additionalDriversUrl": "https://domain.com/drivers",
  • "cacheDirectory": "centos8",
  • "networkConfigMode": "ex",
  • "httpdirectory": "at",
  • "version": "atque",
  • "customFirstBoot": "touch /root/123",
  • "customPostScript": "touch /root/123",
  • "isDisabled": false,
  • "allow_ssh_keys": true,
  • "allow_for_vps": true,
  • "allow_for_dedicated": true,
  • "allow_set_hostname": true,
  • "set_root_password": true,
  • "updateServerHardwareInventory": false,
  • "mark_installation_completed_event": "firstBootBeforeScriptExecution",
  • "default_disklayout_template": 4,
  • "fallback_to_default_disklayout_if_unset": true,
  • "enforced_default_disklayout_template": false,
  • "default_run_scripts": [
    ],
  • "enforced_default_run_scripts": true,
  • "default_run_scripts_hide_others": true,
  • "configure_all_ipvfour_ask_user": true,
  • "configure_all_ipvfour_enforce": true,
  • "configure_ipvfour_even_if_outside_of_gateway": false,
  • "configure_all_ipvsix_ask_user": true,
  • "configure_all_ipvsix_enforce": false,
  • "offer_if_has_tag": [
    ],
  • "dont_offer_if_has_tag": [
    ],
  • "offer_if_user_has_role": [
    ],
  • "dont_offer_if_user_has_role": [
    ],
  • "windows_activation_key": "omnis",
  • "windows_use_empty_activation_key": true,
  • "windows_key_location_userdata": false,
  • "windows_key_location_specialize": false,
  • "windows_bypass_system_requirements_check": true,
  • "windows_skip_oobe": true,
  • "pxe_enable_comboot": false,
  • "ipxe_bios_file": "error",
  • "ipxe_efi_file": "rerum",
  • "licensekey": "labore",
  • "keep_dhcp_minutes": 1174,
  • "pxe_file_caching_policy": "dailyCleanup"
}

/api/pxe/profiles/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 2

The ID of the PXE profile.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

/api/pxe/profiles/{pxeProfileId}/restore

Authorizations:
default
path Parameters
pxeProfileId
required
string
Example: ex
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

/api/pxe/scripts

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/pxe/scripts

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
tags
required
Array of strings

The script is linked to the operating systems via tags.

script
required
string

Script will be executed on after the installation has been completed.

name
required
string
isDisabled
boolean
offer_if_has_tag
Array of strings
dont_offer_if_has_tag
Array of strings
offer_if_user_has_role
Array of strings
dont_offer_if_user_has_role
Array of strings
allow_for_vps
boolean
allow_for_dedicated
boolean

Request samples

Content type
application/json
{
  • "tags": [
    ],
  • "script": "touch /root/123",
  • "name": "quo",
  • "isDisabled": true,
  • "offer_if_has_tag": [
    ],
  • "dont_offer_if_has_tag": [
    ],
  • "offer_if_user_has_role": [
    ],
  • "dont_offer_if_user_has_role": [
    ],
  • "allow_for_vps": false,
  • "allow_for_dedicated": false
}

/api/pxe/scripts/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the PXE script.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

/api/pxe/scripts/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the PXE script.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
tags
Array of strings

The script is linked to the operating systems via tags.

script
string

Script will be executed on after the installation has been completed.

name
string
isDisabled
boolean
offer_if_has_tag
Array of strings
dont_offer_if_has_tag
Array of strings
offer_if_user_has_role
Array of strings
dont_offer_if_user_has_role
Array of strings
allow_for_vps
boolean
allow_for_dedicated
boolean

Request samples

Content type
application/json
{
  • "tags": [
    ],
  • "script": "touch /root/123",
  • "name": "eaque",
  • "isDisabled": true,
  • "offer_if_has_tag": [
    ],
  • "dont_offer_if_has_tag": [
    ],
  • "offer_if_user_has_role": [
    ],
  • "dont_offer_if_user_has_role": [
    ],
  • "allow_for_vps": true,
  • "allow_for_dedicated": true
}

/api/pxe/scripts/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the PXE script.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

/api/pxe/windows/importWindows

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
editions
required
Array of strings

The specificated editions will be imported.

cacheDirectory
required
string

The Windows files will be placed in the specificated directory, regex: ^[a-z0-9]+$.

language
required
string

The language which should be imported.

mode
required
string

Must be one of iso or cdrom.

Request samples

Content type
application/json
{
  • "editions": [
    ],
  • "cacheDirectory": "win2k22",
  • "language": "en-us",
  • "mode": "iso"
}

GET api/pxe/windows/getWindowsInformation

Lists all available Windows versions of the ISO.

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
mode
required
string

Must be one of iso or cdrom.

Responses

Request samples

Content type
application/json
{
  • "mode": "iso"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

POST api/remoteAgents/{agentId}/actions/testConnectivity

Tests if the connection between the Tenantos main server and the remote agent does work.

Authorizations:
default
path Parameters
agentId
required
integer
Example: 1

The ID of the agent.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
useCache
boolean

The last status is cached for at least 15 minutes. Submit true to receive the cached status (for faster response).

Request samples

Content type
application/json
{
  • "useCache": true
}

/api/remoteAgents/{agentId}/actions/getAssignments

Authorizations:
default
path Parameters
agentId
required
integer
Example: 1

The ID of the agent.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

GET api/remoteAgents/ipmiKvmIsos

Feature: https://documentation.tenantos.com/Tenantos/remote-agents/ipmi-kvm-isos/

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

/api/remoteAgents/ipmiKvmIsos

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
name
required
string
downloadUrl
required
string

The URL to the ISO file.

Request samples

Content type
application/json
{}

/api/remoteAgents/ipmiKvmIsos/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the ISO.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

/api/remoteAgents/ipmiKvmIsos/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the ISO.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

/api/remoteAgents

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/remoteAgents

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
name
required
string
hostname
required
string
password
required
string
sshport
required
integer
ip
required
string

Request samples

Content type
application/json
{
  • "name": "non",
  • "hostname": "cum",
  • "password": "inventore",
  • "sshport": 10,
  • "ip": "in"
}

/api/remoteAgents/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the agent.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/remoteAgents/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the agent.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
name
string
hostname
string
sshport
integer
ip
string

Request samples

Content type
application/json
{
  • "name": "saepe",
  • "hostname": "consequatur",
  • "sshport": 6,
  • "ip": null
}

/api/remoteAgents/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the agent.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

POST api/remoteAgents/{agentId}/reprovisioning

Documentation: https://documentation.tenantos.com/Tenantos/remote-agents/manage-remote-agents/#redeploying-remote-agents

Reprovisions a remote agent by reinstalling the agent software on the target server. This can be used to install on a new server or reinstall on the same server.

Authorizations:
default
path Parameters
agentId
required
integer
Example: 2

The ID of the agent to reprovision.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
name
required
string

The name of the agent.

hostname
required
string

The hostname of the target server.

ip
required
string

The IP address of the target server.

sshport
required
integer

The SSH port of the target server.

password
string

optional The root password for the target server (required if SSH key is not already installed).

Request samples

Content type
application/json
{
  • "name": "veritatis",
  • "hostname": "quia",
  • "ip": "quia",
  • "sshport": 11,
  • "password": "voluptatem"
}

Reverse DNS

Feature: https://documentation.tenantos.com/Tenantos/ip-manager/rdns-servers/

These API endpoints are, by default, only accessible as admin and are not intended for normal users.

DELETE api/subnets/{subnet_id}/rdnsAssignment

Removes the assigned RDNS server from the subnet.

Authorizations:
default
path Parameters
subnet
required
integer
Example: 3

The ID of the subnet.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

POST api/subnets/{subnet}/rdnsAssignment

Assigns a RDNS server to the subnet.

Authorizations:
default
path Parameters
subnet
required
integer
Example: 3

The ID of the subnet.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
serverId
required
integer

The ID of the RDNS server.

Request samples

Content type
application/json
{
  • "serverId": 1
}

GET api/subnets/{subnet_id}/rdnsAssignment

Shows the current assigned RDNS server.

Authorizations:
default
path Parameters
subnet_id
required
integer
Example: 1

The ID of the subnet.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{ }

POST api/rdns/providers/{provider}/configure

The features of this endpoint depends on the RDNS provider. For example, at PowerDNS, it is possible to create a reverse DNS zone using this endpoint.

Authorizations:
default
path Parameters
provider
required
integer
Example: 1

The ID of the RDNS provider.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

POST api/rdns/providers/{provider}/addSubnetAssignment

An alternative way to assign a RDNS server to a subnet. The other way to do it is using the POST api/subnets/{subnet}/rdnsAssignment endpoint.

Authorizations:
default
path Parameters
provider
required
integer
Example: 1

The ID of the RDNS server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
subnet
required
string

Must be a valid subnet (without CIDR).

Request samples

Content type
application/json
{
  • "subnet": "10.10.10.0"
}

POST api/rdns/ip

Get the RDNS entry. Users can query the RDNS entry via the POST api/servers/{server}/ipassignments/rdns endpoint.

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
adminIp
required
string

Must be a valid IP address.

Request samples

Content type
application/json
{
  • "adminIp": "8.100.62.132"
}

PUT api/rdns/ip

Set the RDNS entry. Users can set the RDNS entry via the PUT api/servers/{server_id}/ipassignments/{id} endpoint.

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
ptrRecord
string
adminIp
required
string

Must be a valid IP address.

setPtrTemplate
boolean

If set to true, the RDNS entry will be set to the default value. Default is false.

Request samples

Content type
application/json
{
  • "ptrRecord": "aut",
  • "adminIp": "52.77.102.18",
  • "setPtrTemplate": false
}

DELETE api/rdns/ip

Delete the RDNS entry. Users can delete the RDNS entry via the PUT api/servers/{server_id}/ipassignments/{id} endpoint.

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
adminIp
required
string

Must be a valid IP address.

Request samples

Content type
application/json
{
  • "adminIp": "113.11.160.146"
}

/api/rdns/providers

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
withStatusCheck
boolean

Responses

Request samples

Content type
application/json
{
  • "withStatusCheck": false
}

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

POST api/rdns/providers

The body differs depending on the RDNS provider. Please add the provider via the interface to find out the required parameters.

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
type
required
string

The RDNS provider.

data
required
object

The access details for the RDNS provider.

Request samples

Content type
application/json
{
  • "type": "PowerDNS",
  • "data": {
    }
}

/api/rdns/providers/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the RDNS provider.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
withStatusCheck
boolean

Responses

Request samples

Content type
application/json
{
  • "withStatusCheck": true
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/rdns/providers/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the RDNS provider.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
data
Array of strings

Request samples

Content type
application/json
{
  • "data": [
    ]
}

/api/rdns/providers/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the RDNS provider.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

/api/rdns/providers/{provider}/actions/testConnectivity

Authorizations:
default
path Parameters
provider
required
string
Example: voluptatibus

The provider.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

/api/roles

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

POST api/roles

The available permissions can be requested via the api/permissions endpoint.

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
name
required
string
permissionlist
Array of strings

Array of single permissions.

permissionsets
Array of strings

Array of permission groups.

Request samples

Content type
application/json
{
  • "name": "laborum",
  • "permissionlist": [
    ],
  • "permissionsets": [
    ]
}

/api/roles/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the role.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

PUT api/roles/{id}

The available permissions can be requested via the api/permissions endpoint.

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the role.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
name
string
permissionlist
Array of strings

Array of single permissions.

permissionsets
Array of strings

Array of permission groups.

serversIndexDisablePermissionChecks
boolean

Request samples

Content type
application/json
{
  • "name": "inventore",
  • "permissionlist": [
    ],
  • "permissionsets": [
    ],
  • "serversIndexDisablePermissionChecks": true
}

/api/roles/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the role.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

GET api/permissions

Returns a list of the available permissions and the group names.

Group names (permissionsets) can be found at the "name" key and the individual permissions (permissionlist) at the apiEndpoint, apiUpdateFields and apiOutput fields.

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
userId
integer

If specified, the permissions of the user with the given ID will be returned.

Responses

Request samples

Content type
application/json
{
  • "userId": 6
}

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

Search Function

/api/search/quicksearch

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
text
required
string

The search term.

Responses

Request samples

Content type
application/json
{
  • "text": "server-001"
}

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/servers/{server}/bmc/users/listUsers

Authorizations:
default
path Parameters
server
required
integer
Example: 1

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/servers/{server}/bmc/users/createUser

Authorizations:
default
path Parameters
server
required
integer
Example: 1

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
username
required
string
channelAccessSettings
string

The channel access settings for the user.

dontFailIfUserExists
boolean

Request samples

Content type
application/json
{
  • "username": "qui",
  • "channelAccessSettings": "ipmi=off callin=off link=off privilege=3",
  • "dontFailIfUserExists": false
}

POST api/servers/{server}/bmc/users/createUserWithPasswordAndPrivilege

This is the recommended API endpoint to create IPMI users.

This endpoints automatically handles edge cases which you would have to handle manually if you use the createUser/setUserPassword/setUserPrivilege/enableUser endpoints.

Using this endpoint, it is also possible to update an existing IPMI user: Set dontFailIfUserExists to true and use the listUsers endpoint if you need to know if the user already exists. To update an IPMI user, you can also use the updateUser endpoint.

Authorizations:
default
path Parameters
server
required
integer
Example: 1

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
username
required
string
password
required
string
privilege
required
integer

The privilege level of the IPMI user.

channelAccessSettings
string

The channel access settings for the user.

dontFailIfUserExists
boolean
dontFailIfPasswordChangeFailed
boolean

Only takes effect if dontFailIfUserExists is true. Only use if the password could be the same as previously set, as some IPMIs can't change the password if it is the same as the previous one. The default value is false.

dontChangePasswordIfUserExists
boolean

Request samples

Content type
application/json
{
  • "username": "alias",
  • "password": "aspernatur",
  • "privilege": 3,
  • "channelAccessSettings": "ipmi=off callin=off link=off privilege=3",
  • "dontFailIfUserExists": false,
  • "dontFailIfPasswordChangeFailed": false,
  • "dontChangePasswordIfUserExists": true
}

/api/servers/{server}/bmc/users/updateUser

Authorizations:
default
path Parameters
server
required
integer
Example: 1

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
slot
required
integer

The IPMI slot ID of the user (see listUsers).

username
string
password
string
privilege
required
integer

The privilege level of the IPMI user.

channelAccessSettings
string

The channel access settings for the user.

Request samples

Content type
application/json
{
  • "slot": 1,
  • "username": "libero",
  • "password": "voluptatem",
  • "privilege": 3,
  • "channelAccessSettings": "ipmi=off callin=off link=off privilege=3"
}

/api/servers/{server}/bmc/users/deleteUser

Authorizations:
default
path Parameters
server
required
integer
Example: 1

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
slot
integer

The IPMI slot ID of the user (see listUsers). This field is required when username is not present.

username
string

This field is required when slot is not present.

Request samples

Content type
application/json
{
  • "slot": 1,
  • "username": "ut"
}

/api/servers/{server}/bmc/users/enableUser

Authorizations:
default
path Parameters
server
required
integer
Example: 1

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
slot
integer

The IPMI slot ID of the user (see listUsers). This field is required when username is not present.

username
string

This field is required when slot is not present.

withoutSlotCheck
boolean

Set to true to skip the verification of whether the slot exists. The default value is true. When executing multiple API commands for the same IPMI user, you may choose to verify the user's existence only once to improve performance.

Request samples

Content type
application/json
{
  • "slot": 1,
  • "username": "quisquam",
  • "withoutSlotCheck": false
}

/api/servers/{server}/bmc/users/disableUser

Authorizations:
default
path Parameters
server
required
integer
Example: 1

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
slot
integer

The IPMI slot ID of the user (see listUsers). This field is required when username is not present.

username
string

This field is required when slot is not present.

withoutSlotCheck
boolean

Set to true to skip the verification of whether the slot exists. The default value is true. When executing multiple API commands for the same IPMI user, you may choose to verify the user's existence only once to improve performance.

Request samples

Content type
application/json
{
  • "slot": 1,
  • "username": "quia",
  • "withoutSlotCheck": false
}

/api/servers/{server}/bmc/users/setUserPassword

Authorizations:
default
path Parameters
server
required
integer
Example: 1

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
slot
integer

The IPMI slot ID of the user (see listUsers). This field is required when username is not present.

username
string

This field is required when slot is not present.

password
string
withoutSlotCheck
boolean

Set to true to skip the verification of whether the slot exists. The default value is true. When executing multiple API commands for the same IPMI user, you may choose to verify the user's existence only once to improve performance.

Request samples

Content type
application/json
{
  • "slot": 1,
  • "username": "modi",
  • "password": "ea",
  • "withoutSlotCheck": true
}

/api/servers/{server}/bmc/users/setUserPrivilege

Authorizations:
default
path Parameters
server
required
integer
Example: 1

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
slot
integer

The IPMI slot ID of the user (see listUsers). This field is required when username is not present.

username
string

This field is required when slot is not present.

privilege
required
integer

Must be one of 1, 2, 3, or 4.

withoutSlotCheck
boolean

Set to true to skip the verification of whether the slot exists. The default value is true. When executing multiple API commands for the same IPMI user, you may choose to verify the user's existence only once to improve performance.

Request samples

Content type
application/json
{
  • "slot": 1,
  • "username": "dolorem",
  • "privilege": "4",
  • "withoutSlotCheck": true
}

/api/servers/{server}/bmc/users/channelSetAccess

Authorizations:
default
path Parameters
server
required
integer
Example: 1

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
slot
required

The IPMI slot ID of the user (see listUsers). This field is required when username is not present.

username
string

This field is required when slot is not present.

withoutSlotCheck
boolean

Set to true to skip the verification of whether the slot exists. The default value is true. When executing multiple API commands for the same IPMI user, you may choose to verify the user's existence only once to improve performance.

accessSettings
required
string

The channel access settings for the user.

Request samples

Content type
application/json
{
  • "slot": "1",
  • "username": "voluptatem",
  • "withoutSlotCheck": false,
  • "accessSettings": "ipmi=off callin=off link=off privilege=3"
}

Server Backups

Manage server backups.

GET api/servers/{server}/backups

List all backups for a server.

Authorizations:
default
path Parameters
server_id
required
string
Example: quisquam

The ID of the server.

server
required
integer
Example: 2

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

DELETE api/servers/{server}/backups

Delete a backup.

Authorizations:
default
path Parameters
server_id
required
string
Example: quisquam

The ID of the server.

server
required
integer
Example: 2

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
backupId
required
string

The backup ID to delete.

Request samples

Content type
application/json
{
  • "backupId": "vzdump-qemu-100-2024_01_15.vma.gz"
}

POST api/servers/{server}/backups

Create a new backup for the server.

Authorizations:
default
path Parameters
server
required
integer
Example: 2

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
options
Array of strings

Dynamic backup options based on provider configuration. See GET api/servers/{server}/backups to get the available options.

Request samples

Content type
application/json
{
  • "options": [
    ]
}

POST api/servers/{server}/backups/restore

Restore a backup.

Authorizations:
default
path Parameters
server
required
integer
Example: 2

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
backupId
required
string

The backup ID to restore.

Request samples

Content type
application/json
{
  • "backupId": "vzdump-qemu-100-2024_01_15.vma.gz"
}

GET api/servers/{server}/backups/available

Check if backups are supported for this server.

Authorizations:
default
path Parameters
server
required
integer
Example: 2

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/servers/tags

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

GET api/servers/getByIp/{ip}

Find a server by the IP address. At the moment, only IPv4 addresses are supported.

Authorizations:
default
path Parameters
ip
required
string
Example: 10.10.10.30

Get server by IPv4 address.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/servers

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/servers

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
hostname
required
string

Must not be greater than 255 characters.

servername
required
string

Must not be greater than 255 characters.

user_id
string
description
string
tags
Array of strings
os
string
servertype
string

Must be one of auto, dedicated, or vm.

vpsplan
integer

Only specify if a virtual server, based on the plan ID, should be created.

overrideVpsResources
Array of strings

Only specify if a virtual server, based on the plan ID, should be created and you want to override the resources. See: https://documentation.tenantos.com/billing-whmcs/configurable-options/vps-resource-overrides/

config
object

Specify to add connections to the server in one go.

Array of objects

Request samples

Content type
application/json
{
  • "hostname": "hostname.com",
  • "servername": "server-001",
  • "user_id": null,
  • "description": "enim",
  • "tags": [
    ],
  • "os": "nemo",
  • "servertype": "auto",
  • "vpsplan": null,
  • "overrideVpsResources": null,
  • "config": {
    },
  • "ipassignments": [
    ]
}

/api/servers/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 61

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/servers/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 61

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
hostname
string

Must not be greater than 255 characters.

servername
string

Must not be greater than 255 characters.

user_id
integer
description
string
tags
Array of strings
os
string
servertype
string

Must be one of auto, dedicated, or vm.

suspendUserIds
Array of integers
Array of objects
suspendPowerAction
string

Must be one of none, setPowerOff, or setPowerOn.

suspendNetworkPortAction
string

Must be one of none, disable, or enable.

Request samples

Content type
application/json
{
  • "hostname": "hostname.com",
  • "servername": "server-001",
  • "user_id": 11,
  • "description": "labore",
  • "tags": [
    ],
  • "os": "harum",
  • "servertype": "dedicated",
  • "suspendUserIds": [
    ],
  • "assignmentDates": [
    ],
  • "suspendPowerAction": "setPowerOn",
  • "suspendNetworkPortAction": "enable"
}

/api/servers/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 61

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
destroy
boolean

If server is a VM, the server will be deleted on the hypervisor (e.g. Proxmox)

Request samples

Content type
application/json
{
  • "destroy": false
}

GET api/servers/{server}/console/start

Generates a NoVNC session and returns a link to open the console.

For security reasons, the console can only be opened by the specificated IP. If no IP has been specificated, the console is bound to the requestor IP.

Authorizations:
default
path Parameters
server
required
integer
Example: 1

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
authorizedIp
required
string

Must be a valid IP address. The console is only reachable by the specificated IP.

consoleMode
string

Must be one of standard or web.

Responses

Request samples

Content type
application/json
{
  • "authorizedIp": "10.0.0.10",
  • "consoleMode": "standard"
}

Response samples

Content type
application/json
{}

/api/servers/getByTags

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
tags
required
Array of strings

An array of tags. Only servers which own all of the specified tags will be returned (= AND query, not OR). A list of all available tags can be received via the /api/servers/tags endpoint.

Request samples

Content type
application/json
{
  • "tags": [
    ]
}

POST api/servers/{id}/tags/rename

Rename a tag globally across all servers (and optionally subnets and PXE profiles for admins)

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
oldTag
required
string
newTag
required
string
updateSubnets
boolean
updatePxeProfiles
boolean

Request samples

Content type
application/json
{
  • "oldTag": "et",
  • "newTag": "reiciendis",
  • "updateSubnets": false,
  • "updatePxeProfiles": false
}

POST api/servers/{id}/tags/delete

Delete a tag globally from all servers (and optionally subnets and PXE profiles for admins)

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
tag
required
string
updateSubnets
boolean
updatePxeProfiles
boolean

Request samples

Content type
application/json
{
  • "tag": "dignissimos",
  • "updateSubnets": true,
  • "updatePxeProfiles": true
}

/api/servers/{server_id}/comments

Authorizations:
default
path Parameters
server_id
required
integer
Example: 61

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/servers/{server}/comments

Authorizations:
default
path Parameters
server
required
integer
Example: 8

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: multipart/form-data
Accept
string
Example: application/json
Request Body schema: multipart/form-data
required
comment
required
string
sticky
boolean
user_id
integer
attachments
Array of strings <binary> [ items <binary > ]

Must be a file. Must not be greater than 50120 kilobytes.

/api/servers/{server_id}/comments/{id}

Authorizations:
default
path Parameters
server_id
required
integer
Example: 61

The ID of the server.

id
required
integer
Example: 1

The ID of the comment.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/servers/{server_id}/comments/{id}

Authorizations:
default
path Parameters
server_id
required
integer
Example: 61

The ID of the server.

id
required
integer
Example: 1

The ID of the comment.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
comment
string
sticky
boolean
user_id
integer

Request samples

Content type
application/json
{
  • "comment": "veniam",
  • "sticky": true,
  • "user_id": 2
}

/api/servers/{server_id}/comments/{id}

Authorizations:
default
path Parameters
server_id
required
integer
Example: 61

The ID of the server.

id
required
integer
Example: 1

The ID of the comment.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

GET api/servers/{server}/connections/{testConnectionId}/test

Verifies if the connection details are working. Connection testing does not work with every connection. IPMI connection tests are supported.

Authorizations:
default
path Parameters
server
required
integer
Example: 61

The ID of the server.

testConnectionId
required
integer
Example: 21

The ID of the connection. Not all connections support testing.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "online",
  • "message": "success"
}

/api/servers/{server_id}/connections

Authorizations:
default
path Parameters
server_id
required
integer
Example: 61

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/servers/{server}/connections

Authorizations:
default
path Parameters
server
required
integer
Example: 7

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
agentId
required
integer
types
Array of strings

Specify the allowed features / types for this connection.

required
object

Request samples

Content type
application/json
{
  • "agentId": 6,
  • "types": [
    ],
  • "connectionDetails": {
    }
}

/api/servers/{server_id}/connections/{id}

Authorizations:
default
path Parameters
server_id
required
integer
Example: 61

The ID of the server.

id
required
integer
Example: 23

The ID of the connection.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/servers/{server_id}/connections/{id}

Authorizations:
default
path Parameters
server_id
required
integer
Example: 61

The ID of the server.

id
required
integer
Example: 23

The ID of the connection.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
agentId
integer
types
Array of strings

Specify the allowed features / types for this connection.

object

Request samples

Content type
application/json
{
  • "agentId": 5,
  • "types": [
    ],
  • "connectionDetails": {
    }
}

/api/servers/{server_id}/connections/{id}

Authorizations:
default
path Parameters
server_id
required
integer
Example: 61

The ID of the server.

id
required
integer
Example: 23

The ID of the connection.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

/api/servers/{server}/connections/{testConnectionId}/{serverConnectionAction}

Authorizations:
default
path Parameters
server
required
integer
Example: 1

The ID of the server.

testConnectionId
required
integer
Example: 24

The ID of the connection.

serverConnectionAction
required
string
Example: getSupportedActions

The action to execute. Use getSupportedActions to receive information about the available actions. To execute IPMI commands, use the api/servers/{server}/bmc/executeCommand endpoint.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

POST api/servers/{server}/ipassignments/rdns

Get the RDNS entry of an IP address.

Authorizations:
default
path Parameters
server
required
integer
Example: 61

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
ip
string

Must be a valid IP address which is assigned to this server.

Responses

Request samples

Content type
application/json
{
  • "ip": "10.10.10.30"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

GET api/servers/{server}/ipassignments/getAssignableSubnets

Receives a list of subnets from which IPs can be assigned to the server. Subnets are not always available to all servers.

Alias: GET api/virtualization/ipassignments/getAssignableSubnets - used to set the subnets in VPS plans.

Authorizations:
default
path Parameters
server
required
integer
Example: 1

The ID of the server (optional if called via GET api/virtualization/ipassignments/getAssignableSubnets).

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

POST api/servers/{server}/ipassignments/getAssignableIpsOfSubnet

Receives a list of available IPs of the subnet.

Authorizations:
default
path Parameters
server
required
integer
Example: 7

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
subnets_id
required
integer

Request samples

Content type
application/json
{
  • "subnets_id": 12
}

GET api/servers/{server}/ipassignments/getAssignableSubnets

Receives a list of subnets from which IPs can be assigned to the server. Subnets are not always available to all servers.

Alias: GET api/virtualization/ipassignments/getAssignableSubnets - used to set the subnets in VPS plans.

Authorizations:
default
path Parameters
server
required
integer
Example: 1

The ID of the server (optional if called via GET api/virtualization/ipassignments/getAssignableSubnets).

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/servers/{server_id}/ipassignments

Authorizations:
default
path Parameters
server_id
required
integer
Example: 61

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/servers/{server}/ipassignments

Authorizations:
default
path Parameters
server
required
integer
Example: 18

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
subnets_id
required
integer
ips
required
Array of strings

An array of IP addresses which will be assigned to the server.

description
string
performVlanActions
string

Must be one of perform, preview, or none.

Request samples

Content type
application/json
{
  • "subnets_id": 1,
  • "ips": [
    ],
  • "description": "porro",
  • "performVlanActions": "none"
}

/api/servers/{server_id}/ipassignments/{id}

Authorizations:
default
path Parameters
server_id
required
integer
Example: 61

The ID of the server.

id
required
integer

The ID of the IP assignment. However, actually the "ip" body parameter is used for identification. The id parameter must not be empty, but can be any integer or string.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
description
string
primary_ip
boolean
ptrRecord
string
setPtrTemplate
boolean

If set to true, the RDNS entry will be set to the default value. Default is false.

subnetIp
string

Only used if ip is a subnet. Then, this parameter must be an IP within the subnet (e.g. aaab:bbbb:cccc:aaaa::1).

ip
required
string

Must be a IP/subnet which is assigned to the server. If the value is a subnet, it must be the subnet with CIDR (e.g. aaab:bbbb:cccc:aaaa::/52)

Request samples

Content type
application/json
{
  • "description": "quia",
  • "primary_ip": true,
  • "ptrRecord": "et",
  • "setPtrTemplate": false,
  • "subnetIp": null,
  • "ip": "10.10.10.30"
}

/api/servers/{server_id}/ipassignments/{id}

Authorizations:
default
path Parameters
server_id
required
integer
Example: 61

The ID of the server.

id
required
integer

The ID of the IP assignment. However, actually the "ip" body parameter is used for identification. The id parameter must not be empty, but can be any integer or string.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
ip
string

Required if ips is empty. The IP which you want to delete from the server.

ips
Array of strings

Required if ip is empty. An array of IPs which you want to delete from the server.

performVlanActions
string

Must be one of perform, preview, or none.

Request samples

Content type
application/json
{
  • "ip": "10.10.10.4",
  • "ips": null,
  • "performVlanActions": "none"
}

/api/servers/{server}/ipassignments/dynamicIpAssignments

Authorizations:
default
path Parameters
server
required
string
Example: debitis

The server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
Array of objects
Array of objects
Array of objects
Array of objects
object
object

Request samples

Content type
application/json
{
  • "ipv4Addresses": [
    ],
  • "ipv6Addresses": [
    ],
  • "ipv4Subnets": [
    ],
  • "ipv6Subnets": [
    ],
  • "performVlanActions": [ ],
  • "deleteExistingIpAssignments": [ ]
}

GET api/servers/{server_id}/hwsummary

Summarized overview of the hardware inventory.

Authorizations:
default
path Parameters
server_id
required
integer
Example: 61

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

GET api/servers/{server}/hwsummary/withDetails

More detailled summary of the hardware inventory.

Authorizations:
default
path Parameters
server
required
integer
Example: 61

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

GET api/servers/{server}/inventory/getInventoryCommand

Returns a shell command which can be executed on linux servers to collect information about the server hardware without rebooting.

Authorizations:
default
path Parameters
server
required
integer
Example: 1

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "wget -qO - https://domain.com/api/scripts/hwdetect | bash -s 'https://domain.com/api/servers/inventory/callback/40b219a00840e8a242c4bd12ec1a3f43'",
  • "message": "success"
}

GET api/servers/{server_id}/inventory

Complete list of the server hardware inventory.

Authorizations:
default
path Parameters
server_id
required
integer
Example: 61

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/servers/{server}/inventory

Authorizations:
default
path Parameters
server
required
integer
Example: 4

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
model
string
value
string
serial
string
inventorycomponent_id
required
integer

The ID of the root component.

description
string
customfields
Array of strings

An array of custom fields, if the root component has custom fields assigned.

Request samples

Content type
application/json
{
  • "model": "Samsung SSD 860 EVO",
  • "value": "476940",
  • "serial": "S1Z2NB1K736669A",
  • "inventorycomponent_id": 7,
  • "description": "Second SSD",
  • "customfields": null
}

/api/servers/{server_id}/inventory/{id}

Authorizations:
default
path Parameters
server_id
required
integer
Example: 61

The ID of the server.

id
required
integer
Example: 32

The ID of the inventory.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/servers/{server_id}/inventory/{id}

Authorizations:
default
path Parameters
server_id
required
integer
Example: 61

The ID of the server.

id
required
integer
Example: 32

The ID of the inventory.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
model
string
value
string
serial
string
inventorycomponent_id
integer

The ID of the root component.

description
string
customfields
Array of strings

An array of custom fields, if the root component has custom fields assigned.

Request samples

Content type
application/json
{
  • "model": "Samsung SSD 860 EVO",
  • "value": "476940",
  • "serial": "S1Z2NB1K736669A",
  • "inventorycomponent_id": 7,
  • "description": "Second SSD",
  • "customfields": null
}

/api/servers/{server_id}/inventory/{id}

Authorizations:
default
path Parameters
server_id
required
integer
Example: 61

The ID of the server.

id
required
integer
Example: 32

The ID of the inventory.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Server Network Management

Network-related operations for servers

/api/servers/{server}/network/regenerateVlanConfiguration

Authorizations:
default
path Parameters
server
required
string
Example: aut

The server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
performVlanActions
string

Must be one of perform, preview, or none.

Request samples

Content type
application/json
{
  • "performVlanActions": "none"
}

GET api/servers/{server}/network/getManageableNetworkPorts

Get manageable network ports for a server

Authorizations:
default
path Parameters
server
required
integer
Example: 16

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/servers/{server}/provisioning/startReinstallation

Authorizations:
default
path Parameters
server
required
integer
Example: 2

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
profileId
required
integer

The OS profile ID.

rootpassword
required
string

Must be at least 8 characters.

disklayoutId
integer

The ID of the disk layout.

runScripts
Array of strings

Array of script IDs which will be executed after installation.

userprovidedDiskLayout
string

Overrides the default disk layout with a custom provided layout.

hostname
string

Must be a valid hostname and not be greater than 255 characters.

sshkeys
Array of strings

An array of SSH keys.

configure_all_ipvfour
boolean
configure_all_ipvsix
boolean
installPowerAction
string

Must be one of restartAndPxeBoot, restartOnly, or noRestart.

Request samples

Content type
application/json
{
  • "profileId": 1,
  • "rootpassword": "secretpassword",
  • "disklayoutId": 1,
  • "runScripts": [
    ],
  • "userprovidedDiskLayout": "autopart --type=lvm",
  • "hostname": "my.hostname.com",
  • "sshkeys": [
    ],
  • "configure_all_ipvfour": false,
  • "configure_all_ipvsix": false,
  • "installPowerAction": "noRestart"
}

/api/servers/{server}/provisioning/stopReinstallation

Authorizations:
default
path Parameters
server
required
integer
Example: 61

The ID of the server.

withoutPowerReset
required
integer
Examples:
  • - When the value is omitted
  • 2 - When the value is present

Optional parameter. By default, aborting an installation will trigger a power reset. Setting this parameter to 1 doesn't reset the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "ok",
  • "message": "success"
}

/api/servers/{server}/provisioning/getInstallStatus

Authorizations:
default
path Parameters
server
required
integer
Example: 1

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

GET api/servers/{server}/provisioning/executePostCommand

With some providers (e.g. OVH), a post action can be executed after the installation is complete. In the case of OVH, the post action is to request the credentials (for SSH, etc.) after the installation has been completed.

This endpoint is not used for PXE based installations.

Authorizations:
default
path Parameters
server
required
integer
Example: 10

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

GET api/servers/{server}/provisioning/getProfiles

Returns a list of installable operating systems for the server. The list also contains the rescue systems (see isRescue).

Authorizations:
default
path Parameters
server
required
integer
Example: 61

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

POST api/servers/{server}/provisioning/getOsLogo

Returns the path to the logo of the OS.

Authorizations:
default
path Parameters
server
required
integer
Example: 13

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
os
required
string

The name of the operating system.

Request samples

Content type
application/json
{
  • "os": "debian"
}

/api/servers/{server}/power/{serverPowerMethod}

Authorizations:
default
path Parameters
server
required
integer
Example: 1

The ID of the server.

serverPowerMethod
required
string
Example: setPowerOn

The power method. Must be one of powerprovider.supportedFeatures (see GET api/servers/{id}).

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
method
null

(ignore the method parameter)

params
string

This field is required when serverPowerMethod is setBootType. For IPMI, the value can be pxe, disk, bios and other supported flags (Google: "ipmi bootdev"). For virtual servers, pxe and disk is supported.

noFailover
boolean

If set to true and IPMI or AMT in combination with a PDU is used, the power action will not fallback to the PDU if IPMI/AMT fails. Default is false.

Responses

Request samples

Content type
application/json
{
  • "method": null,
  • "params": "aut",
  • "noFailover": null
}

Response samples

Content type
application/json
{
  • "result": "executed",
  • "message": "success"
}

/api/servers/{server}/bmc/executeCommand

Authorizations:
default
path Parameters
server
required
integer
Example: 2

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
command
required
string

The BMC command.

Responses

Request samples

Content type
application/json
{
  • "command": "chassis status"
}

Response samples

Content type
application/json
{
  • "result": "System Power : on\nPower Overload : false\nPower Interlock : inactive\nMain Power Fault : false\nPower Control Fault : false\nPower Restore Policy : always-off\nLast Power Event : \nChassis Intrusion : inactive\nFront-Panel Lockout : inactive\nDrive Fault : false\nCooling/Fan Fault : false",
  • "message": "success"
}

Server Ressources (VM)

GET api/servers/{server_id}/vm

Receive the current virtual server resources.

Authorizations:
default
path Parameters
server_id
required
integer
Example: 2

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/servers/{server_id}/vm

Authorizations:
default
path Parameters
server_id
required
integer
Example: 2

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
object

If no planId is set: Send an object with the new configuration of the VM. The available keys differ for each virtualization type (Proxmox, VMware).

To update the resources by changing the VPS plan, send a request with following body: { "planId": ID }

Request samples

Content type
application/json
{
  • "cpu": {
    },
  • "disks": [
    ],
  • "memory": {
    }
}

Server Snapshots

Manage server snapshots.

GET api/servers/{server}/snapshots

List all snapshots for a server.

Authorizations:
default
path Parameters
server_id
required
string
Example: ipsam

The ID of the server.

server
required
integer
Example: 2

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

DELETE api/servers/{server}/snapshots

Delete a snapshot.

Authorizations:
default
path Parameters
server_id
required
string
Example: ipsam

The ID of the server.

server
required
integer
Example: 2

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
snapshotId
required
string

The snapshot ID to delete.

Request samples

Content type
application/json
{
  • "snapshotId": "snapshot1"
}

POST api/servers/{server}/snapshots

Create a new snapshot for the server.

Authorizations:
default
path Parameters
server
required
integer
Example: 2

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
options
Array of strings

Dynamic snapshot options based on provider configuration. See GET api/servers/{server}/snapshots to get the available options.

Request samples

Content type
application/json
{
  • "options": [
    ]
}

POST api/servers/{server}/snapshots/rollback

Rollback to a snapshot.

Authorizations:
default
path Parameters
server
required
integer
Example: 2

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
snapshotId
required
string

The snapshot ID to rollback to.

Request samples

Content type
application/json
{
  • "snapshotId": "snapshot1"
}

GET api/servers/{server}/snapshots/available

Check if snapshots are supported for this server.

Authorizations:
default
path Parameters
server
required
integer
Example: 2

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/servers/{server}/stats/network/{statsMode}

Authorizations:
default
path Parameters
server
required
integer
Example: 9

The ID of the server.

statsMode
required
string
Example: text

Must be one of graph, or text. "graph" does return values for a graph (5 minute interval), "text" returns a summary for each day.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
from
string

Must be a valid date.

to
string

Must be a valid date.

predefined
string

Must be one of today, 1h, 24h, 14days, 30days, all, currentWeek, week, month, currentMonth, or year.

user_id
integer
groupBy
string

Must be one of 1mo, 1y, 10y. Does add a summarized array to each port with a summary of the stats array. Does also contain information about 95th percentile usage. If from and to span different months, an array will be returned for each month. However, if groupBy is larger than the date range (e.g., 10 years), a single array containing the summarized data will be returned. Resource-intensive parameter.

summary
boolean

Does add a summary array with an aggregated summary of all assigned network ports. Does also contain information about 95th percentile usage. 95th percentile stats are not just summed, but the top 5% of all values are removed. If from and to are within different months, an array for each month will be given back. Resource-intensive parameter.

Request samples

Content type
application/json
{
  • "from": "2025-08-25T15:29:15",
  • "to": "2025-08-25T15:29:15",
  • "predefined": "24h",
  • "user_id": 7,
  • "groupBy": "1mo",
  • "summary": true
}

/api/servers/{server}/stats/ipmi/{statsMode}

Authorizations:
default
path Parameters
server
required
integer
Example: 2

The ID of the server.

statsMode
required
string
Example: text

Must be one of graph, or text. As of now, graph and text returns the same values. This behavior may change in the future. If detailed information is required, graph mode is recommended.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
from
string

Must be a valid date.

to
string

Must be a valid date.

predefined
string

Must be one of today, 24h, 14days, 30days, or all.

user_id
integer

Request samples

Content type
application/json
{
  • "from": "2025-08-25T15:29:15",
  • "to": "2025-08-25T15:29:15",
  • "predefined": "14days",
  • "user_id": 15
}

/api/servers/{server}/stats/cpu/{statsMode}

Authorizations:
default
path Parameters
server
required
integer
Example: 1

The ID of the server.

statsMode
required
string
Example: graph

Must be one of graph, or text.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
from
string

Must be a valid date.

to
string

Must be a valid date.

predefined
string

Must be one of today, 1h, 24h, 14days, 30days, or all.

user_id
integer

Request samples

Content type
application/json
{
  • "from": "2025-08-25T15:29:15",
  • "to": "2025-08-25T15:29:15",
  • "predefined": "1h",
  • "user_id": 1
}

/api/servers/{server}/stats/memory/{statsMode}

Authorizations:
default
path Parameters
server
required
integer
Example: 4

The ID of the server.

statsMode
required
string
Example: graph

Must be one of graph, or text.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
from
string

Must be a valid date.

to
string

Must be a valid date.

predefined
string

Must be one of today, 1h, 24h, 14days, 30days, or all.

user_id
integer

Request samples

Content type
application/json
{
  • "from": "2025-08-25T15:29:15",
  • "to": "2025-08-25T15:29:15",
  • "predefined": "1h",
  • "user_id": 5
}

/api/servers/{server}/stats/diskio/{statsMode}

Authorizations:
default
path Parameters
server
required
integer
Example: 2

The ID of the server.

statsMode
required
string
Example: graph

Must be one of graph, or text.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
from
string

Must be a valid date.

to
string

Must be a valid date.

predefined
string

Must be one of today, 1h, 24h, 14days, 30days, or all.

user_id
integer

Request samples

Content type
application/json
{
  • "from": "2025-08-25T15:29:15",
  • "to": "2025-08-25T15:29:15",
  • "predefined": "14days",
  • "user_id": 5
}

/api/servers/{server}/stats/getAvailableStatistics

Authorizations:
default
path Parameters
server
required
integer
Example: 1

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
predefined
string

The time range to check for stats availability. Default is last 24 hours.

user_id
integer

The user ID to check stats for. If not provided, uses the current user's ID.

Responses

Request samples

Content type
application/json
{
  • "predefined": "1h",
  • "user_id": 1
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/subnets/{subnetId}/withDetails

Authorizations:
default
path Parameters
subnetId
required
integer
Example: 1

The ID of the subnet.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

POST api/subnets/{subnetId}/split

Split a subnet into smaller parts. Only available for IPv6.

Authorizations:
default
path Parameters
subnetId
required
integer
Example: 19

The ID of the subnet.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
mode
required
string

Must be one of subnet or singleIps. subnet does create child subnets, singleIps creates IP addresses out of the subnet.

toPrefix
integer

This field is required when mode is subnet. The target prefix size.

gateway_method
string

This field is required when mode is subnet. Must be one of first, last, or custom.

gateway_custom
string

This field is required when gateway_method is custom.

toAmount
integer

Required if listOfIps is empty. The amount of subnets / IPs to create.

listOfIps
Array of strings

Required if toAmount is empty. listOfIps can be used to split a subnet into predefined subnets or single IPs.

generateIps
boolean
reserve_gateway_ip
boolean

Defaults to true if not set.

reserve_broadcast_ip
boolean

Defaults to true if not set.

reserve_network_address
boolean

Defaults to true if not set.

reserve_first_usable_ip
boolean

Defaults to false if not set.

reserve_last_usable_ip
boolean

Defaults to false if not set.

copy_network_automation_configuration_to_childs
boolean

Request samples

Content type
application/json
{
  • "mode": "subnet",
  • "toPrefix": 64,
  • "gateway_method": "first",
  • "gateway_custom": null,
  • "toAmount": 100,
  • "listOfIps": null,
  • "generateIps": false,
  • "reserve_gateway_ip": null,
  • "reserve_broadcast_ip": null,
  • "reserve_network_address": null,
  • "reserve_first_usable_ip": null,
  • "reserve_last_usable_ip": null,
  • "copy_network_automation_configuration_to_childs": true
}

/api/subnets/{subnetId}/childsMassActions

Authorizations:
default
path Parameters
subnetId
required
integer
Example: 1

The ID of the subnet.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
updateRdns
boolean
updateResolvers
boolean
updateRestrictions
boolean
updateSubnetOwners
boolean
updateNetworkAutomationSettings
boolean
updateDynamicIpAssignmentsSetting
boolean

Request samples

Content type
application/json
{
  • "updateRdns": false,
  • "updateResolvers": false,
  • "updateRestrictions": true,
  • "updateSubnetOwners": false,
  • "updateNetworkAutomationSettings": false,
  • "updateDynamicIpAssignmentsSetting": true
}

GET api/subnets/{subnetId}/listFreeIps

Returns a list of available IPs (unassigned, not reserved).

Authorizations:
default
path Parameters
subnetId
required
integer
Example: 1

The ID of the subnet.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/subnets

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/subnets

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
subnet
required
string

Must be a valid IP address (network address).

cidr
required
integer

The CIDR notation, optional if netmask is set.

userId
integer
netmask
required
string

The netmask, optional if cidr is set.

gw
required
string

The gateway IP.

type
required
string

Must be one of v4 or v6.

description
string

Subnet description.

priority
integer

Subnet priority. Used for virtual server provisioning.

offer_if_server_has_tag
Array of strings
dont_offer_if_server_has_tag
Array of strings
only_if_server_has_remote_agents
Array of integers
dns_resolvers
Array of strings

An unique array of IPv4 and/or IPv6 addresses. If not empty, a minimum of two is required and a maximum of three allowed. Defaults to Google DNS.

generateIps
boolean
enable_switch_automation
boolean
copy_network_automation_configuration_to_childs
boolean
vlan_mode
string

Must be one of access or native+trunk.

access_vlan_generation_mode
string

Must be one of fixed or range.

static_access_vlan_id
integer
range_start_access_vlan_id
integer

Must be at least 1.

range_end_access_vlan_id
integer

Must not be greater than 4094.

trunk_vlans
Array of integers

Must be at least 1. Must not be greater than 4094.

vlan_layer3_mode
string

Must be one of none, gateway, or custom.

vlan_layer3_ip
string
reuse_access_vlan
boolean
use_existing_port_access_vlan
boolean
vlan_remove_layer3_ip_on_unassign
boolean
reserve_gateway_ip
boolean

Defaults to true if not set.

reserve_broadcast_ip
boolean

Defaults to true if not set.

reserve_network_address
boolean

Defaults to true if not set.

reserve_first_usable_ip
boolean

Defaults to false if not set.

reserve_last_usable_ip
boolean

Defaults to false if not set.

exclude_from_dynamic_ip_assignments
boolean

Request samples

Content type
application/json
{
  • "subnet": "10.10.11.0",
  • "cidr": 24,
  • "userId": 12,
  • "netmask": "255.255.255.0",
  • "gw": "10.10.11.1",
  • "type": "v4",
  • "description": null,
  • "priority": null,
  • "offer_if_server_has_tag": [
    ],
  • "dont_offer_if_server_has_tag": [
    ],
  • "only_if_server_has_remote_agents": [
    ],
  • "dns_resolvers": [
    ],
  • "generateIps": true,
  • "enable_switch_automation": false,
  • "copy_network_automation_configuration_to_childs": true,
  • "vlan_mode": "access",
  • "access_vlan_generation_mode": "fixed",
  • "static_access_vlan_id": 8,
  • "range_start_access_vlan_id": 1,
  • "range_end_access_vlan_id": 2884,
  • "trunk_vlans": [
    ],
  • "vlan_layer3_mode": "custom",
  • "vlan_layer3_ip": "est",
  • "reuse_access_vlan": false,
  • "use_existing_port_access_vlan": true,
  • "vlan_remove_layer3_ip_on_unassign": true,
  • "reserve_gateway_ip": null,
  • "reserve_broadcast_ip": null,
  • "reserve_network_address": null,
  • "reserve_first_usable_ip": null,
  • "reserve_last_usable_ip": null,
  • "exclude_from_dynamic_ip_assignments": false
}

/api/subnets/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the subnet.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/subnets/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the subnet.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
gw
string

Must be a valid IP address.

userId
integer
description
string
priority
integer
offer_if_server_has_tag
Array of strings
dont_offer_if_server_has_tag
Array of strings
only_if_server_has_remote_agents
Array of integers
dns_resolvers
Array of strings

An unique array of IPv4 and/or IPv6 addresses. If not empty, a minimum of two is required and a maximum of three allowed.

enable_switch_automation
boolean
copy_network_automation_configuration_to_childs
boolean
vlan_mode
string

Must be one of access or native+trunk.

access_vlan_generation_mode
string

Must be one of fixed or range.

static_access_vlan_id
integer
range_start_access_vlan_id
integer

Must be at least 1.

range_end_access_vlan_id
integer

Must not be greater than 4094.

trunk_vlans
Array of integers

Must be at least 1. Must not be greater than 4094.

vlan_layer3_mode
string

Must be one of none, gateway, or custom.

vlan_layer3_ip
string
reuse_access_vlan
boolean
use_existing_port_access_vlan
boolean
vlan_remove_layer3_ip_on_unassign
boolean
exclude_from_dynamic_ip_assignments
boolean

Request samples

Content type
application/json
{
  • "gw": "174.69.12.140",
  • "userId": 14,
  • "description": "officia",
  • "priority": 18,
  • "offer_if_server_has_tag": [
    ],
  • "dont_offer_if_server_has_tag": [
    ],
  • "only_if_server_has_remote_agents": [
    ],
  • "dns_resolvers": [
    ],
  • "enable_switch_automation": true,
  • "copy_network_automation_configuration_to_childs": true,
  • "vlan_mode": "access",
  • "access_vlan_generation_mode": "fixed",
  • "static_access_vlan_id": 4,
  • "range_start_access_vlan_id": 0,
  • "range_end_access_vlan_id": 2610,
  • "trunk_vlans": [
    ],
  • "vlan_layer3_mode": "custom",
  • "vlan_layer3_ip": "natus",
  • "reuse_access_vlan": false,
  • "use_existing_port_access_vlan": true,
  • "vlan_remove_layer3_ip_on_unassign": false,
  • "exclude_from_dynamic_ip_assignments": true
}

/api/subnets/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the subnet.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

/api/system/backups/storages

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/system/backups/storages

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
name
required
string
provider
required
string

Must be one of s3, ftp, local.

configuration
Array of strings

This field is required when provider is s3 or ftp.

retention
required
integer

Must be at least 1. Must not be greater than 9999.

enabled
required
boolean

Request samples

Content type
application/json
{
  • "name": "placeat",
  • "provider": "local",
  • "configuration": null,
  • "retention": 4021,
  • "enabled": true
}

/api/system/backups/storages/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 2

The ID of the storage.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/system/backups/storages/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 2

The ID of the storage.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
name
string
configuration
array.
retention
integer

Must be at least 1. Must not be greater than 9999.

enabled
boolean

Request samples

Content type
application/json
{
  • "name": "nihil",
  • "configuration": null,
  • "retention": 3521,
  • "enabled": false
}

/api/system/backups/storages/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 2

The ID of the storage.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

/api/system/backups/history

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/system/backups/history/{backupTaskId}

Authorizations:
default
path Parameters
backupTaskId
required
integer
Example: 1

The ID of the backup task.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/system/backups/create

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

/api/servers/{server_id}/activitylog

Authorizations:
default
path Parameters
server_id
required
integer
Example: 20

The ID of the server.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/activitylog/user

Authorizations:
default
path Parameters
limit
required
integer
Examples:
  • - When the value is omitted
  • 11 - When the value is present

Optional parameter. Limit the returned results.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/activitylog/agents/{agentId}

Authorizations:
default
path Parameters
agentId
required
integer
Examples:
  • - When the value is omitted
  • 8 - When the value is present

Optional parameter. optional The ID of the agent.

limit
required
integer
Examples:
  • - When the value is omitted
  • 11 - When the value is present

Optional parameter. Limit the returned results.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/activitylog/system

Authorizations:
default
path Parameters
limit
required
integer
Examples:
  • - When the value is omitted
  • 17 - When the value is present

Optional parameter. Limit the returned results.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/system/globalSystemSettings

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/system/globalSystemSettings

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
settings
required
object

Key value array of settings.

Request samples

Content type
application/json
{
  • "settings": [
    ]
}

/api/system/globalSystemSettings/{settingname}

Authorizations:
default
path Parameters
settingname
required
string
Example: default_datetime_format

The name of the setting.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "DD.MM.YYYY HH:mm:ss",
  • "message": "success"
}

Task Tracking

Get task status and details for polling operations. Currently only used for server backups and snapshots.

GET api/tasks/{task}

Get details of a specific task.

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the task.

task
required
integer
Example: 123

The ID of the task.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/impersonate/{impersonateUserId}/start

Authorizations:
default
path Parameters
impersonateUserId
required
integer
Example: 2

The user ID which you want to impersonate.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "message": "success"
}

/api/user/additionalUserInformation

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
userId
integer
withOwnedUsersData
boolean
limitOwnedUsersDataToIds
Array of integers

Request samples

Content type
application/json
{
  • "userId": 15,
  • "withOwnedUsersData": false,
  • "limitOwnedUsersDataToIds": [
    ]
}

GET api/user

Receive information about the current logged in user.

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Dr. Eva Flatley",
  • "timezone": "Europe/Berlin",
  • "datetimeFormat": "DD.MM.YYYY HH:mm:ss",
  • "darkmode": null,
  • "sshkeys": [ ],
  • "prefs": [ ],
  • "currentIp": "10.12.13.14",
  • "language": "en-us",
  • "isSharedAccess": false,
  • "sharedUserId": null,
  • "realOrSharedUserId": 1,
  • "permissions": [
    ]
}

/api/impersonate/{impersonateUserId}/stop

Authorizations:
default
path Parameters
impersonateUserId
required
integer
Example: 2

Stop impersonating the user ID.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "message": "success"
}

/api/users/{user}/tokens

Authorizations:
default
path Parameters
user
required
integer
Example: 1

The ID of the user.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/users/{user}/tokens

Authorizations:
default
path Parameters
user
required
integer
Example: 1

The ID of the user.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
name
required
string
allowedHosts
Array of strings

Must be an array of valid IP addresses. Usage will be restricted to the specified IPs. Leave empty to allow all IPs.

Request samples

Content type
application/json
{
  • "name": "recusandae",
  • "allowedHosts": [
    ]
}

/api/users/{user}/tokens/{id}

Authorizations:
default
path Parameters
user
required
integer
Example: 1

The ID of the user.

id
required
integer
Example: 2

The ID of the token.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/users/{user}/tokens/{id}

Authorizations:
default
path Parameters
user
required
integer
Example: 1

The ID of the user.

id
required
integer
Example: 2

The ID of the token.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

/api/users/{user}/tokens/{id}

Authorizations:
default
path Parameters
user
required
integer
Example: 1

The ID of the user.

id
required
integer
Example: 2

The ID of the token.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
name
required
string
allowedHosts
Array of strings

Must be an array of valid IP addresses. Usage will be restricted to the specified IPs. Leave empty to allow all IPs.

Request samples

Content type
application/json
{
  • "name": "ea",
  • "allowedHosts": [
    ]
}

/api/users/{user}/sshkeys

Authorizations:
default
path Parameters
user
required
integer
Example: 1

The ID of the user.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/users/{user}/sshkeys

Authorizations:
default
path Parameters
user
required
integer
Example: 1

The ID of the user.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
name
required
string
pubkey
required
string

The public SSH key.

description
string

Request samples

Content type
application/json
{
  • "name": "reiciendis",
  • "pubkey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCPMKW3XDPL0k257n8IBrmJrhSTOfczRjD5V5nou8uYCg1HJHnaCtdgPPdCQPfg5jYVKP5MCsgFBbfCWXv8GgDZAI905Yel46ZcRBkC0JKVkkc53I+wS/zmwfxXzvkV6GRbCISnc1n98+wE4z+Qtg9FV+VAhJzinTCYFo9TV7hwkz7V5e+pj9/5NgfVbFy0H8B2aXqp1F6A7ENBXNrbejXdTyo3lVIq1/tHKfv6mcVmR4b4w7EVI4bvDMDdHeEKfMCvDUG359ElVp7gla5M0kohCCWtgLSchR/6NTEIa6rAFhsmCHCfIE6q959Ff+KUR40e8yzulZtp3NPu8ukUjJtkBA5c4lAE2UUNldyqkWiE8sWAr+GlMjU0UkB3xzB0ID53EKH93WoIapjAnpDYxah8dOdyfk2cSmkdSe8DFNLeWffi8j3Ea9XeCQnMa/VTcSarspnCKL8RG5LL8vGy//0Cs6QXQDn/gCTR2McTPbiiks2sFVWCaIIbgkTs9fGFuhM=",
  • "description": "delectus"
}

/api/users/{user}/sshkeys/{id}

Authorizations:
default
path Parameters
user
required
integer
Example: 1

The ID of the user.

id
required
integer
Example: 1

The ID of the SSH key.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/users/{user}/sshkeys/{id}

Authorizations:
default
path Parameters
user
required
integer
Example: 1

The ID of the user.

id
required
integer
Example: 1

The ID of the SSH key.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
name
string
pubkey
string

The new public SSH key.

description
string

Request samples

Content type
application/json
{
  • "name": "fugit",
  • "pubkey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCPMKW3XDPL0k257n8IBrmJrhSTOfczRjD5V5nou8uYCg1HJHnaCtdgPPdCQPfg5jYVKP5MCsgFBbfCWXv8GgDZAI905Yel46ZcRBkC0JKVkkc53I+wS/zmwfxXzvkV6GRbCISnc1n98+wE4z+Qtg9FV+VAhJzinTCYFo9TV7hwkz7V5e+pj9/5NgfVbFy0H8B2aXqp1F6A7ENBXNrbejXdTyo3lVIq1/tHKfv6mcVmR4b4w7EVI4bvDMDdHeEKfMCvDUG359ElVp7gla5M0kohCCWtgLSchR/6NTEIa6rAFhsmCHCfIE6q959Ff+KUR40e8yzulZtp3NPu8ukUjJtkBA5c4lAE2UUNldyqkWiE8sWAr+GlMjU0UkB3xzB0ID53EKH93WoIapjAnpDYxah8dOdyfk2cSmkdSe8DFNLeWffi8j3Ea9XeCQnMa/VTcSarspnCKL8RG5LL8vGy//0Cs6QXQDn/gCTR2McTPbiiks2sFVWCaIIbgkTs9fGFuhM=",
  • "description": "illo"
}

/api/users/{user}/sshkeys/{id}

Authorizations:
default
path Parameters
user
required
integer
Example: 1

The ID of the user.

id
required
integer
Example: 1

The ID of the SSH key.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

/api/user/{user}/twofactor/enable

Authorizations:
default
path Parameters
user
required
integer
Example: 1

The user.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
code
required
string

Request samples

Content type
application/json
{
  • "code": "quasi"
}

/api/user/{user}/twofactor/disable

Authorizations:
default
path Parameters
user
required
integer
Example: 1

The ID of the user.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "ok",
  • "message": "success"
}

POST api/users/{user}/generateSsoToken

Generates an one-time login link. Login via: https://domain.com/tokenLogin/$authToken

Authorizations:
default
path Parameters
user
required
integer
Example: 3

The ID of the user.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
endpoint
string

The endpoint where the browser will be redirected after opening the login URL.

validForSeconds
integer

Responses

Request samples

Content type
application/json
{
  • "endpoint": "/servers",
  • "validForSeconds": 9
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/users

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/users

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
name
required
string
email
string

Must be a valid email address.

password
required
string
root_owner
integer
description
string
username
required
string

Must not be greater than 255 characters.

role_id
integer
accountstatus
string

Must be one of enabled or disabled.

timezone
string

Must be a valid time zone, such as Africa/Accra.

datetimeFormat
string
darkmode
string

Must be one of 0 or 1.

allowedHosts
Array of strings

Must be an array of valid IP addresses. Login will be restricted to the specified IPs. Leave empty to allow all IPs.

language
string
sessionTimeout
string

Request samples

Content type
application/json
{
  • "name": "iste",
  • "email": "ismael59@example.org",
  • "password": "similique",
  • "root_owner": 10,
  • "description": "nam",
  • "username": "zuskpxhvdkxhnytwumiwzhnehokvxqrvqifveopjgfzjrmiriskpczuxlmajdotbnipbctcgnxqzrcwpmgdywkfmvhklmesbcvlqjwcnhhmlfnmnypcaohmomdfngoygyagnsbydmyradyhilvsypjztyovlielivlfdwnughxsklnxknyxwgtipjqobulrrdexsibcprbapnriekmgcjbcccbmdrnyemduvyalhmflehwbufxgzajreawcqxch",
  • "role_id": 14,
  • "accountstatus": "disabled",
  • "timezone": "Asia/Macau",
  • "datetimeFormat": "nisi",
  • "darkmode": "0",
  • "allowedHosts": [
    ],
  • "language": "qui",
  • "sessionTimeout": null
}

/api/users/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the user.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/users/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the user.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
name
string
email
string

Must be a valid email address.

password
string
root_owner
integer
description
string
username
string

Must not be greater than 255 characters.

accountstatus
string

Must be one of enabled or disabled.

role_id
integer
timezone
string

Must be a valid time zone, such as Africa/Accra.

datetimeFormat
string
darkmode
string

Must be one of 0 or 1.

prefs
object

Table prefs.

allowedHosts
Array of strings

Must be an array of valid IP addresses. Login will be restricted to the specified IPs. Leave empty to allow all IPs.

language
string
sessionTimeout
string

Request samples

Content type
application/json
{
  • "name": "sed",
  • "email": "tess61@example.com",
  • "password": "placeat",
  • "root_owner": 8,
  • "description": "soluta",
  • "username": "spwbtxbgipbtdheoyjyjsvamcgtzfyhajlynvsarzhehmekgowoghkwdkmxrzjbmowhfjclwgxrsztnzxcsctyijszwwsyooxzkzanrstbajdpbpramcuuvfappkdktddeifvzfxxspskozogavteorcvka",
  • "accountstatus": "enabled",
  • "role_id": 8,
  • "timezone": "Europe/Budapest",
  • "datetimeFormat": "ratione",
  • "darkmode": "1",
  • "prefs": null,
  • "allowedHosts": [
    ],
  • "language": "quaerat",
  • "sessionTimeout": null
}

/api/users/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the user.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

/api/users/{user_id}/loginhistory

Authorizations:
default
path Parameters
user_id
required
integer
Example: 6

The ID of the user.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/users/{user_id}/accesslog

Authorizations:
default
path Parameters
user_id
required
integer
Example: 9

The ID of the user.

limit
required
integer
Examples:
  • - When the value is omitted
  • 16 - When the value is present

Optional parameter. Limit the returned results.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

POST api/users/loginDetails

Verify the login details of a user account via the API.

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
identify
required
string

The username or email of the user.

password
required
string

The password of the user.

two_factor_code
string

The two-factor authentication code.

Responses

Request samples

Content type
application/json
{
  • "identify": "magni",
  • "password": "quia",
  • "two_factor_code": "123456"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/virtualization/vpsplans

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/virtualization/vpsplans

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
planname
required
string
planconfig
required
object

The plan configuration.

providerId
required
integer

Request samples

Content type
application/json
{
  • "planname": "et",
  • "planconfig": [
    ],
  • "providerId": 3
}

/api/virtualization/vpsplans/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the VPS plan.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/virtualization/vpsplans/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the VPS plan.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
planname
required
string
planconfig
required
object

The plan configuration.

providerId
required
integer

Request samples

Content type
application/json
{
  • "planname": "omnis",
  • "planconfig": [
    ],
  • "providerId": 15
}

/api/virtualization/vpsplans/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the VPS plan.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

/api/virtualization/vpsplans/{vpsplan}/duplicate

Authorizations:
default
path Parameters
vpsplan
required
integer
Example: 1

The ID of the VPS plan.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/virtualization/balancerplans/testBalancerConfiguration

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
providerId
required
integer
cpuPriority
number

Must be at least 0.01. Must not be greater than 99999.

cpuRequireIdlePercentage
number

Must be at least 0.01. Must not be greater than 100.

storagePriority
number

Must be at least 0.01. Must not be greater than 99999.

storageReserveFreeAmount
integer
ramPriority
number

Must be at least 0.01. Must not be greater than 99999.

ramReserveFreeAmount
integer
vmCountPriority
number

Must be at least 0.01. Must not be greater than 99999.

vmMaxAmount
integer

Must be at least 1. Must not be greater than 999999.

vmMaxAmountPerCore
number

Must be at least 0.01. Must not be greater than 99999.

diskSize
integer
ramSize
integer
nodeMustMatchRegex
string

Must not be greater than 65535 characters.

nodeMustNotMatchRegex
string

Must not be greater than 65535 characters.

Array of objects

Request samples

Content type
application/json
{
  • "providerId": 11,
  • "cpuPriority": 38711,
  • "cpuRequireIdlePercentage": 52,
  • "storagePriority": 91940,
  • "storageReserveFreeAmount": 20,
  • "ramPriority": 90929,
  • "ramReserveFreeAmount": 14,
  • "vmCountPriority": 64617,
  • "vmMaxAmount": 788215,
  • "vmMaxAmountPerCore": 15436,
  • "diskSize": 4,
  • "ramSize": 19,
  • "nodeMustMatchRegex": "/^node[0-9]+$/",
  • "nodeMustNotMatchRegex": "/^gluster[0-9]+$/",
  • "storages": [
    ]
}

/api/virtualization/balancerplans

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "message": "success"
}

/api/virtualization/balancerplans

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
planname
required
string

Must not be greater than 255 characters.

cpuPriority
number

Must be at least 0.01. Must not be greater than 99999.

cpuRequireIdlePercentage
number

Must be at least 0.01. Must not be greater than 100.

storagePriority
number

Must be at least 0.01. Must not be greater than 99999.

storageReserveFreeAmount
integer
ramPriority
number

Must be at least 0.01. Must not be greater than 99999.

ramReserveFreeAmount
integer
vmCountPriority
number

Must be at least 0.01. Must not be greater than 99999.

vmMaxAmount
integer

Must be at least 1. Must not be greater than 999999.

vmMaxAmountPerCore
number

Must be at least 0.01. Must not be greater than 99999.

nodeMustMatchRegex
string

Must not be greater than 65535 characters.

nodeMustNotMatchRegex
string

Must not be greater than 65535 characters.

Request samples

Content type
application/json
{
  • "planname": "aqcexvwfrgerkyajqjkodwvosabtrihnrgjwahiztwmqnqmkultnxxwckrcxmskkcicmtmkewgkhxvssblqpeyrtttowepxdefkkvhztdbpnoovwvfhsqdhvpxmzkv",
  • "cpuPriority": 33401,
  • "cpuRequireIdlePercentage": 42,
  • "storagePriority": 17793,
  • "storageReserveFreeAmount": 1,
  • "ramPriority": 2739,
  • "ramReserveFreeAmount": 16,
  • "vmCountPriority": 23647,
  • "vmMaxAmount": 800077,
  • "vmMaxAmountPerCore": 22710,
  • "nodeMustMatchRegex": "/^node[0-9]+$/",
  • "nodeMustNotMatchRegex": "/^gluster[0-9]+$/"
}

/api/virtualization/balancerplans/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the VPS balancer plan.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "message": "success"
}

/api/virtualization/balancerplans/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the VPS balancer plan.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
optional
planname
string

Must not be greater than 255 characters.

cpuPriority
number

Must be at least 0.01. Must not be greater than 99999.

cpuRequireIdlePercentage
number

Must be at least 0.01. Must not be greater than 100.

storagePriority
number

Must be at least 0.01. Must not be greater than 99999.

storageReserveFreeAmount
integer
ramPriority
number

Must be at least 0.01. Must not be greater than 99999.

ramReserveFreeAmount
integer
vmCountPriority
number

Must be at least 0.01. Must not be greater than 99999.

vmMaxAmount
integer

Must be at least 1. Must not be greater than 999999.

vmMaxAmountPerCore
number

Must be at least 0.01. Must not be greater than 99999.

nodeMustMatchRegex
string

Must not be greater than 65535 characters.

nodeMustNotMatchRegex
string

Must not be greater than 65535 characters.

Request samples

Content type
application/json
{
  • "planname": "dgbnueceljwnmbmenrtckzzxguweoiqjlenvtimalolhqfcmqgkdmraeqkwrzppsloqbludqnyheziqymllwlvdevyrejnkteiazsrgmkxjcnylqkotgxs",
  • "cpuPriority": 86490,
  • "cpuRequireIdlePercentage": 97,
  • "storagePriority": 94664,
  • "storageReserveFreeAmount": 16,
  • "ramPriority": 70052,
  • "ramReserveFreeAmount": 5,
  • "vmCountPriority": 22512,
  • "vmMaxAmount": 800937,
  • "vmMaxAmountPerCore": 11417,
  • "nodeMustMatchRegex": "/^node[0-9]+$/",
  • "nodeMustNotMatchRegex": "/^gluster[0-9]+$/"
}

/api/virtualization/balancerplans/{id}

Authorizations:
default
path Parameters
id
required
integer
Example: 1

The ID of the VPS balancer plan.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json