Workspace

Set System Logs

PATCHhttps://api.vaakyo.com/api/v1/workspace/system-logs

Show or hide the server log (Logs > System) for this workspace; off by default.

Authorization

A signed-in member with the members.manage permission (Authorization: Bearer session token). API keys can’t do this.

Authorization: Bearermembers.manage

Query parameters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Body application/json

enabledbooleanrequired

Response

200Success.

No body.

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.

detailstring

What went wrong, in plain words.

422Validation Error

detailobject[]

Show item attributes

locstring | integer[]

msgstring

typestring

curl --request PATCH \
  --url 'https://api.vaakyo.com/api/v1/workspace/system-logs?timezone=Asia/Kolkata' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "enabled": true
}'

import requests

url = "https://api.vaakyo.com/api/v1/workspace/system-logs"
params = {
    "timezone": "Asia/Kolkata",
}
headers = {
    "Authorization": "Bearer <token>",
}
payload = {
    "enabled": True,
}

response = requests.patch(url, params=params, headers=headers, json=payload)
print(response.status_code, response.json())

const response = await fetch("https://api.vaakyo.com/api/v1/workspace/system-logs?timezone=Asia/Kolkata", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "enabled": true
  }),
})
const data = await response.json()
console.log(response.status, data)

Response

{
  "detail": "sign in required"
}

{
  "detail": "your role cannot do this (members.manage)"
}

{
  "detail": [
    {
      "type": "missing",
      "loc": [
        "body",
        "name"
      ],
      "msg": "Field required",
      "input": {}
    }
  ]
}