Pterodactyldocs
Client A P I

Get websocket credentials

Returns a short-lived Wings websocket token and socket URL for the server.

GET/api/client/servers/{server_uuid}/websocket

Authorization

default
AuthorizationBearer <token>

Application API requests require an application API token, or a client API token, that belongs to a root administrator. Admin API requests require a client API token that belongs to a root administrator, and reject application API tokens. Client API requests require a client API token.

In: header

Path Parameters

server_uuid*string

The server UUID.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/client/servers/d3aac109-e5a0-4331-b03e-3454f7e02bbe/websocket"
{  "data": {    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.example.signature",    "socket": "wss://node.example.test/api/servers/4fcb1f44-0f90-4a1a-a8bf-7cc8a14d0f26/ws"  }}

Get server GET

Returns details for one server the authenticated user can access.

Get server resources GET

Returns the latest cached resource utilization reported by Wings for the server.