Servers
Endpoints for listing your servers and controlling one directly — the same actions the Overview and Console pages perform, callable from a script or bot.
Power and command actions return 202 Accepted: the request has been queued for the server's
daemon, not yet applied. Poll GET /api/v1/servers/{id} or the activity endpoint below to
confirm the effect.
Authorization
bearer In: header
Response Body
application/json
application/json
curl -X GET "https://example.com/api/v1/servers"{
"data": [
{
"cpuLimit": 0,
"createdAt": "2019-08-24T14:15:22Z",
"diskGb": 0,
"eggId": "string",
"id": "string",
"isSuspended": true,
"memoryMb": 0,
"name": "string",
"nodeId": "string",
"status": "string",
"suspendedReason": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"meta": {
"requestId": "string"
}
}{
"error": {
"code": "string",
"details": [
"string"
],
"message": "string",
"requestId": "string",
"retryAfterSeconds": 0
}
}Authorization
bearer In: header
Path Parameters
Server id
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/servers/string"{
"data": {
"cpuLimit": 0,
"createdAt": "2019-08-24T14:15:22Z",
"diskGb": 0,
"eggId": "string",
"id": "string",
"isSuspended": true,
"memoryMb": 0,
"name": "string",
"nodeId": "string",
"status": "string",
"suspendedReason": "string",
"updatedAt": "2019-08-24T14:15:22Z"
},
"meta": {
"requestId": "string"
}
}{
"error": {
"code": "string",
"details": [
"string"
],
"message": "string",
"requestId": "string",
"retryAfterSeconds": 0
}
}{
"error": {
"code": "string",
"details": [
"string"
],
"message": "string",
"requestId": "string",
"retryAfterSeconds": 0
}
}Authorization
bearer In: header
Path Parameters
Server id
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/servers/string/power" \ -H "Content-Type: application/json" \ -d '{ "action": "start" }'{
"data": {
"id": "string",
"status": "string"
},
"meta": {
"requestId": "string"
}
}{
"error": {
"code": "string",
"details": [
"string"
],
"message": "string",
"requestId": "string",
"retryAfterSeconds": 0
}
}{
"error": {
"code": "string",
"details": [
"string"
],
"message": "string",
"requestId": "string",
"retryAfterSeconds": 0
}
}Authorization
bearer In: header
Path Parameters
Server id
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/servers/string/command" \ -H "Content-Type: application/json" \ -d '{ "command": "string" }'{
"data": {
"id": "string",
"status": "string"
},
"meta": {
"requestId": "string"
}
}{
"error": {
"code": "string",
"details": [
"string"
],
"message": "string",
"requestId": "string",
"retryAfterSeconds": 0
}
}{
"error": {
"code": "string",
"details": [
"string"
],
"message": "string",
"requestId": "string",
"retryAfterSeconds": 0
}
}Authorization
bearer In: header
Path Parameters
Server id
Query Parameters
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/servers/string/activity"{
"data": [
{
"action": "string",
"actorId": "string",
"category": "string",
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"ipAddress": "string",
"metadata": {},
"userAgent": "string"
}
],
"meta": {
"requestId": "string"
}
}{
"error": {
"code": "string",
"details": [
"string"
],
"message": "string",
"requestId": "string",
"retryAfterSeconds": 0
}
}{
"error": {
"code": "string",
"details": [
"string"
],
"message": "string",
"requestId": "string",
"retryAfterSeconds": 0
}
}