Configuration Generator

API

Banlist

Blocks

Chat

Items

Operators

Ping

Players

Plugins

Server

Whitelist

Worlds

Endpoint description

Get API information

[Updated] - This endpoint now returns official website and documentation link for admin keys

Endpoint route

GET

/api/v1/api

Response type

Application/Json

Header parameters

KeyValueTypeRequired
AuthorizationBasic [key]stringFor Basic authentication mode only
Authorization[key]stringFor Key-Basic and Key-Advanced authentication modes only

Query Parameters

No parameters

Body parameters

No parameters

Access rights

Authentication typeKey typeAllowed
Openfalse
Basicfalse
Key-Basicfalse
Key-AdvancedPublic keyfalse
Key-AdvancedProtected keyfalse
Key-AdvancedAdmin keyfalse

Success response

{
    "name": string,
    "version": string,
    "description": string,
    "author": string,
    "releaseDate": string,
    "website": string,                          // - For Admin keys only
    "documentation": string                     // - For Admin keys only
}

Error response

{
    "success": bool,
    "code": int,
    "message": string
}

Return codes

HTTP CodeType
200OK
401Unauthorized