Global Ban API

Viewing Version 5

View Alternate Version: 1,2,3,4

Primary Endpoints

NOTE Sudo Endpoints only mimic action, i.e report does not send a report

POST https://api.azrael.gg/v5/bans/report

SUDO https://api.azrael.gg/v5/bans/report/sudo

Report User

Report a user

Paramaters

Headers

AuthorizationstringYour authorization token

Content-TypestringContent-Type (application/json)

Responses

Body

idstringID of the user being reported

reasonstringThe reason for the report

urlstringThe image url for the proof

200 Request was accepted.

{
"status": 200,
"message": "Report submitted"
}

400 Failed validation or was missing paramaters.

{
"status": 400,
"message": "Error details"
}

401 Authorization header was not recieved

{
"status": 401,
"message": "Unauthorized"
}

403 Authorization token is locked, invalid or not valid for this action.

{
"status": 403,
"message": "Forbidden"
}

500 An internal server error occured.

{
"status": 500,
"message": "Internal Server Error"
}

GET https://api.azrael.gg/v5/bans/check/:id

Check Ban

Check if a user is banned (does not includes full ban information)

Paramaters

Path

idstringID of the user to check

Headers

AuthorizationstringYour authorization token

Responses

200 Request was accepted.

{
"status": 200,
"banned": true
}

400 Failed validation or was missing paramaters.

{
"status": 400,
"message": "Error details"
}

401 Authorization header was not recieved

{
"status": 401,
"message": "Unauthorized"
}

403 Authorization token is locked, invalid or not valid for this action.

{
"status": 403,
"message": "Forbidden"
}

500 An internal server error occured.

{
"status": 500,
"message": "Internal Server Error"
}

GET https://api.azrael.gg/v5/bans/get/:id

Get Ban

Check if a user is banned (includes full ban information)

Paramaters

Path

idstringID of the user to check

Headers

AuthorizationstringYour authorization token

Responses

200 Request was accepted.

# Banned User

{
"status": 200,
"banned": true,
"bandata": {
   "id": "641795527444529152",
   "reason": "Spamming in channels/DMs that do not allow spam",
   "proof": "https://cdn.azrael.gg/uploads/example.png",
   "timestamp": "Monday, June 28, 2021, at 7:15PM EST",
   "moderator": "23957643",
   "notes": "None"
}

# Not Banned User
{
"status": 200,
"banned": false,

}

400 Failed validation or was missing paramaters.

{
"status": 400,
"message": "Error details"
}

401 Authorization header was not recieved

{
"status": 401,
"message": "Unauthorized"
}

403 Authorization token is locked, invalid or not valid for this action.

{
"status": 403,
"message": "Forbidden"
}

500 An internal server error occured.

{
"status": 500,
"message": "Internal Server Error"
}

POST https://api.azrael.gg/v5/bans/add

SUDO https://api.azrael.gg/v5/bans/add/sudo

Add Ban

Add a ban

Paramaters

Headers

AuthorizationstringYour authorization token (staff)

Content-TypestringContent-Type (application/json)

Responses

Body

idstringID of the user being added

reasonintegerThe reason code for the ban

proofstringThe CDN proof link (approved CDNs)

notesstringOptional Mod Notes

200 Request was accepted.

{
"status": 200,
"bid": "AZ-9431465588"
}

400 Failed validation or was missing paramaters.

{
"status": 400,
"message": "Error details"
}

401 Authorization header was not recieved

{
"status": 401,
"message": "Unauthorized"
}

403 Authorization token is locked, invalid or not valid for this action.

{
"status": 403,
"message": "Forbidden"
}

500 An internal server error occured.

{
"status": 500,
"message": "Internal Server Error"
}

PATCH https://api.azrael.gg/v5/bans/edit

SUDO https://api.azrael.gg/v5/bans/edit/sudo

Edit Ban

Edit a ban

Paramaters

Headers

AuthorizationstringYour authorization token (staff)

Content-TypestringContent-Type (application/json)

Responses

Body

idstringID of the user being added

fieldstringField to edit (reason, proof, notes)

valuestringNew value (Proof must use approved CDN link)

204 Ban Updated.

{
"status": 204
}

400 Failed validation or was missing paramaters.

{
"status": 400,
"message": "Error details"
}

401 Authorization header was not recieved

{
"status": 401,
"message": "Unauthorized"
}

403 Authorization token is locked, invalid or not valid for this action.

{
"status": 403,
"message": "Forbidden"
}

404 No ban found.

{
"status": 404,
"message": "No ban found for ID 641795527444529152"
}

500 An internal server error occured.

{
"status": 500,
"message": "Internal Server Error"
}

DELETE https://api.azrael.gg/v5/bans/delete/:id

SUDO https://api.azrael.gg/v5/bans/delete/sudo/:id

Remove Ban

Remove a user from the banlist

Paramaters

Path

idstringID of the user being removed

Headers

AuthorizationstringYour authorization token (staff)

Content-TypestringContent-Type (application/json)

Responses

Body

reasonstringReason for the ban removal

200 Ban Removed.

{
"status": 200,
"message": "Ban Removed",
"altcode": 0
}

400 Failed validation or was missing paramaters.

{
"status": 400,
"message": "Error details"
}

401 Authorization header was not recieved

{
"status": 401,
"message": "Unauthorized"
}

403 Authorization token is locked, invalid or not valid for this action.

{
"status": 403,
"message": "Forbidden"
}

404 No ban found.

{
"status": 404,
"message": "No ban found for ID 641795527444529152"
}

500 An internal server error occured.

{
"status": 500,
"message": "Internal Server Error"
}