Instance

Logs

Operations dealing with client, server and audit logs.

Send client log

POST

https://peertube2.cpy.re/api/v1/server/logs/client

Send client log

curl -X POST 'https://peertube2.cpy.re/api/v1/server/logs/client' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "message": "string",
  "url": "string",
  "level": "error",
  "stackTrace": "string",
  "userAgent": "string",
  "meta": "string"
}'

const body = `{
  "message": "string",
  "url": "string",
  "level": "error",
  "stackTrace": "string",
  "userAgent": "string",
  "meta": "string"
}`;

const response = await fetch('https://peertube2.cpy.re/api/v1/server/logs/client', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "message": "string",
  "url": "string",
  "level": "error",
  "stackTrace": "string",
  "userAgent": "string",
  "meta": "string"
}'''

response = requests.post(
    'https://peertube2.cpy.re/api/v1/server/logs/client',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "message": "string",
  "url": "string",
  "level": "error",
  "stackTrace": "string",
  "userAgent": "string",
  "meta": "string"
}

Body

application/json

messagestringrequired

urlstringrequired

URL of the current user page

levelanyerrorwarnrequired

stackTracestring

Stack trace of the error if there is one

userAgentstring

User agent of the web browser that sends the message

metastring

Additional information regarding this log

Response

204No Content

successful operation

Get instance logs

GET

https://peertube2.cpy.re/api/v1/server/logs

Get instance logs

curl -X GET 'https://peertube2.cpy.re/api/v1/server/logs' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/server/logs', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/server/logs',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

[
  "string"
]

Response

200OKArray<string>

successful operation

Response fields application/json

Array<string>

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

Have an activated account
Generate an access token for that account at /api/v1/users/token.
Make requests with the Authorization: Bearer <token> header
Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Scopes: admin

Get instance audit logs

GET

https://peertube2.cpy.re/api/v1/server/audit-logs

User, administration and moderation actions recorded by all the PeerTube processes of the instance.

By default (format=array), returns an array of at most the 10,000 most recent entries of the requested date range, oldest first. startDate is then required and pagination parameters are ignored.

With format=list, returns a paginated list.

Get instance audit logs

curl -X GET 'https://peertube2.cpy.re/api/v1/server/audit-logs?format=array&count=15' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/server/audit-logs?format=array&count=15', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/server/audit-logs?format=array&count=15',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

[
  {
    "id": 42,
    "action": "create",
    "entityType": "video",
    "entityId": 0,
    "user": {
      "id": 0,
      "username": "string"
    },
    "ip": "string",
    "entity": {},
    "changes": {},
    "createdAt": "2024-01-15T09:30:00Z",
    "timestamp": "2024-01-15T09:30:00Z",
    "level": "audit",
    "message": "string"
  }
]

Parameters

formatstringarraylistarrayquery

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstring-createdAtcreatedAtquery

searchstringquery

Search in usernames, IP addresses and audited entities

entityTypeAuditLogEntityTypevideovideo-importvideo-livevideo-sourcevideo-filevideo-captionvideo-chaptersvideo-passwordvideo-embed-privacyvideo-transcodingvideo-transcriptionvideo-studio-editionvideo-player-settingsownership-changecommentchannelchannel-syncchannel-videos-importchannel-collaboratorchannel-player-settingschannel-playlists-orderplaylistplaylist-elementplaylist-elements-orderuserregistrationpassword-resettoken-sessionfailed-loginscoped-tokenuser-exportuser-importabuseabuse-messagevideo-blockaccount-blockserver-blockblocklist-subscriptionwatched-words-listwatched-words-subscriptionautomatic-tag-policyconfiginstance-imageinstance-homepageinstance-hostpluginfollowserver-redundancyvideo-redundancyjob-queuejobrunnerrunner-registration-tokendebug-commandstorage-prunequery

entityIdintegerquery

actionAuditLogActioncreateupdatedeletequery

startDatestring<date-time>query

Required with the default array format

endDatestring<date-time>query

Response

200OKArray<AuditLog> | object

successful operation

Response fields application/json

One of

Default array format

Array<AuditLog>

Show child attributes

idid>= 1

Example

actionAuditLogActioncreateupdatedelete

entityIdinteger | null

Id of the audited entity, null for the instance configuration

userobject

Show child attributes

idinteger | null

null if the user has been deleted, for remote actors or for entries imported from the legacy audit log files

usernamestring

Username at the time of the action, or the actor handle for remote actors

ipstring | null

IP address of the request, anonymized if log.anonymize_ip is enabled

entityobject

Snapshot of the entity after the action (before the action for deletions)

changesobject | null

Only for updates. Keys are dot-separated paths of the changed entity attributes

Show child attributes

[key: string]object

Show child attributes

oldany

newany

createdAtstring<date-time>

timestampstring<date-time>deprecated

Same as createdAt. Field of the format used before audit logs were stored in the database

levelstringauditdeprecated

Field of the format used before audit logs were stored in the database

messagestringdeprecated

JSON string containing the user, domain (entity type), action, entityId, ip and changes of the entry, and the properties of the audited entity. Field of the format used before audit logs were stored in the database

list format

totalinteger

Example

dataArray<AuditLog>

Show child attributes

idid>= 1

Example

actionAuditLogActioncreateupdatedelete

entityIdinteger | null

Id of the audited entity, null for the instance configuration

userobject

Show child attributes

idinteger | null

null if the user has been deleted, for remote actors or for entries imported from the legacy audit log files

usernamestring

Username at the time of the action, or the actor handle for remote actors

ipstring | null

IP address of the request, anonymized if log.anonymize_ip is enabled

entityobject

Snapshot of the entity after the action (before the action for deletions)

changesobject | null

Only for updates. Keys are dot-separated paths of the changed entity attributes

Show child attributes

[key: string]object

Show child attributes

oldany

newany

createdAtstring<date-time>

timestampstring<date-time>deprecated

Same as createdAt. Field of the format used before audit logs were stored in the database

levelstringauditdeprecated

Field of the format used before audit logs were stored in the database

messagestringdeprecated

403Forbidden

audit log is disabled

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

Have an activated account
Generate an access token for that account at /api/v1/users/token.
Make requests with the Authorization: Bearer <token> header
Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Scopes: admin

Docs by Sourcey