Logs

Open a log watcher session

get

/api/admin/logs/connect

Starts a watcher session and returns the websocket URL to read the logs from.

Authorizations

OAuth2implicitRequired

Authorization URL:

Responses

200

Session started; open the websocket immediately.

Where to open the log websocket, and the watcher session that keeps it fed.

websocketUristring · uriOptional

Websocket URL to read the logs from. Valid for 10 seconds: open the socket right away.

sessionIdstringOptional

Watcher session to send to ping. Opaque, 32 hexadecimal characters.

401

The caller is not authenticated.

application/problem+json

403

The caller does not hold the global:administrator role.

application/problem+json

get/api/admin/logs/connect

GET /api/admin/logs/connect HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "websocketUri": "https://example.com",
  "sessionId": "text"
}

Keep a log watcher session alive

post

/api/admin/logs/ping

Extends the session by 45 seconds. Answers 204 whatever the session's state; when logs stop arriving, call connect again to start a new session.

Authorizations

OAuth2implicitRequired

Authorization URL:

Body

Request body to keep a watcher session alive.

sessionIdstringOptional

Session returned by connect.

Responses

204

Ping accepted.

No content

400

sessionId is missing or blank.

401

The caller is not authenticated.

application/problem+json

403

The caller does not hold the global:administrator role.

application/problem+json

post/api/admin/logs/ping

POST /api/admin/logs/ping HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "sessionId": "text"
}

No content