Overview

API reference

Every endpoint an organization API key can call, with its parameters, request and response fields, the permission it checks, samples in nine languages and a playground that sends real requests.

https://api.serverside.com

Requests carry an organization API key as a Bearer token in the Authorization header (Authentication). A call that works answers with success, data and, on a paged list, pagination; one that fails answers with an HTTP status and the error envelope, whose code says what went wrong (API conventions).

The reference lists the operations a key can call and no others. Members, roles, invitations, API keys, notifications, your profile and support tickets are handled in the cloud console, and their endpoints answer a key with 401 (Operations a key cannot call).

Each endpoint page lists the parameters and fields, names the permission the key needs where the operation checks one, and shows an example body for every status it can answer, errors included. The request is written out in cURL, Node.js, Python, Go, PHP, Ruby, Java, C# and PowerShell, and Try it sends it to the live API with the key you paste.

The reference is generated from the API's customer OpenAPI document, the description of the operations an organization API key can call. Download it as JSON to generate a client or import it into an API tool.

Endpoint groups

Area	Group	Covers
Bare metal	Servers	List, create on hourly billing, rename, lock and delete servers; each server's status, subscription and virtual networks
	Power	Power commands, BMC reset, PSU, thermal and power readings
	Operations	OS images and applications, deployments, hardware tests and cancelling them
	Remote access	Console sessions and virtual media
	Boot and iPXE	Custom iPXE script and boot mode
	Service ISOs	The ISOs a server can mount, and which of them are mounted
	Networking	Ports, segments, security scan results
	Bandwidth	Daily transfer against the monthly allowance, and traffic rate history
	Activity	Audit log of one server
Networking	Virtual networks	Create networks, VLAN tags, attach and detach servers
	IP blocks	List blocks and their addresses, add or return a block
	IP addresses	Assign, reserve and release addresses; reverse DNS for IPv4
	Security scans	Findings, targets and rescans
Billing	Orders	Place and read orders
	Subscriptions	Renewal state and cancellation
	Invoices	Read, pay and download invoices
	Usage	Charges in the current period
	Credit and Payment methods	Account credit and saved cards
Catalog	Plans	Bare metal and IP block plans with prices and stock
	Regions	The datacenters services can be ordered in, with their codes
Organization	Entitlements	Limits and features switched on for the organization, hourly billing among them
	SSH keys	Public keys to install on new servers
	Activity	The organization's audit log
Assets	ISO library	Upload and delete the ISOs that virtual media mounts

Endpoint groups

Voettekst