Servers

Remove a server

delete

Remove a server with the given ID

Path parameters

server_idstring · uuidRequired

Responses

default

delete

/servers/{server_id}

HTTPcURLJavaScriptPython

DELETE /v1/servers/{server_id} HTTP/1.1
Host: 
Accept: */*

default

No content

Get server by ID

get

Fetch a specific server by its ID

Path parameters

idstring · uuidRequired

Responses

200Success

application/json

default

application/json

get

/servers/{id}

HTTPcURLJavaScriptPython

GET /v1/servers/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "text",
  "serverName": "text",
  "serverIp": "text",
  "machineId": "text",
  "nicIds": [
    {
      "id": "text",
      "createdAt": "text",
      "nicName": "text",
      "serverId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Update an existing server

put

Update an existing server with the provided details

Path parameters

idstring · uuidRequired

Body

application/json

Update a server with the given ID

serverNamestringRequired

serverIpstringRequired

machineIdstringRequired

nicIdsstring[]Required

Responses

200Success

application/json

default

application/json

put

/servers/{id}

HTTPcURLJavaScriptPython

PUT /v1/servers/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "serverName": "text",
  "serverIp": "text",
  "machineId": "text",
  "nicIds": [
    "text"
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "text",
  "serverName": "text",
  "serverIp": "text",
  "machineId": "text",
  "nicIds": [
    {
      "id": "text",
      "createdAt": "text",
      "nicName": "text",
      "serverId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}