Admin routes

Generated from openapi.yaml of games-api 0.7.0: 93 routes.

GET /v1/admin/me: Who am I and what can I edit
GET /v1/admin/accounts: Staff only. Accounts, newest first
GET /v1/admin/accounts/{accountId}: Staff only. One account with its memberships
PATCH /v1/admin/accounts/{accountId}: Staff only. Change name, email, flags, or disable the account
POST /v1/admin/accounts/{accountId}/reset-link: Staff only. Email the account a password reset link
DELETE /v1/admin/accounts/{accountId}/totp: Staff only. Remove the account’s TOTP
DELETE /v1/admin/accounts/{accountId}/sessions: Staff only. Revoke every session of the account
POST /v1/admin/accounts/{accountId}/impersonate: Staff only. Open a one-hour session on a developer’s account
GET /v1/admin/invitations: Staff only. Invitations, newest first
POST /v1/admin/invitations: Staff only. Invite an email address
DELETE /v1/admin/invitations/{invitationId}: Staff only. Revoke an invitation; its link stops working
POST /v1/admin/invitations/{invitationId}/resend: Staff only. Send the invitation email again with a fresh 7-day token
GET /v1/admin/invitation-requests: Staff only. Requests from the form on developers.filudi.com, newest first
PATCH /v1/admin/invitation-requests/{requestId}: Staff only. Dismiss a request
GET /v1/admin/approvals: Staff only. Everything that waits for approval, oldest first
GET /v1/admin/sites: Sites the account can see; an account with no site membership gets an empty list
POST /v1/admin/sites: Create a site
GET /v1/admin/sites/{siteId}: One site
PATCH /v1/admin/sites/{siteId}: Update policy, domains, locales, name
POST /v1/admin/sites/{siteId}/approve: Staff only. Approve a pending site
POST /v1/admin/sites/{siteId}/reject: Staff only. Send the owners a reason; the site stays pending
POST /v1/admin/sites/{siteId}/domains/approve: Staff only. Move proposed domains into the site’s domains
POST /v1/admin/sites/{siteId}/domains/reject: Staff only. Remove proposed domains and send the owners the reason
GET /v1/admin/sites/{siteId}/members: Members of a site
POST /v1/admin/sites/{siteId}/members: Add a member by email
DELETE /v1/admin/sites/{siteId}/members/{accountId}: Remove a member
DELETE /v1/admin/sites/{siteId}/members/invitations/{invitationId}: Withdraw an invitation
GET /v1/admin/sites/{siteId}/keys: Server keys of a site, revoked ones included
POST /v1/admin/sites/{siteId}/keys: Create a server key; the answer shows it once
DELETE /v1/admin/sites/{siteId}/keys/{keyId}: Revoke a server key
GET /v1/admin/sites/{siteId}/categories: Categories of a site, in site order, with the number of games in each
POST /v1/admin/sites/{siteId}/categories: Add a category at the end of the site order
PUT /v1/admin/sites/{siteId}/categories/order: Reorder the categories
GET /v1/admin/sites/{siteId}/categories/{slug}: One category
PATCH /v1/admin/sites/{siteId}/categories/{slug}: Update texts and icon
DELETE /v1/admin/sites/{siteId}/categories/{slug}: Remove the category from the site, from its games and from the top menu
GET /v1/admin/sites/{siteId}/tags: Tags of a site, in site order, with the number of games carrying each
POST /v1/admin/sites/{siteId}/tags: Add a tag at the end of the site order
PUT /v1/admin/sites/{siteId}/tags/order: Reorder the tags
GET /v1/admin/sites/{siteId}/tags/{slug}: One tag
PATCH /v1/admin/sites/{siteId}/tags/{slug}: Update the titles
DELETE /v1/admin/sites/{siteId}/tags/{slug}: Remove the tag from the site and from its games
GET /v1/admin/sites/{siteId}/catalog: Site catalog entries with every locale
PUT /v1/admin/sites/{siteId}/catalog/order: Reorder the catalog
PUT /v1/admin/sites/{siteId}/catalog/{gameId}: Add or update a game in the site catalog
DELETE /v1/admin/sites/{siteId}/catalog/{gameId}: Remove a game from the site catalog
POST /v1/admin/sites/{siteId}/publish: Make the catalog changes visible on the site front
GET /v1/admin/games: Every game with its versions
POST /v1/admin/games: Create a game
GET /v1/admin/games/{gameId}: One game
PATCH /v1/admin/games/{gameId}: Update a game
DELETE /v1/admin/games/{gameId}: Delete a game and everything attached to it (staff only)
POST /v1/admin/games/{gameId}/approve: Staff only. Approve a pending game
POST /v1/admin/games/{gameId}/reject: Staff only. Send the owners a reason; the game stays pending
GET /v1/admin/games/{gameId}/members: Members of a game
POST /v1/admin/games/{gameId}/members: Add a member by email
DELETE /v1/admin/games/{gameId}/members/{accountId}: Remove a member
DELETE /v1/admin/games/{gameId}/members/invitations/{invitationId}: Withdraw an invitation
GET /v1/admin/games/{gameId}/stats: One game’s numbers across every site that lists it, for a range of UTC days
POST /v1/admin/games/{gameId}/versions: Start a version upload
POST /v1/admin/games/{gameId}/media/{slot}: Start a media upload
DELETE /v1/admin/games/{gameId}/media/{slot}: Empty the slot
POST /v1/admin/games/{gameId}/media/{slot}/finalize: Check the uploaded file and put it in the slot
POST /v1/admin/versions/{versionId}/finalize: Unpack the uploaded zip into the bundle prefix
POST /v1/admin/versions/{versionId}/activate: Make this version live; the previous live one goes back to draft (staff only)
POST /v1/admin/versions/{versionId}/retire: Retire a version; its bundle stops being served (staff only)
POST /v1/admin/versions/{versionId}/review: Ask staff to review a draft and make it live
POST /v1/admin/versions/{versionId}/review/reject: Staff only. Decline a review request and send the owners the reason
GET /v1/admin/versions/{versionId}/preview: Signed URL to play a draft version for 1 hour
GET /v1/admin/games/{gameId}/leaderboards: Boards of a game
PUT /v1/admin/games/{gameId}/leaderboards: Replace the boards of a game
GET /v1/admin/games/{gameId}/leaderboards/{board}/scores: Scores for moderation
POST /v1/admin/scores/{scoreId}: Unhide a score
DELETE /v1/admin/scores/{scoreId}: Hide a score
GET /v1/admin/sites/{siteId}/players: List the players of a site, with an optional search
GET /v1/admin/players/{playerId}: Player detail with saves metadata and best scores
DELETE /v1/admin/players/{playerId}: Schedule deletion (GDPR request handled by support)
GET /v1/admin/players/{playerId}/export: Export a player’s data
GET /v1/admin/sites/{siteId}/comments: Comments of a site for moderation, newest first
DELETE /v1/admin/comments/{commentId}: Delete a comment for good
POST /v1/admin/comments/{commentId}/hide: Hide a comment from every player route
POST /v1/admin/comments/{commentId}/unhide: Show a hidden comment again
GET /v1/admin/sites/{siteId}/ratings: Rating of every rated game of a site
GET /v1/admin/sites/{siteId}/feedback: Feedback of a site, newest first
GET /v1/admin/feedback/{feedbackId}: One feedback message
PATCH /v1/admin/feedback/{feedbackId}: Change the status or the note
DELETE /v1/admin/feedback/{feedbackId}: Delete a feedback message for good
GET /v1/admin/sites/{siteId}/events/today: Counts since midnight UTC, live from the events table
GET /v1/admin/sites/{siteId}/events/daily: Daily aggregates
GET /v1/admin/sites/{siteId}/stats/overview: The site dashboard numbers for a range of UTC days
GET /v1/admin/sites/{siteId}/stats/games/{gameId}: One game’s numbers on this site for a range of UTC days
GET /v1/admin/sites/{siteId}/stats/web: Web audience from CausalIT (ADR 0009)
GET /v1/admin/audit: Audit log

GET `/v1/admin/me`

GET /v1/admin/me

curl 'https://api.filudi.com/v1/admin/me' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/me', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/me',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Who am I and what can I edit

The one /v1/admin/* route that answers for staff without TOTP. roles.admin is true for staff with TOTP enabled.

Credential: the console session cookie filudi_console, set by POST /v1/console/sign-in. From a browser, send credentials: 'include'; on a non-GET request the Origin header must be one of the console origins. With X-Filudi-Impersonation: 1 the API reads the filudi_impersonation cookie instead.

Responses

Status	Body	Description
200	ConsoleMe	Identity.
401	Error	Missing or invalid token.

GET `/v1/admin/accounts`

GET /v1/admin/accounts

curl 'https://api.filudi.com/v1/admin/accounts' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/accounts', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/accounts',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Staff only. Accounts, newest first

Parameters

Name	In	Type	Required	Description
`q`	query	string	no	Case-insensitive substring of the name, or an email matched by its hash; 2 to 100 characters
`cursor`	query	string	no	Opaque; the `nextCursor` of the previous page, with the same filters and sort; at most 200 characters
`limit`	query	integer	no	1 to 500; default `100`

Responses

Status	Body	Description
200	AccountPage	Accounts.
403	Error	Not allowed for this role or site.

GET `/v1/admin/accounts/{accountId}`

GET /v1/admin/accounts/{accountId}

curl 'https://api.filudi.com/v1/admin/accounts/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/accounts/00000000-0000-0000-0000-000000000000', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/accounts/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Staff only. One account with its memberships

Parameters

Name	In	Type	Required	Description
`accountId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	AccountAdmin	Account.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

PATCH `/v1/admin/accounts/{accountId}`

PATCH /v1/admin/accounts/{accountId}

curl -X PATCH 'https://api.filudi.com/v1/admin/accounts/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "name": "string",
  "email": "you@example.com",
  "staff": true,
  "canCreateGames": true,
  "canCreatePortals": true,
  "disabled": true
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/accounts/00000000-0000-0000-0000-000000000000', {
  method: 'PATCH',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    name: 'string',
    email: 'you@example.com',
    staff: true,
    canCreateGames: true,
    canCreatePortals: true,
    disabled: true,
  }),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.patch(
    'https://api.filudi.com/v1/admin/accounts/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'name': 'string',
        'email': 'you@example.com',
        'staff': True,
        'canCreateGames': True,
        'canCreatePortals': True,
        'disabled': True,
    },
)
response.raise_for_status()
data = response.json()

Staff only. Change name, email, flags, or disable the account

Disabling an account revokes its sessions. Every change writes an audit row.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string (uuid)	yes

Request body

application/json, required. The body is a AccountPatch. At least one field; an empty body is a 400.

Property	Type	Required	Description
`name`	AccountName	no	Display name, shown to other members and in the audit log; 1 to 80 characters
`email`	string (email)	no	Changed at once
`staff`	boolean	no	A new staff member gets admin rights once TOTP is enabled
`canCreateGames`	boolean	no
`canCreatePortals`	boolean	no
`disabled`	boolean	no	True revokes every session and refuses sign-in; false enables again

Responses

Status	Body	Description
200	AccountAdmin	Account.
400	Error	Validation failed.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.
409	none	The email is on another account.

POST `/v1/admin/accounts/{accountId}/reset-link`

POST /v1/admin/accounts/{accountId}/reset-link

curl -X POST 'https://api.filudi.com/v1/admin/accounts/00000000-0000-0000-0000-000000000000/reset-link' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/accounts/00000000-0000-0000-0000-000000000000/reset-link', {
  method: 'POST',
  credentials: 'include',
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/accounts/00000000-0000-0000-0000-000000000000/reset-link',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
# No body: the status says it all.

Staff only. Email the account a password reset link

Parameters

Name	In	Type	Required	Description
`accountId`	path	string (uuid)	yes

Responses

Status	Body	Description
202	none	Sent.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

DELETE `/v1/admin/accounts/{accountId}/totp`

DELETE /v1/admin/accounts/{accountId}/totp

curl -X DELETE 'https://api.filudi.com/v1/admin/accounts/00000000-0000-0000-0000-000000000000/totp' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/accounts/00000000-0000-0000-0000-000000000000/totp', {
  method: 'DELETE',
  credentials: 'include',
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.delete(
    'https://api.filudi.com/v1/admin/accounts/00000000-0000-0000-0000-000000000000/totp',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
# No body: the status says it all.

Staff only. Remove the account’s TOTP

For a lost authenticator. A staff account loses its admin rights until it enrols again.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string (uuid)	yes

Responses

Status	Body	Description
204	none	Removed, or there was none.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

DELETE `/v1/admin/accounts/{accountId}/sessions`

DELETE /v1/admin/accounts/{accountId}/sessions

curl -X DELETE 'https://api.filudi.com/v1/admin/accounts/00000000-0000-0000-0000-000000000000/sessions' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/accounts/00000000-0000-0000-0000-000000000000/sessions', {
  method: 'DELETE',
  credentials: 'include',
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.delete(
    'https://api.filudi.com/v1/admin/accounts/00000000-0000-0000-0000-000000000000/sessions',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
# No body: the status says it all.

Staff only. Revoke every session of the account

Parameters

Name	In	Type	Required	Description
`accountId`	path	string (uuid)	yes

Responses

Status	Body	Description
204	none	Revoked.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

POST `/v1/admin/accounts/{accountId}/impersonate`

POST /v1/admin/accounts/{accountId}/impersonate

curl -X POST 'https://api.filudi.com/v1/admin/accounts/00000000-0000-0000-0000-000000000000/impersonate' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/accounts/00000000-0000-0000-0000-000000000000/impersonate', {
  method: 'POST',
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/accounts/00000000-0000-0000-0000-000000000000/impersonate',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
data = response.json()

Staff only. Open a one-hour session on a developer’s account

Sets the filudi_impersonation cookie; the console sends X-Filudi-Impersonation: 1 to use it, the admin tab keeps acting as the staff member. Every audit row written during it carries the developer as actor and the staff member as impersonator. Refused on a staff account and on oneself.

Parameters

Name	In	Type	Required	Description
`accountId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	ImpersonationStarted	Where to open the console. Headers: `Set-Cookie` (`filudi_impersonation`).
403	none	Not staff, a staff account, or your own account.
404	Error	Unknown resource.

GET `/v1/admin/invitations`

GET /v1/admin/invitations

curl 'https://api.filudi.com/v1/admin/invitations' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/invitations', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/invitations',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Staff only. Invitations, newest first

Parameters

Name	In	Type	Required	Description
`status`	query	one of `"pending"`, `"accepted"`, `"revoked"`, `"expired"`	no	default `"pending"`

Responses

Status	Body	Description
200	Invitation[]	Invitations.
403	Error	Not allowed for this role or site.

POST `/v1/admin/invitations`

POST /v1/admin/invitations

curl -X POST 'https://api.filudi.com/v1/admin/invitations' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "email": "you@example.com",
  "staff": false,
  "canCreateGames": false,
  "canCreatePortals": false,
  "grants": [
    {
      "game": "00000000-0000-0000-0000-000000000000",
      "site": "00000000-0000-0000-0000-000000000000",
      "role": "owner"
    }
  ]
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/invitations', {
  method: 'POST',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    email: 'you@example.com',
    staff: false,
    canCreateGames: false,
    canCreatePortals: false,
    grants: [{
      game: '00000000-0000-0000-0000-000000000000',
      site: '00000000-0000-0000-0000-000000000000',
      role: 'owner',
    }],
  }),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/invitations',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'email': 'you@example.com',
        'staff': False,
        'canCreateGames': False,
        'canCreatePortals': False,
        'grants': [{
            'game': '00000000-0000-0000-0000-000000000000',
            'site': '00000000-0000-0000-0000-000000000000',
            'role': 'owner',
        }],
    },
)
response.raise_for_status()
data = response.json()

Staff only. Invite an email address

The notify service sends the link, valid 7 days. A pending invitation for the same email is revoked first. An open invitation request for the email moves to invited.

Request body

application/json, required. The body is a InvitationInput.

Property	Type	Required	Description
`email`	string (email)	yes	at most 254 characters
`staff`	boolean	no	default `false`
`canCreateGames`	boolean	no	default `false`
`canCreatePortals`	boolean	no	default `false`
`grants`	object[]	no	Memberships created on accept. Each item names exactly one of `game` and `site`.; at most 50 items
`grants[].game`	string (uuid)	no
`grants[].site`	string (uuid)	no
`grants[].role`	MembershipRole	yes	A member has every right of the owner except membership changes

Responses

Status	Body	Description
201	Invitation	Invitation.
400	Error	Validation failed.
403	Error	Not allowed for this role or site.
409	none	An account with that email exists.

DELETE `/v1/admin/invitations/{invitationId}`

DELETE /v1/admin/invitations/{invitationId}

curl -X DELETE 'https://api.filudi.com/v1/admin/invitations/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/invitations/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  credentials: 'include',
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.delete(
    'https://api.filudi.com/v1/admin/invitations/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
# No body: the status says it all.

Staff only. Revoke an invitation; its link stops working

Parameters

Name	In	Type	Required	Description
`invitationId`	path	string (uuid)	yes

Responses

Status	Body	Description
204	none	Revoked.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.
409	none	Already accepted.

POST `/v1/admin/invitations/{invitationId}/resend`

POST /v1/admin/invitations/{invitationId}/resend

curl -X POST 'https://api.filudi.com/v1/admin/invitations/00000000-0000-0000-0000-000000000000/resend' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/invitations/00000000-0000-0000-0000-000000000000/resend', {
  method: 'POST',
  credentials: 'include',
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/invitations/00000000-0000-0000-0000-000000000000/resend',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
# No body: the status says it all.

Staff only. Send the invitation email again with a fresh 7-day token

Parameters

Name	In	Type	Required	Description
`invitationId`	path	string (uuid)	yes

Responses

Status	Body	Description
202	none	Sent.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.
409	none	Accepted or revoked.

GET `/v1/admin/invitation-requests`

GET /v1/admin/invitation-requests

curl 'https://api.filudi.com/v1/admin/invitation-requests' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/invitation-requests', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/invitation-requests',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Staff only. Requests from the form on developers.filudi.com, newest first

Parameters

Name	In	Type	Required	Description
`status`	query	one of `"new"`, `"invited"`, `"dismissed"`	no	Default `new`
`cursor`	query	string	no	Opaque; the `nextCursor` of the previous page, with the same filters and sort; at most 200 characters
`limit`	query	integer	no	1 to 500; default `100`

Responses

Status	Body	Description
200	InvitationRequestPage	Requests.
403	Error	Not allowed for this role or site.

PATCH `/v1/admin/invitation-requests/{requestId}`

PATCH /v1/admin/invitation-requests/{requestId}

curl -X PATCH 'https://api.filudi.com/v1/admin/invitation-requests/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "status": "dismissed"
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/invitation-requests/00000000-0000-0000-0000-000000000000', {
  method: 'PATCH',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    status: 'dismissed',
  }),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.patch(
    'https://api.filudi.com/v1/admin/invitation-requests/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'status': 'dismissed',
    },
)
response.raise_for_status()
data = response.json()

Staff only. Dismiss a request

The invited status is set by the API when an invitation is created for the email.

Parameters

Name	In	Type	Required	Description
`requestId`	path	string (uuid)	yes

Request body

application/json, required.

Property	Type	Required	Description
`status`	one of `"dismissed"`	yes

Responses

Status	Body	Description
200	InvitationRequest	Request.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

GET `/v1/admin/approvals`

GET /v1/admin/approvals

curl 'https://api.filudi.com/v1/admin/approvals' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/approvals', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/approvals',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Staff only. Everything that waits for approval, oldest first

Responses

Status	Body	Description
200	Approvals	Pending games, sites, domains and versions.
403	Error	Not allowed for this role or site.

GET `/v1/admin/sites`

GET /v1/admin/sites

curl 'https://api.filudi.com/v1/admin/sites' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/sites',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Sites the account can see; an account with no site membership gets an empty list

Responses

Status	Body	Description
200	Site[]	Sites.

POST `/v1/admin/sites`

POST /v1/admin/sites

curl -X POST 'https://api.filudi.com/v1/admin/sites' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "slug": "gloop",
  "name": "string",
  "domains": [
    "string"
  ],
  "pendingDomains": [
    "string"
  ],
  "firstParty": true,
  "locales": [
    "string"
  ],
  "accountsAllowed": true,
  "personalizedAdsAllowed": true,
  "ageBand": "all",
  "cdnPullZoneId": "string",
  "navCategories": [
    "string"
  ],
  "otherSites": [
    {
      "name": "string",
      "url": "https://example.com/",
      "description": "string"
    }
  ],
  "causalitDomain": "string",
  "causalitReadKey": "string",
  "causalitWriteKey": "string"
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites', {
  method: 'POST',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    slug: 'gloop',
    name: 'string',
    domains: ['string'],
    pendingDomains: ['string'],
    firstParty: true,
    locales: ['string'],
    accountsAllowed: true,
    personalizedAdsAllowed: true,
    ageBand: 'all',
    cdnPullZoneId: 'string',
    navCategories: ['string'],
    otherSites: [{
      name: 'string',
      url: 'https://example.com/',
      description: 'string',
    }],
    causalitDomain: 'string',
    causalitReadKey: 'string',
    causalitWriteKey: 'string',
  }),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/sites',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'slug': 'gloop',
        'name': 'string',
        'domains': ['string'],
        'pendingDomains': ['string'],
        'firstParty': True,
        'locales': ['string'],
        'accountsAllowed': True,
        'personalizedAdsAllowed': True,
        'ageBand': 'all',
        'cdnPullZoneId': 'string',
        'navCategories': ['string'],
        'otherSites': [{
            'name': 'string',
            'url': 'https://example.com/',
            'description': 'string',
        }],
        'causalitDomain': 'string',
        'causalitReadKey': 'string',
        'causalitWriteKey': 'string',
    },
)
response.raise_for_status()
data = response.json()

Create a site

Staff, or an account with canCreatePortals; anyone else gets 403. A staff creation is approved at once. A developer’s site is created with approvedAt null and the creator as owner; staff approves it from the Approvals screen. A developer writes pendingDomains, never domains. One account holds at most 3 pending sites (409). A reserved slug answers 400: admin, api, play, developers, filudi, www, static. This route and PATCH answer 400 with issue code game_host when a domain is on or under the play domain, the PLAY_URL host or the preview host (ADR 0013).

Request body

application/json, required.

Property	Type	Required	Description
`slug`	string	yes	pattern `^[a-z][a-z0-9-]{1,39}$`
`name`	string	yes	1 to 80 characters
`domains`	string[]	no	Lowercase hostnames, the first is canonical. Staff only.; at least 1 item
`pendingDomains`	string[]	no	Lowercase hostnames the owner proposes; each works once staff approves it. Replaces the whole list.; at most 10 items
`firstParty`	boolean	no	Staff only
`locales`	string[]	yes	Lowercase BCP 47, unique, the first is the default; at least 1 item
`accountsAllowed`	boolean	no
`personalizedAdsAllowed`	boolean	no
`ageBand`	AgeBand	no
`cdnPullZoneId`	string or null	no	pattern `^[0-9]{1,12}$`
`navCategories`	string[]	no	Slugs of existing categories of the site, unique, in menu order; at most 12 items
`otherSites`	OtherSite[]	no	at most 10 items
`causalitDomain`	string or null	no	pattern `^[a-z0-9]([a-z0-9-][a-z0-9])?(\.[a-z0-9]([a-z0-9-][a-z0-9])?)+$`
`causalitReadKey`	string or null	no	8 to 200 characters; write only
`causalitWriteKey`	string or null	no	8 to 200 characters; write only

Responses

Status	Body	Description
201	Site	Created.
400	Error	Validation failed.
403	Error	Not allowed for this role or site.
409	none	Slug taken, or the account already holds 3 pending sites.

GET `/v1/admin/sites/{siteId}`

GET /v1/admin/sites/{siteId}

curl 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

One site

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	Site	Site.

PATCH `/v1/admin/sites/{siteId}`

PATCH /v1/admin/sites/{siteId}

curl -X PATCH 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "slug": "gloop",
  "name": "string",
  "domains": [
    "string"
  ],
  "pendingDomains": [
    "string"
  ],
  "firstParty": true,
  "locales": [
    "string"
  ],
  "accountsAllowed": true,
  "personalizedAdsAllowed": true,
  "ageBand": "all",
  "cdnPullZoneId": "string",
  "navCategories": [
    "string"
  ],
  "otherSites": [
    {
      "name": "string",
      "url": "https://example.com/",
      "description": "string"
    }
  ],
  "causalitDomain": "string",
  "causalitReadKey": "string",
  "causalitWriteKey": "string"
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000', {
  method: 'PATCH',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    slug: 'gloop',
    name: 'string',
    domains: ['string'],
    pendingDomains: ['string'],
    firstParty: true,
    locales: ['string'],
    accountsAllowed: true,
    personalizedAdsAllowed: true,
    ageBand: 'all',
    cdnPullZoneId: 'string',
    navCategories: ['string'],
    otherSites: [{
      name: 'string',
      url: 'https://example.com/',
      description: 'string',
    }],
    causalitDomain: 'string',
    causalitReadKey: 'string',
    causalitWriteKey: 'string',
  }),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.patch(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'slug': 'gloop',
        'name': 'string',
        'domains': ['string'],
        'pendingDomains': ['string'],
        'firstParty': True,
        'locales': ['string'],
        'accountsAllowed': True,
        'personalizedAdsAllowed': True,
        'ageBand': 'all',
        'cdnPullZoneId': 'string',
        'navCategories': ['string'],
        'otherSites': [{
            'name': 'string',
            'url': 'https://example.com/',
            'description': 'string',
        }],
        'causalitDomain': 'string',
        'causalitReadKey': 'string',
        'causalitWriteKey': 'string',
    },
)
response.raise_for_status()
data = response.json()

Update policy, domains, locales, name

Owners and members of the site write pendingDomains; a domain works once staff approves it. domains and firstParty are for staff (ADR 0015).

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes

Request body

application/json, required. The body is a SiteInput. On PATCH the slug may be repeated unchanged; the API refuses a different slug. slug, domains, firstParty and cdnPullZoneId are for staff only; owners and members write pendingDomains and the CausalIT fields (ADR 0015). A key field set to null clears the stored key; absent leaves it.

Property	Type	Required	Description
`slug`	string	no	pattern `^[a-z][a-z0-9-]{1,39}$`
`name`	string	no	1 to 80 characters
`domains`	string[]	no	Lowercase hostnames, the first is canonical. Staff only.; at least 1 item
`pendingDomains`	string[]	no	Lowercase hostnames the owner proposes; each works once staff approves it. Replaces the whole list.; at most 10 items
`firstParty`	boolean	no	Staff only
`locales`	string[]	no	Lowercase BCP 47, unique, the first is the default; at least 1 item
`accountsAllowed`	boolean	no
`personalizedAdsAllowed`	boolean	no
`ageBand`	AgeBand	no
`cdnPullZoneId`	string or null	no	pattern `^[0-9]{1,12}$`
`navCategories`	string[]	no	Slugs of existing categories of the site, unique, in menu order; at most 12 items
`otherSites`	OtherSite[]	no	at most 10 items
`causalitDomain`	string or null	no	pattern `^[a-z0-9]([a-z0-9-][a-z0-9])?(\.[a-z0-9]([a-z0-9-][a-z0-9])?)+$`
`causalitReadKey`	string or null	no	8 to 200 characters; write only
`causalitWriteKey`	string or null	no	8 to 200 characters; write only

Responses

Status	Body	Description
200	Site	Updated.
400	Error	Validation failed.
403	Error	Not allowed for this role or site.

POST `/v1/admin/sites/{siteId}/approve`

POST /v1/admin/sites/{siteId}/approve

curl -X POST 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/approve' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/approve', {
  method: 'POST',
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/approve',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
data = response.json()

Staff only. Approve a pending site

Sets approvedAt. Its approved domains become allowed origins within 60 s; the owners get an email.

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	Site	Site.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.
409	none	Already approved.

POST `/v1/admin/sites/{siteId}/reject`

POST /v1/admin/sites/{siteId}/reject

curl -X POST 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/reject' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "reason": "string"
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/reject', {
  method: 'POST',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    reason: 'string',
  }),
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/reject',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'reason': 'string',
    },
)
response.raise_for_status()
# No body: the status says it all.

Staff only. Send the owners a reason; the site stays pending

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes

Request body

application/json, required. The body is a RejectInput.

Property	Type	Required	Description
`reason`	string	yes	Sent to the owners by email; 1 to 1000 characters

Responses

Status	Body	Description
204	none	Reason sent.
400	Error	Validation failed.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.
409	none	The site is approved.

POST `/v1/admin/sites/{siteId}/domains/approve`

POST /v1/admin/sites/{siteId}/domains/approve

curl -X POST 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/domains/approve' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "domains": [
    "string"
  ]
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/domains/approve', {
  method: 'POST',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    domains: ['string'],
  }),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/domains/approve',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'domains': ['string'],
    },
)
response.raise_for_status()
data = response.json()

Staff only. Move proposed domains into the site’s domains

Each listed domain must be in pendingDomains, else 400. The game_host rule of site creation applies.

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes

Request body

application/json, required.

Property	Type	Required	Description
`domains`	string[]	yes	at least 1 item

Responses

Status	Body	Description
200	Site	Site.
400	Error	Validation failed.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

POST `/v1/admin/sites/{siteId}/domains/reject`

POST /v1/admin/sites/{siteId}/domains/reject

curl -X POST 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/domains/reject' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "domains": [
    "string"
  ],
  "reason": "string"
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/domains/reject', {
  method: 'POST',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    domains: ['string'],
    reason: 'string',
  }),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/domains/reject',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'domains': ['string'],
        'reason': 'string',
    },
)
response.raise_for_status()
data = response.json()

Staff only. Remove proposed domains and send the owners the reason

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes

Request body

application/json, required.

Property	Type	Required	Description
`domains`	string[]	yes	at least 1 item
`reason`	string	yes	1 to 1000 characters

Responses

Status	Body	Description
200	Site	Site.
400	Error	Validation failed.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

GET `/v1/admin/sites/{siteId}/members`

GET /v1/admin/sites/{siteId}/members

curl 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/members' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/members', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/members',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Members of a site

Owner of the site or staff. Invited emails without an account yet are listed with invited true.

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	Member[]	Members.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

POST `/v1/admin/sites/{siteId}/members`

POST /v1/admin/sites/{siteId}/members

curl -X POST 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/members' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "email": "you@example.com",
  "role": "owner"
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/members', {
  method: 'POST',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    email: 'you@example.com',
    role: 'owner',
  }),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/members',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'email': 'you@example.com',
        'role': 'owner',
    },
)
response.raise_for_status()
data = response.json()

Add a member by email

Owner of the site or staff. An existing account gets the membership at once. An unknown email gets an invitation that carries it; the membership exists once the invitation is accepted.

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes

Request body

application/json, required. The body is a MemberInput.

Property	Type	Required	Description
`email`	string (email)	yes	at most 254 characters
`role`	MembershipRole	yes	A member has every right of the owner except membership changes

Responses

Status	Body	Description
201	Member	Member.
400	Error	Validation failed.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.
409	none	Already a member.

DELETE `/v1/admin/sites/{siteId}/members/{accountId}`

DELETE /v1/admin/sites/{siteId}/members/{accountId}

curl -X DELETE 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  credentials: 'include',
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.delete(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
# No body: the status says it all.

Remove a member

Owner of the site or staff. The last owner cannot be removed.

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes
`accountId`	path	string (uuid)	yes

Responses

Status	Body	Description
204	none	Removed.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.
409	none	`conflict`: “A site keeps at least one owner.”.

DELETE `/v1/admin/sites/{siteId}/members/invitations/{invitationId}`

DELETE /v1/admin/sites/{siteId}/members/invitations/{invitationId}

curl -X DELETE 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/members/invitations/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/members/invitations/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  credentials: 'include',
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.delete(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/members/invitations/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
# No body: the status says it all.

Withdraw an invitation

Owner of the site or staff. Removes this site from the invitation’s grants; an invitation left with no grant is revoked.

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes
`invitationId`	path	string (uuid)	yes

Responses

Status	Body	Description
204	none	Withdrawn.
403	Error	Not allowed for this role or site.
404	none	No pending invitation to this site has this id.

GET `/v1/admin/sites/{siteId}/keys`

GET /v1/admin/sites/{siteId}/keys

curl 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/keys' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/keys', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/keys',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Server keys of a site, revoked ones included

Owner or member of the site, or staff. Approved sites only (409). The key itself is never returned again.

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	SiteKey[]	Keys.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.
409	none	The site is not approved.

POST `/v1/admin/sites/{siteId}/keys`

POST /v1/admin/sites/{siteId}/keys

curl -X POST 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/keys' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "name": "string",
  "scopes": [
    "catalog"
  ]
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/keys', {
  method: 'POST',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    name: 'string',
    scopes: ['catalog'],
  }),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/keys',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'name': 'string',
        'scopes': ['catalog'],
    },
)
response.raise_for_status()
data = response.json()

Create a server key; the answer shows it once

Owner or member of the site, or staff. Approved sites only. 20 keys per site at most, revoked ones included.

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes

Request body

application/json, required. The body is a SiteKeyInput.

Property	Type	Required	Description
`name`	string	yes	1 to 60 characters
`scopes`	SiteKeyScope[]	yes	at least 1 item; unique items

Responses

Status	Body	Description
201	SiteKeyCreated	The key, shown once.
400	Error	Validation failed.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.
409	none	The site is not approved, or already has 20 keys.

DELETE `/v1/admin/sites/{siteId}/keys/{keyId}`

DELETE /v1/admin/sites/{siteId}/keys/{keyId}

curl -X DELETE 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/keys/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/keys/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  credentials: 'include',
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.delete(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/keys/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
# No body: the status says it all.

Revoke a server key

The row stays with revokedAt; /v1/server/* answers 403 to the key from now on.

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes
`keyId`	path	string (uuid)	yes

Responses

Status	Body	Description
204	none	Revoked, or already revoked.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

GET `/v1/admin/sites/{siteId}/categories`

GET /v1/admin/sites/{siteId}/categories

curl 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/categories' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/categories', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/categories',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Categories of a site, in site order, with the number of games in each

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	Category[]	Categories.

POST `/v1/admin/sites/{siteId}/categories`

POST /v1/admin/sites/{siteId}/categories

curl -X POST 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/categories' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "slug": "gloop",
  "icon": "puzzle",
  "texts": {
    "en": {
      "title": "string",
      "navTitle": "string",
      "description": "string"
    }
  }
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/categories', {
  method: 'POST',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    slug: 'gloop',
    icon: 'puzzle',
    texts: {
      en: {
        title: 'string',
        navTitle: 'string',
        description: 'string',
      },
    },
  }),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/categories',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'slug': 'gloop',
        'icon': 'puzzle',
        'texts': {
            'en': {
                'title': 'string',
                'navTitle': 'string',
                'description': 'string',
            },
        },
    },
)
response.raise_for_status()
data = response.json()

Add a category at the end of the site order

The default locale needs a title. A category slug never changes once created (ADR 0008). Slugs the fronts use as routes are refused: categories, game, games, search, account, privacy, terms, cookies, stats, cmp, api, assets, and every locale of the site.

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes

Request body

application/json, required.

Property	Type	Required	Description
`slug`	string	yes	On create only; ignored on PATCH; pattern `^[a-z][a-z0-9-]{0,39}$`
`icon`	CategoryIcon or null	no
`texts`	object	yes	Keyed by locale; the site’s default locale needs a title
`texts.*.title`	string	no	at most 120 characters
`texts.*.navTitle`	string	no	at most 24 characters
`texts.*.description`	string	no	at most 1000 characters

Responses

Status	Body	Description
201	Category	Created.
400	Error	Validation failed.
403	Error	Not allowed for this role or site.
409	none	Slug taken on this site.

PUT `/v1/admin/sites/{siteId}/categories/order`

PUT /v1/admin/sites/{siteId}/categories/order

curl -X PUT 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/categories/order' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "slugs": [
    "string"
  ]
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/categories/order', {
  method: 'PUT',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    slugs: ['string'],
  }),
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.put(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/categories/order',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'slugs': ['string'],
    },
)
response.raise_for_status()
# No body: the status says it all.

Reorder the categories

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes

Request body

application/json, required.

Property	Type	Required	Description
`slugs`	string[]	yes	Every category of the site exactly once

Responses

Status	Body	Description
204	none	Reordered.
400	Error	Validation failed.
403	Error	Not allowed for this role or site.

GET `/v1/admin/sites/{siteId}/categories/{slug}`

GET /v1/admin/sites/{siteId}/categories/{slug}

curl 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/categories/gloop' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/categories/gloop', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/categories/gloop',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

One category

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes
`slug`	path	string	yes	pattern `^[a-z][a-z0-9-]{0,39}$`

Responses

Status	Body	Description
200	Category	Category.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

PATCH `/v1/admin/sites/{siteId}/categories/{slug}`

PATCH /v1/admin/sites/{siteId}/categories/{slug}

curl -X PATCH 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/categories/gloop' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "slug": "gloop",
  "icon": "puzzle",
  "texts": {
    "en": {
      "title": "string",
      "navTitle": "string",
      "description": "string"
    }
  }
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/categories/gloop', {
  method: 'PATCH',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    slug: 'gloop',
    icon: 'puzzle',
    texts: {
      en: {
        title: 'string',
        navTitle: 'string',
        description: 'string',
      },
    },
  }),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.patch(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/categories/gloop',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'slug': 'gloop',
        'icon': 'puzzle',
        'texts': {
            'en': {
                'title': 'string',
                'navTitle': 'string',
                'description': 'string',
            },
        },
    },
)
response.raise_for_status()
data = response.json()

Update texts and icon

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes
`slug`	path	string	yes	pattern `^[a-z][a-z0-9-]{0,39}$`

Request body

application/json, required. The body is a CategoryInput.

Property	Type	Required	Description
`slug`	string	no	On create only; ignored on PATCH; pattern `^[a-z][a-z0-9-]{0,39}$`
`icon`	CategoryIcon or null	no
`texts`	object	no	Keyed by locale; the site’s default locale needs a title
`texts.*.title`	string	no	at most 120 characters
`texts.*.navTitle`	string	no	at most 24 characters
`texts.*.description`	string	no	at most 1000 characters

Responses

Status	Body	Description
200	Category	Updated.
400	Error	Validation failed.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

DELETE `/v1/admin/sites/{siteId}/categories/{slug}`

DELETE /v1/admin/sites/{siteId}/categories/{slug}

curl -X DELETE 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/categories/gloop' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/categories/gloop', {
  method: 'DELETE',
  credentials: 'include',
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.delete(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/categories/gloop',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
# No body: the status says it all.

Remove the category from the site, from its games and from the top menu

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes
`slug`	path	string	yes	pattern `^[a-z][a-z0-9-]{0,39}$`

Responses

Status	Body	Description
204	none	Removed.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

GET `/v1/admin/sites/{siteId}/tags`

GET /v1/admin/sites/{siteId}/tags

curl 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/tags' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/tags', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/tags',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Tags of a site, in site order, with the number of games carrying each

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	Tag[]	Tags.

POST `/v1/admin/sites/{siteId}/tags`

POST /v1/admin/sites/{siteId}/tags

curl -X POST 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/tags' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "slug": "gloop",
  "texts": {
    "en": {
      "title": "string"
    }
  }
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/tags', {
  method: 'POST',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    slug: 'gloop',
    texts: {
      en: {
        title: 'string',
      },
    },
  }),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/tags',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'slug': 'gloop',
        'texts': {
            'en': {
                'title': 'string',
            },
        },
    },
)
response.raise_for_status()
data = response.json()

Add a tag at the end of the site order

The default locale needs a title. A tag slug never changes once created (ADR 0008).

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes

Request body

application/json, required.

Property	Type	Required	Description
`slug`	string	yes	On create only; ignored on PATCH; pattern `^[a-z][a-z0-9-]{0,39}$`
`texts`	object	yes	Keyed by locale; the site’s default locale needs a title
`texts.*.title`	string	no	at most 60 characters

Responses

Status	Body	Description
201	Tag	Created.
400	Error	Validation failed.
403	Error	Not allowed for this role or site.
409	none	Slug taken on this site.

PUT `/v1/admin/sites/{siteId}/tags/order`

PUT /v1/admin/sites/{siteId}/tags/order

curl -X PUT 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/tags/order' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "slugs": [
    "string"
  ]
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/tags/order', {
  method: 'PUT',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    slugs: ['string'],
  }),
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.put(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/tags/order',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'slugs': ['string'],
    },
)
response.raise_for_status()
# No body: the status says it all.

Reorder the tags

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes

Request body

application/json, required.

Property	Type	Required	Description
`slugs`	string[]	yes	Every tag of the site exactly once

Responses

Status	Body	Description
204	none	Reordered.
400	Error	Validation failed.
403	Error	Not allowed for this role or site.

GET `/v1/admin/sites/{siteId}/tags/{slug}`

GET /v1/admin/sites/{siteId}/tags/{slug}

curl 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/tags/gloop' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/tags/gloop', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/tags/gloop',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

One tag

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes
`slug`	path	string	yes	pattern `^[a-z][a-z0-9-]{0,39}$`

Responses

Status	Body	Description
200	Tag	Tag.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

PATCH `/v1/admin/sites/{siteId}/tags/{slug}`

PATCH /v1/admin/sites/{siteId}/tags/{slug}

curl -X PATCH 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/tags/gloop' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "slug": "gloop",
  "texts": {
    "en": {
      "title": "string"
    }
  }
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/tags/gloop', {
  method: 'PATCH',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    slug: 'gloop',
    texts: {
      en: {
        title: 'string',
      },
    },
  }),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.patch(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/tags/gloop',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'slug': 'gloop',
        'texts': {
            'en': {
                'title': 'string',
            },
        },
    },
)
response.raise_for_status()
data = response.json()

Update the titles

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes
`slug`	path	string	yes	pattern `^[a-z][a-z0-9-]{0,39}$`

Request body

application/json, required. The body is a TagInput.

Property	Type	Required	Description
`slug`	string	no	On create only; ignored on PATCH; pattern `^[a-z][a-z0-9-]{0,39}$`
`texts`	object	no	Keyed by locale; the site’s default locale needs a title
`texts.*.title`	string	no	at most 60 characters

Responses

Status	Body	Description
200	Tag	Updated.
400	Error	Validation failed.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

DELETE `/v1/admin/sites/{siteId}/tags/{slug}`

DELETE /v1/admin/sites/{siteId}/tags/{slug}

curl -X DELETE 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/tags/gloop' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/tags/gloop', {
  method: 'DELETE',
  credentials: 'include',
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.delete(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/tags/gloop',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
# No body: the status says it all.

Remove the tag from the site and from its games

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes
`slug`	path	string	yes	pattern `^[a-z][a-z0-9-]{0,39}$`

Responses

Status	Body	Description
204	none	Removed.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

GET `/v1/admin/sites/{siteId}/catalog`

GET /v1/admin/sites/{siteId}/catalog

curl 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/catalog' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/catalog', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/catalog',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Site catalog entries with every locale

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	SiteGame[]	Entries in order.

PUT `/v1/admin/sites/{siteId}/catalog/order`

PUT /v1/admin/sites/{siteId}/catalog/order

curl -X PUT 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/catalog/order' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "gameIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/catalog/order', {
  method: 'PUT',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    gameIds: ['00000000-0000-0000-0000-000000000000'],
  }),
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.put(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/catalog/order',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'gameIds': ['00000000-0000-0000-0000-000000000000'],
    },
)
response.raise_for_status()
# No body: the status says it all.

Reorder the catalog

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes

Request body

application/json, required.

Property	Type	Required	Description
`gameIds`	array of string (uuid)	yes

Responses

Status	Body	Description
204	none	Reordered.
400	Error	Validation failed.
403	Error	Not allowed for this role or site.

PUT `/v1/admin/sites/{siteId}/catalog/{gameId}`

PUT /v1/admin/sites/{siteId}/catalog/{gameId}

curl -X PUT 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/catalog/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "featured": true,
  "visible": true,
  "categories": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "texts": {
    "en": {
      "title": "string",
      "tagline": "string",
      "description": "string",
      "howToPlay": [
        "string"
      ],
      "controls": [
        {
          "keys": [
            "string"
          ],
          "does": "string"
        }
      ],
      "seoTitle": "string",
      "seoDescription": "string"
    }
  }
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/catalog/00000000-0000-0000-0000-000000000000', {
  method: 'PUT',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    featured: true,
    visible: true,
    categories: ['string'],
    tags: ['string'],
    texts: {
      en: {
        title: 'string',
        tagline: 'string',
        description: 'string',
        howToPlay: ['string'],
        controls: [{
          keys: ['string'],
          does: 'string',
        }],
        seoTitle: 'string',
        seoDescription: 'string',
      },
    },
  }),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.put(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/catalog/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'featured': True,
        'visible': True,
        'categories': ['string'],
        'tags': ['string'],
        'texts': {
            'en': {
                'title': 'string',
                'tagline': 'string',
                'description': 'string',
                'howToPlay': ['string'],
                'controls': [{
                    'keys': ['string'],
                    'does': 'string',
                }],
                'seoTitle': 'string',
                'seoDescription': 'string',
            },
        },
    },
)
response.raise_for_status()
data = response.json()

Add or update a game in the site catalog

Adding a game the site may not list answers 403 with the reason in message: the game is pending, it has no live version, or it is first_party and the site is not first-party (ADR 0015). A pending site of the game’s own developer may list the developer’s pending games.

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes
`gameId`	path	string (uuid)	yes

Request body

application/json, required. The body is a SiteGameInput.

Property	Type	Required
`featured`	boolean	no
`visible`	boolean	no
`categories`	string[]	no
`tags`	string[]	no
`texts`	object	no
`texts.*`	GameTexts	no

Responses

Status	Body	Description
200	SiteGame	Entry.
403	Error	The site may not list this game; `message` says why.
404	Error	Unknown resource.

DELETE `/v1/admin/sites/{siteId}/catalog/{gameId}`

DELETE /v1/admin/sites/{siteId}/catalog/{gameId}

curl -X DELETE 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/catalog/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/catalog/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  credentials: 'include',
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.delete(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/catalog/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
# No body: the status says it all.

Remove a game from the site catalog

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes
`gameId`	path	string (uuid)	yes

Responses

Status	Body	Description
204	none	Removed.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

POST `/v1/admin/sites/{siteId}/publish`

POST /v1/admin/sites/{siteId}/publish

curl -X POST 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/publish' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/publish', {
  method: 'POST',
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/publish',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
data = response.json()

Make the catalog changes visible on the site front

Drops the API’s cached catalog of the site, then purges the site’s CDN pull zone (ADR 0010) when the site has cdnPullZoneId and the API has BUNNY_API_KEY. Without one of them nothing is purged and the answer says why: the front picks the change up on its own within its revalidation delay. Writes an audit row site.publish.

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	PublishResult	What was purged.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.
503	Error	The CDN did not accept the purge; retry in a minute.

GET `/v1/admin/games`

GET /v1/admin/games

curl 'https://api.filudi.com/v1/admin/games' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/games', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/games',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Every game with its versions

Staff and a game’s members get the full game. A site member gets a reader view of the others: the live version only, notes null, createdBy empty, sites limited to its own. An account with no site membership gets only its own games, and 403 on another game’s id.

Parameters

Name	In	Type	Required	Description
`available`	query	string (uuid)	no	A site id. Lists only the games that site may add: approved, with a live version, `any_portal` or the site is first-party. A pending site of the caller also gets the caller’s own pending games.

Responses

Status	Body	Description
200	Game[]	Games.

POST `/v1/admin/games`

POST /v1/admin/games

curl -X POST 'https://api.filudi.com/v1/admin/games' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "slug": "gloop",
  "name": "string",
  "orientation": "portrait",
  "minutes": 1,
  "mobile": true,
  "daily": true,
  "coverColor": "string",
  "distribution": "first_party"
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/games', {
  method: 'POST',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    slug: 'gloop',
    name: 'string',
    orientation: 'portrait',
    minutes: 1,
    mobile: true,
    daily: true,
    coverColor: 'string',
    distribution: 'first_party',
  }),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/games',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'slug': 'gloop',
        'name': 'string',
        'orientation': 'portrait',
        'minutes': 1,
        'mobile': True,
        'daily': True,
        'coverColor': 'string',
        'distribution': 'first_party',
    },
)
response.raise_for_status()
data = response.json()

Create a game

Staff, or an account with canCreateGames; anyone else gets 403. A staff creation is approved at once. A developer’s game is created with approvedAt null and the creator as owner; staff approves it from the Approvals screen. One account holds at most 10 pending games (409). A reserved slug answers 400: admin, api, play, developers, filudi, www, static.

Request body

application/json, required.

Property	Type	Required	Description
`slug`	string	yes	pattern `^[a-z][a-z0-9-]{1,39}$`
`name`	string	yes
`orientation`	one of `"portrait"`, `"landscape"`, `"any"`	no
`minutes`	integer or null	no	1 to 600
`mobile`	boolean	no
`daily`	boolean	no
`coverColor`	string or null	no	pattern `^#[0-9A-Fa-f]{6}$`
`distribution`	Distribution	no	Where a game may be listed (ADR 0015). `first_party`: sites with `firstParty` only. `any_portal`: any approved site.

Responses

Status	Body	Description
201	Game	Created.
400	Error	Validation failed.
403	Error	Not allowed for this role or site.
409	none	Slug taken, or the account already holds 10 pending games.

GET `/v1/admin/games/{gameId}`

GET /v1/admin/games/{gameId}

curl 'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

One game

Members and staff get listedOn, the sites whose catalog carries the game.

Parameters

Name	In	Type	Required	Description
`gameId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	Game	Game.

PATCH `/v1/admin/games/{gameId}`

PATCH /v1/admin/games/{gameId}

curl -X PATCH 'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "slug": "gloop",
  "name": "string",
  "orientation": "portrait",
  "minutes": 1,
  "mobile": true,
  "daily": true,
  "coverColor": "string",
  "distribution": "first_party"
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000', {
  method: 'PATCH',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    slug: 'gloop',
    name: 'string',
    orientation: 'portrait',
    minutes: 1,
    mobile: true,
    daily: true,
    coverColor: 'string',
    distribution: 'first_party',
  }),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.patch(
    'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'slug': 'gloop',
        'name': 'string',
        'orientation': 'portrait',
        'minutes': 1,
        'mobile': True,
        'daily': True,
        'coverColor': 'string',
        'distribution': 'first_party',
    },
)
response.raise_for_status()
data = response.json()

Update a game

Parameters

Name	In	Type	Required	Description
`gameId`	path	string (uuid)	yes

Request body

application/json, required. The body is a GameInput.

Property	Type	Required	Description
`slug`	string	no	pattern `^[a-z][a-z0-9-]{1,39}$`
`name`	string	no
`orientation`	one of `"portrait"`, `"landscape"`, `"any"`	no
`minutes`	integer or null	no	1 to 600
`mobile`	boolean	no
`daily`	boolean	no
`coverColor`	string or null	no	pattern `^#[0-9A-Fa-f]{6}$`
`distribution`	Distribution	no	Where a game may be listed (ADR 0015). `first_party`: sites with `firstParty` only. `any_portal`: any approved site.

Responses

Status	Body	Description
200	Game	Updated.

DELETE `/v1/admin/games/{gameId}`

DELETE /v1/admin/games/{gameId}

curl -X DELETE 'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  credentials: 'include',
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.delete(
    'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
# No body: the status says it all.

Delete a game and everything attached to it (staff only)

Refused while a version of the game is live. Deletes the versions, media, saves, scores, leaderboards, ratings, comments and catalog entries of every site, and sets game to null on its feedback (ADR 0012). Then removes the files under games/<slug>/ from the files service (best effort: a failure is logged, the deletion stands), removes the game’s Redis leaderboard sets and drops the catalog cache of every site that listed it. Events and daily aggregates keep the game’s id. Writes an audit row game.delete.

Parameters

Name	In	Type	Required	Description
`gameId`	path	string (uuid)	yes

Responses

Status	Body	Description
204	none	Deleted.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.
409	Error	`conflict`: “Retire the live version first.”.

POST `/v1/admin/games/{gameId}/approve`

POST /v1/admin/games/{gameId}/approve

curl -X POST 'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/approve' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/approve', {
  method: 'POST',
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/approve',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
data = response.json()

Staff only. Approve a pending game

Sets approvedAt. The game may now have a live version and be listed by approved sites; the owners get an email.

Parameters

Name	In	Type	Required	Description
`gameId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	Game	Game.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.
409	none	Already approved.

POST `/v1/admin/games/{gameId}/reject`

POST /v1/admin/games/{gameId}/reject

curl -X POST 'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/reject' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "reason": "string"
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/reject', {
  method: 'POST',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    reason: 'string',
  }),
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/reject',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'reason': 'string',
    },
)
response.raise_for_status()
# No body: the status says it all.

Staff only. Send the owners a reason; the game stays pending

Parameters

Name	In	Type	Required	Description
`gameId`	path	string (uuid)	yes

Request body

application/json, required. The body is a RejectInput.

Property	Type	Required	Description
`reason`	string	yes	Sent to the owners by email; 1 to 1000 characters

Responses

Status	Body	Description
204	none	Reason sent.
400	Error	Validation failed.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.
409	none	The game is approved.

GET `/v1/admin/games/{gameId}/members`

GET /v1/admin/games/{gameId}/members

curl 'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/members' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/members', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/members',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Members of a game

Owner of the game or staff. Invited emails without an account yet are listed with invited true.

Parameters

Name	In	Type	Required	Description
`gameId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	Member[]	Members.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

POST `/v1/admin/games/{gameId}/members`

POST /v1/admin/games/{gameId}/members

curl -X POST 'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/members' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "email": "you@example.com",
  "role": "owner"
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/members', {
  method: 'POST',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    email: 'you@example.com',
    role: 'owner',
  }),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/members',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'email': 'you@example.com',
        'role': 'owner',
    },
)
response.raise_for_status()
data = response.json()

Add a member by email

Owner of the game or staff. An existing account gets the membership at once. An unknown email gets an invitation that carries it; the membership exists once the invitation is accepted.

Parameters

Name	In	Type	Required	Description
`gameId`	path	string (uuid)	yes

Request body

application/json, required. The body is a MemberInput.

Property	Type	Required	Description
`email`	string (email)	yes	at most 254 characters
`role`	MembershipRole	yes	A member has every right of the owner except membership changes

Responses

Status	Body	Description
201	Member	Member.
400	Error	Validation failed.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.
409	none	Already a member.

DELETE `/v1/admin/games/{gameId}/members/{accountId}`

DELETE /v1/admin/games/{gameId}/members/{accountId}

curl -X DELETE 'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  credentials: 'include',
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.delete(
    'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/members/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
# No body: the status says it all.

Remove a member

Owner of the game or staff. The last owner cannot be removed.

Parameters

Name	In	Type	Required	Description
`gameId`	path	string (uuid)	yes
`accountId`	path	string (uuid)	yes

Responses

Status	Body	Description
204	none	Removed.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.
409	none	`conflict`: “A game keeps at least one owner.”.

DELETE `/v1/admin/games/{gameId}/members/invitations/{invitationId}`

DELETE /v1/admin/games/{gameId}/members/invitations/{invitationId}

curl -X DELETE 'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/members/invitations/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/members/invitations/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  credentials: 'include',
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.delete(
    'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/members/invitations/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
# No body: the status says it all.

Withdraw an invitation

Owner of the game or staff. Removes this game from the invitation’s grants; an invitation left with no grant is revoked.

Parameters

Name	In	Type	Required	Description
`gameId`	path	string (uuid)	yes
`invitationId`	path	string (uuid)	yes

Responses

Status	Body	Description
204	none	Withdrawn.
403	Error	Not allowed for this role or site.
404	none	No pending invitation to this game has this id.

GET `/v1/admin/games/{gameId}/stats`

GET /v1/admin/games/{gameId}/stats

curl 'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/stats?from=2026-10-30&to=2026-10-30' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/stats?from=2026-10-30&to=2026-10-30', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/stats?from=2026-10-30&to=2026-10-30',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

One game’s numbers across every site that lists it, for a range of UTC days

Members of the game and staff. Same range rules as the site overview: from and to included, at most 400 days, previous covers the range of the same length that ends the day before from. Cached in Redis for 60 s per game, range and filter set. Nothing about ads or money (ADR 0015).

Parameters

Name	In	Type	Required	Description
`gameId`	path	string (uuid)	yes
`from`	query	string (date)	yes	First UTC day, included
`to`	query	string (date)	yes	Last UTC day, included
`site`	query	string (uuid)	no	Only the sessions of this site
`host`	query	string	no	Only the sessions of this host
`version`	query	string	no	Only the sessions of this bundle version. `events` and `funnel.loaded` come from `event_daily`, which has no version, so they ignore this filter
`locale`	query	string	no	Only the players of this locale. `events` and `funnel.loaded` come from `event_daily`, which has no locale, so they ignore this filter

Responses

Status	Body	Description
200	ConsoleGameStats	Game stats.
400	none	Range over 400 days, or `to` before `from`.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

POST `/v1/admin/games/{gameId}/versions`

POST /v1/admin/games/{gameId}/versions

curl -X POST 'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/versions' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "version": "string",
  "sizeBytes": 0,
  "notes": "string"
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/versions', {
  method: 'POST',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    version: 'string',
    sizeBytes: 0,
    notes: 'string',
  }),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/versions',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'version': 'string',
        'sizeBytes': 0,
        'notes': 'string',
    },
)
response.raise_for_status()
data = response.json()

Start a version upload

Returns a presigned PUT URL from the files service for a zip. 200 MB max. Answers 409 while a finalize runs or once the version is finalized, and 503 with Retry-After while Redis is down.

Parameters

Name	In	Type	Required	Description
`gameId`	path	string (uuid)	yes

Request body

application/json, required.

Property	Type	Required	Description
`version`	string	yes	pattern `^\d+\.\d+\.\d+([-.][0-9A-Za-z.-]+)?$`
`sizeBytes`	integer	yes	at most 209715200
`notes`	string	no

Responses

Status	Body	Description
201	object	Upload slot.
409	none	Version exists.

Body of 201

Property	Type	Required
`versionId`	string (uuid)	yes
`uploadUrl`	string (uri)	yes
`expiresAt`	string (date-time)	yes

POST `/v1/admin/games/{gameId}/media/{slot}`

POST /v1/admin/games/{gameId}/media/{slot}

curl -X POST 'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/media/image-square' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "contentType": "image/avif",
  "sizeBytes": 1
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/media/image-square', {
  method: 'POST',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    contentType: 'image/avif',
    sizeBytes: 1,
  }),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/media/image-square',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'contentType': 'image/avif',
        'sizeBytes': 1,
    },
)
response.raise_for_status()
data = response.json()

Start a media upload

Returns a presigned PUT URL from the files service. The slot keeps its current file until finalize succeeds.

Parameters

Name	In	Type	Required	Description
`gameId`	path	string (uuid)	yes
`slot`	path	one of `"image-square"`, `"image-landscape"`, `"image-portrait"`, `"video-landscape"`, `"video-portrait"`	yes	ADR 0007 gives the ratio, pixel range, file types and size limit of each slot

Request body

application/json, required.

Property	Type	Required	Description
`contentType`	one of `"image/avif"`, `"image/webp"`, `"image/jpeg"`, `"image/png"`, `"video/mp4"`	yes
`sizeBytes`	integer	yes	Checked against the slot limit; 1 to 15728640

Responses

Status	Body	Description
201	object	Upload slot.
400	none	Type not allowed in this slot, or file over the slot limit.

Body of 201

Property	Type	Required	Description
`uploadUrl`	string (uri)	yes
`expiresAt`	string (date-time)	yes

DELETE `/v1/admin/games/{gameId}/media/{slot}`

DELETE /v1/admin/games/{gameId}/media/{slot}

curl -X DELETE 'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/media/image-square' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/media/image-square', {
  method: 'DELETE',
  credentials: 'include',
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.delete(
    'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/media/image-square',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
# No body: the status says it all.

Empty the slot

The file stays in the files service; built pages may still point to it (ADR 0007).

Parameters

Name	In	Type	Required	Description
`gameId`	path	string (uuid)	yes
`slot`	path	one of `"image-square"`, `"image-landscape"`, `"image-portrait"`, `"video-landscape"`, `"video-portrait"`	yes	ADR 0007 gives the ratio, pixel range, file types and size limit of each slot

Responses

Status	Body	Description
204	none	Emptied, or already empty.

POST `/v1/admin/games/{gameId}/media/{slot}/finalize`

POST /v1/admin/games/{gameId}/media/{slot}/finalize

curl -X POST 'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/media/image-square/finalize' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/media/image-square/finalize', {
  method: 'POST',
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/media/image-square/finalize',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
data = response.json()

Check the uploaded file and put it in the slot

Detects the type from the bytes, checks ratio, pixels, size, and for a video H.264, duration and moov before mdat. The message of a 400 says what to change in the file.

Parameters

Name	In	Type	Required	Description
`gameId`	path	string (uuid)	yes
`slot`	path	one of `"image-square"`, `"image-landscape"`, `"image-portrait"`, `"video-landscape"`, `"video-portrait"`	yes	ADR 0007 gives the ratio, pixel range, file types and size limit of each slot

Responses

Status	Body	Description
200	MediaFile	The slot’s new file.
400	none	No upload, or a file that breaks the slot rules.

POST `/v1/admin/versions/{versionId}/finalize`

POST /v1/admin/versions/{versionId}/finalize

curl -X POST 'https://api.filudi.com/v1/admin/versions/00000000-0000-0000-0000-000000000000/finalize' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/versions/00000000-0000-0000-0000-000000000000/finalize', {
  method: 'POST',
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/versions/00000000-0000-0000-0000-000000000000/finalize',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
data = response.json()

Unpack the uploaded zip into the bundle prefix

Checks the entry file exists, rejects paths with .., counts files and bytes. The version becomes draft.

Parameters

Name	In	Type	Required	Description
`versionId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	GameVersion	Version.
400	none	Zip missing, invalid or without the entry file.
409	none	Another finalize or an activation holds this version.
503	none	Redis is down: the version lock is not available.

POST `/v1/admin/versions/{versionId}/activate`

POST /v1/admin/versions/{versionId}/activate

curl -X POST 'https://api.filudi.com/v1/admin/versions/00000000-0000-0000-0000-000000000000/activate' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/versions/00000000-0000-0000-0000-000000000000/activate', {
  method: 'POST',
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/versions/00000000-0000-0000-0000-000000000000/activate',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
data = response.json()

Make this version live; the previous live one goes back to draft (staff only)

Clears reviewRequestedAt. Answers 409 on a game that is not approved, and while a finalize or another activation holds the version; 503 while Redis is down (ADR 0013).

Parameters

Name	In	Type	Required	Description
`versionId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	GameVersion	Version.
403	Error	Not allowed for this role or site.
409	Error	The game is pending approval, or another operation holds the version.

POST `/v1/admin/versions/{versionId}/retire`

POST /v1/admin/versions/{versionId}/retire

curl -X POST 'https://api.filudi.com/v1/admin/versions/00000000-0000-0000-0000-000000000000/retire' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/versions/00000000-0000-0000-0000-000000000000/retire', {
  method: 'POST',
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/versions/00000000-0000-0000-0000-000000000000/retire',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
data = response.json()

Retire a version; its bundle stops being served (staff only)

Retiring the live version takes the game off play: the catalog answers bundleUrl: null and version: null until another version goes live. A game is deleted only with no live version. Clears reviewRequestedAt.

Parameters

Name	In	Type	Required	Description
`versionId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	GameVersion	Version.

POST `/v1/admin/versions/{versionId}/review`

POST /v1/admin/versions/{versionId}/review

curl -X POST 'https://api.filudi.com/v1/admin/versions/00000000-0000-0000-0000-000000000000/review' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/versions/00000000-0000-0000-0000-000000000000/review', {
  method: 'POST',
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/versions/00000000-0000-0000-0000-000000000000/review',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
data = response.json()

Ask staff to review a draft and make it live

Any member of the game. Sets reviewRequestedAt and emails staff. The version shows in the Approvals screen.

Parameters

Name	In	Type	Required	Description
`versionId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	GameVersion	Version.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.
409	Error	The version is not a draft, or the game is pending approval.

POST `/v1/admin/versions/{versionId}/review/reject`

POST /v1/admin/versions/{versionId}/review/reject

curl -X POST 'https://api.filudi.com/v1/admin/versions/00000000-0000-0000-0000-000000000000/review/reject' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "reason": "string"
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/versions/00000000-0000-0000-0000-000000000000/review/reject', {
  method: 'POST',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    reason: 'string',
  }),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/versions/00000000-0000-0000-0000-000000000000/review/reject',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'reason': 'string',
    },
)
response.raise_for_status()
data = response.json()

Staff only. Decline a review request and send the owners the reason

Clears reviewRequestedAt; the version stays a draft.

Parameters

Name	In	Type	Required	Description
`versionId`	path	string (uuid)	yes

Request body

application/json, required. The body is a RejectInput.

Property	Type	Required	Description
`reason`	string	yes	Sent to the owners by email; 1 to 1000 characters

Responses

Status	Body	Description
200	GameVersion	Version.
400	Error	Validation failed.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.
409	none	No review was requested.

GET `/v1/admin/versions/{versionId}/preview`

GET /v1/admin/versions/{versionId}/preview

curl 'https://api.filudi.com/v1/admin/versions/00000000-0000-0000-0000-000000000000/preview' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/versions/00000000-0000-0000-0000-000000000000/preview', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/versions/00000000-0000-0000-0000-000000000000/preview',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Signed URL to play a draft version for 1 hour

Built on PREVIEW_URL when it is set, else on the API origin, and never on the CDN, so Bunny cannot strip the preview cookie the bundle’s other files need. Open it in a new tab (a preview answers frame-ancestors 'none').

Parameters

Name	In	Type	Required	Description
`versionId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	object	URL.

Body of 200

Property	Type	Required	Description
`url`	string (uri)	yes
`expiresAt`	string (date-time)	yes

GET `/v1/admin/games/{gameId}/leaderboards`

GET /v1/admin/games/{gameId}/leaderboards

curl 'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/leaderboards' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/leaderboards', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/leaderboards',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Boards of a game

Parameters

Name	In	Type	Required	Description
`gameId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	Leaderboard[]	Boards.

PUT `/v1/admin/games/{gameId}/leaderboards`

PUT /v1/admin/games/{gameId}/leaderboards

curl -X PUT 'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/leaderboards' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '[
  {
    "name": "string",
    "sort": "desc",
    "min": 0,
    "max": 0,
    "keep": "best",
    "ratePerMinute": 10
  }
]'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/leaderboards', {
  method: 'PUT',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify([{
    name: 'string',
    sort: 'desc',
    min: 0,
    max: 0,
    keep: 'best',
    ratePerMinute: 10,
  }]),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.put(
    'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/leaderboards',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json=[{
        'name': 'string',
        'sort': 'desc',
        'min': 0,
        'max': 0,
        'keep': 'best',
        'ratePerMinute': 10,
    }],
)
response.raise_for_status()
data = response.json()

Replace the boards of a game

Parameters

Name	In	Type	Required	Description
`gameId`	path	string (uuid)	yes

Request body

application/json, required.

An array of LeaderboardInput.

Responses

Status	Body	Description
200	Leaderboard[]	Boards.

GET `/v1/admin/games/{gameId}/leaderboards/{board}/scores`

GET /v1/admin/games/{gameId}/leaderboards/{board}/scores

curl 'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/leaderboards/height/scores' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/leaderboards/height/scores', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/games/00000000-0000-0000-0000-000000000000/leaderboards/height/scores',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Scores for moderation

Parameters

Name	In	Type	Required	Description
`gameId`	path	string (uuid)	yes
`board`	path	string	yes	pattern `^[a-z][a-z0-9_]{0,31}$`
`period`	query	one of `"day"`, `"week"`, `"all"`	no	default `"all"`
`site`	query	string	no	403 unless the caller is an admin or an editor of that site
`hidden`	query	boolean	no
`limit`	query	integer	no	at most 500; default `100`

Responses

Status	Body	Description
200	ScoreAdmin[]	Scores with player ids.

POST `/v1/admin/scores/{scoreId}`

POST /v1/admin/scores/{scoreId}

curl -X POST 'https://api.filudi.com/v1/admin/scores/string' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/scores/string', {
  method: 'POST',
  credentials: 'include',
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/scores/string',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
# No body: the status says it all.

Unhide a score

Parameters

Name	In	Type	Required	Description
`scoreId`	path	string	yes

Responses

Status	Body	Description
204	none	Visible again.

DELETE `/v1/admin/scores/{scoreId}`

DELETE /v1/admin/scores/{scoreId}

curl -X DELETE 'https://api.filudi.com/v1/admin/scores/string' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "reason": "string"
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/scores/string', {
  method: 'DELETE',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    reason: 'string',
  }),
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.delete(
    'https://api.filudi.com/v1/admin/scores/string',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'reason': 'string',
    },
)
response.raise_for_status()
# No body: the status says it all.

Hide a score

Parameters

Name	In	Type	Required	Description
`scoreId`	path	string	yes

Request body

application/json, optional.

Property	Type	Required	Description
`reason`	string	no	Stored in the audit row; at most 200 characters

Responses

Status	Body	Description
204	none	Hidden and removed from Redis.

GET `/v1/admin/sites/{siteId}/players`

GET /v1/admin/sites/{siteId}/players

curl 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/players' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/players', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/players',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

List the players of a site, with an optional search

Without q, every player that matches the filters. With q, a player id (a UUID), an email (a value with @, matched by its hash) or a nickname substring, case-insensitive. By default the list shows account players only: guests=true adds guests, and merged=true also adds guests already merged into an account. An id or an email ignores guests and merged: the one match shows, whatever it is. lastSeen and created sort newest first, nickname alphabetically; ties break on id. total counts every row that matches the filters, across pages.

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes
`q`	query	string	no	at least 2 characters
`guests`	query	boolean	no	False hides players without an email; default `false`
`merged`	query	boolean	no	False hides guests merged into an account; only matters with `guests=true`; default `false`
`sort`	query	one of `"lastSeen"`, `"created"`, `"nickname"`	no	default `"lastSeen"`
`cursor`	query	string	no	Opaque; the `nextCursor` of the previous page, with the same filters and sort; at most 200 characters
`limit`	query	integer	no	1 to 500; default `100`

Responses

Status	Body	Description
200	PlayerPage	Players, emails masked.
400	none	`q` shorter than 2 characters, or a cursor of another sort.

GET `/v1/admin/players/{playerId}`

GET /v1/admin/players/{playerId}

curl 'https://api.filudi.com/v1/admin/players/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/players/00000000-0000-0000-0000-000000000000', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/players/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Player detail with saves metadata and best scores

Parameters

Name	In	Type	Required	Description
`playerId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	PlayerAdmin	Player.

DELETE `/v1/admin/players/{playerId}`

DELETE /v1/admin/players/{playerId}

curl -X DELETE 'https://api.filudi.com/v1/admin/players/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/players/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  credentials: 'include',
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.delete(
    'https://api.filudi.com/v1/admin/players/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
# No body: the status says it all.

Schedule deletion (GDPR request handled by support)

Parameters

Name	In	Type	Required	Description
`playerId`	path	string (uuid)	yes

Responses

Status	Body	Description
202	none	Scheduled.

GET `/v1/admin/players/{playerId}/export`

GET /v1/admin/players/{playerId}/export

curl 'https://api.filudi.com/v1/admin/players/00000000-0000-0000-0000-000000000000/export' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/players/00000000-0000-0000-0000-000000000000/export', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/players/00000000-0000-0000-0000-000000000000/export',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Export a player’s data

Parameters

Name	In	Type	Required	Description
`playerId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	PlayerExport	JSON file.

GET `/v1/admin/sites/{siteId}/comments`

GET /v1/admin/sites/{siteId}/comments

curl 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/comments' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/comments', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/comments',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Comments of a site for moderation, newest first

Editor of the site or admin. q is a case-insensitive substring of the body or of the author’s current nickname. total counts every row that matches the filters, across pages.

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes
`gameId`	query	string (uuid)	no
`hidden`	query	one of `"all"`, `"visible"`, `"hidden"`	no	default `"all"`
`q`	query	string	no	2 to 100 characters
`cursor`	query	string	no	Opaque; the `nextCursor` of the previous page, with the same filters and sort; at most 200 characters
`limit`	query	integer	no	1 to 500; default `100`

Responses

Status	Body	Description
200	CommentPage	Comments.
403	Error	Not allowed for this role or site.
404	none	Unknown site.

DELETE `/v1/admin/comments/{commentId}`

DELETE /v1/admin/comments/{commentId}

curl -X DELETE 'https://api.filudi.com/v1/admin/comments/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/comments/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  credentials: 'include',
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.delete(
    'https://api.filudi.com/v1/admin/comments/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
# No body: the status says it all.

Delete a comment for good

Editor of the comment’s site or admin. Audit row comment.delete with the body in before.

Parameters

Name	In	Type	Required	Description
`commentId`	path	string (uuid)	yes

Responses

Status	Body	Description
204	none	Deleted.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

POST `/v1/admin/comments/{commentId}/hide`

POST /v1/admin/comments/{commentId}/hide

curl -X POST 'https://api.filudi.com/v1/admin/comments/00000000-0000-0000-0000-000000000000/hide' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/comments/00000000-0000-0000-0000-000000000000/hide', {
  method: 'POST',
  credentials: 'include',
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/comments/00000000-0000-0000-0000-000000000000/hide',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
# No body: the status says it all.

Hide a comment from every player route

Editor of the comment’s site or admin. Sets hiddenBy and hiddenAt. Audit row comment.hide.

Parameters

Name	In	Type	Required	Description
`commentId`	path	string (uuid)	yes

Responses

Status	Body	Description
204	none	Hidden, or already hidden.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

POST `/v1/admin/comments/{commentId}/unhide`

POST /v1/admin/comments/{commentId}/unhide

curl -X POST 'https://api.filudi.com/v1/admin/comments/00000000-0000-0000-0000-000000000000/unhide' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/comments/00000000-0000-0000-0000-000000000000/unhide', {
  method: 'POST',
  credentials: 'include',
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.post(
    'https://api.filudi.com/v1/admin/comments/00000000-0000-0000-0000-000000000000/unhide',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
# No body: the status says it all.

Show a hidden comment again

Editor of the comment’s site or admin. Clears hiddenBy and hiddenAt. Audit row comment.unhide.

Parameters

Name	In	Type	Required	Description
`commentId`	path	string (uuid)	yes

Responses

Status	Body	Description
204	none	Visible, or already visible.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

GET `/v1/admin/sites/{siteId}/ratings`

GET /v1/admin/sites/{siteId}/ratings

curl 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/ratings' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/ratings', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/ratings',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Rating of every rated game of a site

Games with at least one rating, listed in the catalog or not, most ratings first.

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	GameRatingAdmin[]	Ratings.
403	Error	Not allowed for this role or site.
404	none	Unknown site.

GET `/v1/admin/sites/{siteId}/feedback`

GET /v1/admin/sites/{siteId}/feedback

curl 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/feedback' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/feedback', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/feedback',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Feedback of a site, newest first

Editor of the site or admin. q is a case-insensitive substring of the message. total counts every row that matches the filters, across pages.

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes
`status`	query	one of `"new"`, `"seen"`, `"done"`	no
`kind`	query	one of `"bug"`, `"suggestion"`, `"other"`	no
`gameId`	query	string (uuid)	no
`q`	query	string	no	2 to 100 characters
`cursor`	query	string	no	Opaque; the `nextCursor` of the previous page, with the same filters and sort; at most 200 characters
`limit`	query	integer	no	1 to 500; default `100`

Responses

Status	Body	Description
200	FeedbackPage	Feedback.
403	Error	Not allowed for this role or site.
404	none	Unknown site.

GET `/v1/admin/feedback/{feedbackId}`

GET /v1/admin/feedback/{feedbackId}

curl 'https://api.filudi.com/v1/admin/feedback/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/feedback/00000000-0000-0000-0000-000000000000', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/feedback/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

One feedback message

Editor of its site or admin. The reply email is decrypted.

Parameters

Name	In	Type	Required	Description
`feedbackId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	FeedbackAdmin	Feedback.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

PATCH `/v1/admin/feedback/{feedbackId}`

PATCH /v1/admin/feedback/{feedbackId}

curl -X PATCH 'https://api.filudi.com/v1/admin/feedback/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com' \
  -H 'content-type: application/json' \
  -d '{
  "status": "new",
  "note": "string"
}'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/feedback/00000000-0000-0000-0000-000000000000', {
  method: 'PATCH',
  credentials: 'include',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    status: 'new',
    note: 'string',
  }),
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.patch(
    'https://api.filudi.com/v1/admin/feedback/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
    json={
        'status': 'new',
        'note': 'string',
    },
)
response.raise_for_status()
data = response.json()

Change the status or the note

Editor of its site or admin. Audit row feedback.update with the old and new status and note.

Parameters

Name	In	Type	Required	Description
`feedbackId`	path	string (uuid)	yes

Request body

application/json, required. The body is a FeedbackUpdate. At least one field; an empty body is a 400.

Property	Type	Required	Description
`status`	FeedbackStatus	no
`note`	string or null	no	Null clears the note; "" is stored as null; at most 2000 characters

Responses

Status	Body	Description
200	FeedbackAdmin	Updated.
400	Error	Validation failed.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

DELETE `/v1/admin/feedback/{feedbackId}`

DELETE /v1/admin/feedback/{feedbackId}

curl -X DELETE 'https://api.filudi.com/v1/admin/feedback/00000000-0000-0000-0000-000000000000' \
  -b "filudi_console=$FILUDI_SESSION" \
  -H 'origin: https://developers.filudi.com'

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/feedback/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  credentials: 'include',
});
// No body: check response.ok.

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.delete(
    'https://api.filudi.com/v1/admin/feedback/00000000-0000-0000-0000-000000000000',
    cookies={'filudi_console': session},
    headers={'origin': 'https://developers.filudi.com'},
)
response.raise_for_status()
# No body: the status says it all.

Delete a feedback message for good

Editor of its site or admin. Audit row feedback.delete; the row’s email is not copied into it.

Parameters

Name	In	Type	Required	Description
`feedbackId`	path	string (uuid)	yes

Responses

Status	Body	Description
204	none	Deleted.
403	Error	Not allowed for this role or site.
404	Error	Unknown resource.

GET `/v1/admin/sites/{siteId}/events/today`

GET /v1/admin/sites/{siteId}/events/today

curl 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/events/today' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/events/today', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/events/today',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Counts since midnight UTC, live from the events table

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes

Responses

Status	Body	Description
200	object	Counts.

Body of 200

Property	Type	Required	Description
`since`	string (date-time)	no
`rows`	EventCount[]	no

GET `/v1/admin/sites/{siteId}/events/daily`

GET /v1/admin/sites/{siteId}/events/daily

curl 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/events/daily?from=2026-10-30&to=2026-10-30' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/events/daily?from=2026-10-30&to=2026-10-30', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/events/daily?from=2026-10-30&to=2026-10-30',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Daily aggregates

Parameters

Name	In	Type	Required
`siteId`	path	string (uuid)	yes
`from`	query	string (date)	yes
`to`	query	string (date)	yes
`game`	query	string	no

Responses

Status	Body	Description
200	EventDaily[]	Rows.

GET `/v1/admin/sites/{siteId}/stats/overview`

GET /v1/admin/sites/{siteId}/stats/overview

curl 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/stats/overview?from=2026-10-30&to=2026-10-30' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/stats/overview?from=2026-10-30&to=2026-10-30', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/stats/overview?from=2026-10-30&to=2026-10-30',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

The site dashboard numbers for a range of UTC days

Read from Postgres (players, play_sessions, scores, saves, magic_links, event_daily) and cached in Redis for 60 s per site and range. from and to are included; at most 400 days. previous covers the range of the same length that ends the day before from.

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes
`from`	query	string (date)	yes	First UTC day, included
`to`	query	string (date)	yes	Last UTC day, included

Responses

Status	Body	Description
200	StatsOverview	Overview.

GET `/v1/admin/sites/{siteId}/stats/games/{gameId}`

GET /v1/admin/sites/{siteId}/stats/games/{gameId}

curl 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/stats/games/00000000-0000-0000-0000-000000000000?from=2026-10-30&to=2026-10-30' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/stats/games/00000000-0000-0000-0000-000000000000?from=2026-10-30&to=2026-10-30', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/stats/games/00000000-0000-0000-0000-000000000000?from=2026-10-30&to=2026-10-30',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

One game’s numbers on this site for a range of UTC days

Same range rules and cache as the overview. 404 when the game is not in the site catalog.

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes
`gameId`	path	string (uuid)	yes
`from`	query	string (date)	yes	First UTC day, included
`to`	query	string (date)	yes	Last UTC day, included

Responses

Status	Body	Description
200	GameStats	Game stats.

GET `/v1/admin/sites/{siteId}/stats/web`

GET /v1/admin/sites/{siteId}/stats/web

curl 'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/stats/web' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/stats/web', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/sites/00000000-0000-0000-0000-000000000000/stats/web',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Web audience from CausalIT (ADR 0009)

Calls the CausalIT read API with the site’s read key and answers configured: false without one. Cached in Redis for 120 s per site, period and path. path narrows every number to one page path, for the game screens.

Parameters

Name	In	Type	Required	Description
`siteId`	path	string (uuid)	yes
`period`	query	one of `"day"`, `"yesterday"`, `"7d"`, `"14d"`, `"30d"`, `"90d"`, `"6m"`, `"12m"`, `"custom"`	no	default `"7d"`
`from`	query	string (date)	no	With `period=custom`
`to`	query	string (date)	no	With `period=custom`
`path`	query	string	no	A page path such as `/game/gloop/`; at most 200 characters

Responses

Status	Body	Description
200	WebStats	Web stats.
503	none	CausalIT did not answer.

GET `/v1/admin/audit`

GET /v1/admin/audit

curl 'https://api.filudi.com/v1/admin/audit' \
  -b "filudi_console=$FILUDI_SESSION"

// The browser sends the filudi_console cookie and the Origin header itself.
const response = await fetch('https://api.filudi.com/v1/admin/audit', {
  credentials: 'include',
});
const data = await response.json();

import requests

# session: the value of the filudi_console cookie set by POST /v1/console/sign-in
response = requests.get(
    'https://api.filudi.com/v1/admin/audit',
    cookies={'filudi_console': session},
)
response.raise_for_status()
data = response.json()

Audit log

Parameters

Name	In	Type	Required	Description
`site`	query	string	no	Site slug
`actor`	query	string	no
`from`	query	string (date-time)	no
`cursor`	query	string	no
`limit`	query	integer	no	at most 500; default `100`

Responses

Status	Body	Description
200	object	Entries, newest first.

Body of 200

Property	Type	Required	Description
`items`	AuditEntry[]	no
`nextCursor`	string or null	no