Overview

API reference

Every public endpoint of the Serverside.com REST API, with its parameters, request and response fields, samples in nine languages and a playground that sends real requests.

https://api.serverside.com

Requests carry an organization API key in the X-API-KEY header (Authentication), and every response comes in the envelope described in API conventions. Nine groups work differently: organization (apart from Get entitlements), members, invitations, roles, API keys, notifications, profile, support and currencies take a cloud console session and answer a key with 401 (Operations a key cannot call).

Each endpoint page lists the parameters and fields, shows the request in cURL, Node.js, Python, Go, PHP, Ruby, Java, C# and PowerShell, and has a Try it button that sends the request to the live API with the key you paste.

The reference is generated from the API's OpenAPI description. Download it as JSON to generate a client or import it into an API tool.

Endpoint groups

Area	Group	Covers
Bare metal	Servers	Create, list, rename, lock and delete services
	Power	Power commands, BMC reset, PSU, thermal and power readings
	Operations	OS images and applications, deployments, hardware tests
	Remote access	KVM sessions and virtual media
	Boot and iPXE	Custom iPXE script and boot mode
	Service ISOs	ISOs on one service; the group's upload calls are deprecated
	Networking	Ports, logical interfaces, security scan results
	Bandwidth	Monthly usage and traffic history
	Activity	Audit log of one service
Networking	Virtual networks	Create networks, VLAN tags, attach and detach servers
	IPv4 and IPv6	Reserve, assign and release addresses; reverse DNS for IPv4
	IP blocks	Add or return a prefix
	Firewalls	Groups, rules and assignments
	Security scans	Findings, targets and rescans
Billing	Orders	Place and read orders
	Subscriptions	Renewal state and cancellation requests
	Invoices	Read, pay and download invoices
	Usage	Charges in the current period
	Credit and Payment methods	Account credit and saved cards
	Plans and Currencies	Bare metal and IP block plans with prices and stock; currencies with conversion rates
Organization	Organization	Details, ownership transfer, entitlements
	Members, Invitations and Roles	Members, pending invitations and the permissions each role grants
	API keys and SSH keys	Keys for the API and for new servers
	Activity and Notifications	Organization audit log and notices
Account and assets	Profile, ISO library, Countries, Support	Your user profile, uploaded ISOs, address formats, support tickets

Admin and internal endpoints are not published.

Endpoint groups

Pie de página