Check that a username is free

GET/editor/logins/check/

read Read: looks, changes nothing. Scopes

Whether username can be used as a playlist login, with a sentence to show.

Query parameters

playliststring (uuid)
When renaming a playlist's login: that playlist's id (it may keep its own username).
usernamestringrequired
The username to check.

Response

200 OK

okbooleanrequired
Whether the username can be used.
detailstringrequired
Why, in a sentence to show.

Errors

401 No credential, or one that is wrong, expired or revoked.
403 The account, or the key's or app's scopes, may not do this.
429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means

cURL

curl 'https://panel.example.com/editor/logins/check/?username=alice' \
  -H "Authorization: Bearer $MINIMUS_API_KEY"

Python

import os
import requests

response = requests.get(
    "https://panel.example.com/editor/logins/check/?username=alice",
    headers={"Authorization": f"Bearer {os.environ['MINIMUS_API_KEY']}"},
)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://panel.example.com/editor/logins/check/?username=alice', {
  method: 'GET',
  headers: { Authorization: `Bearer ${process.env.MINIMUS_API_KEY}` },
});
if (!response.ok) throw new Error(`${response.status}`);
console.log(await response.json());

Response 200

{
  "ok": true,
  "detail": "string"
}

Check that a username is free

Query parameters#

Response#

200 OK

Errors#

Query parameters

Response

Errors