ClientServerCommandGetResponse

ClientServerCommandGetResponse

Get a specific server command for a client and server

get

Fetch a server by its UUID for a specific client and server.

Authorizations

token

X-API-KeystringRequired

Path parameters

clientIdintegerRequired

ID of the client

Example: 42

serverUuidstring · uuidRequired

UUID of the server

Example: 550e8400-e29b-41d4-a716-446655440000

commandUuidstring · uuidRequired

UUID of the server command

Example: 550e8400-e29b-41d4-a716-446655440000

Responses

200

Successful operation

application/json

401

Unauthenticated

404

Server command not found

application/json

get

/api/v1/client/{clientId}/server/{serverUuid}/command/{commandUuid}

HTTPcURLJavaScriptPython

GET /api/v1/client/{clientId}/server/{serverUuid}/command/{commandUuid} HTTP/1.1
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "command": {
    "uuid": "0194e0db-6967-73b5-831b-abce4d016ba8",
    "server_uuid": "3f01c75f-2219-3d85-b436-b215d90f977c",
    "payload": {
      "command": "reboot"
    },
    "state": "finished",
    "created_at": "2025-01-01T13:30:01.000000Z",
    "updated_at": "2025-01-01T13:30:01.000000Z"
  }
}

List server commands

get

Retrieve a list of server commands with pagination.

Authorizations

token

X-API-KeystringRequired

Path parameters

clientIdintegerRequired

ID of the client

serverUuidstring · uuidRequired

UUID of the server

Query parameters

pageintegerOptional

Page number for pagination

Example: 1

perPageintegerOptional

Number of items per page

Example: 15

Responses

200

Successful operation

application/json

401

Unauthenticated

get

/api/v1/client/{clientId}/server/{serverUuid}/command

HTTPcURLJavaScriptPython

GET /api/v1/client/{clientId}/server/{serverUuid}/command HTTP/1.1
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "commands": [
    {
      "uuid": "0194e0db-6967-73b5-831b-abce4d016ba8",
      "server_uuid": "3f01c75f-2219-3d85-b436-b215d90f977c",
      "payload": {
        "command": "reboot"
      },
      "state": "finished",
      "created_at": "2025-01-01T13:30:01.000000Z",
      "updated_at": "2025-01-01T13:30:01.000000Z"
    }
  ],
  "paginator": {
    "from": "1",
    "to": "10",
    "total": "20",
    "current_page": "1",
    "last_page": "1",
    "first_page_url": "http://localhost:8100/api/v1/servers/1?page=1",
    "prev_page_url": null,
    "next_page_url": "http://localhost:8100/api/v1/orders/1?page=2",
    "last_page_url": "http://localhost:8100/api/v1/orders/1?page=3",
    "path": "http://localhost:8100/api/v1/orders/1",
    "per_page": "10"
  }
}

Execute server commands

post

Execute server commands on a delivered server, e.g. power-on, power-off and reboot.

Authorizations

token

X-API-KeystringRequired

Path parameters

clientIdintegerRequired

ID of the client

serverUuidstring · uuidRequired

UUID of the server

Body

application/json

ClientServerCommand request model

commandstringOptional

Command to be executed on delivered server

Example: reboot

Responses

200

Successful operation

application/json

Response model for the created server command

400

Bad Request

401

Unauthenticated

422

Unprocessable Content

post

/api/v1/client/{clientId}/server/{serverUuid}/command

HTTPcURLJavaScriptPython

POST /api/v1/client/{clientId}/server/{serverUuid}/command HTTP/1.1
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "command": "reboot"
}

{
  "command": [
    {
      "uuid": "0194e0db-6967-73b5-831b-abce4d016ba8",
      "server_uuid": "3f01c75f-2219-3d85-b436-b215d90f977c",
      "payload": {
        "command": "reboot"
      },
      "state": "finished",
      "created_at": "2025-01-01T13:30:01.000000Z",
      "updated_at": "2025-01-01T13:30:01.000000Z"
    }
  ]
}