/Pterodactyl-API

The Pterodactyl OpenAPI spec as generated by Stoplight.io

Primary LanguageHTML

Pterodactyl API Documentation

This repository includes the documentation for the Pterodactyl panel API. The documentation, files of which are in this repository, is hosted at api.ptero.sh.

Structure

This repository is structures in two main parts:

OpenAPI spec

The OpenAPI specifications (the Client API [/api/client] and the Application [/api/application] specifications) are contained in the reference directory.

Articles

The articles are an extension of the OpenAPI spec, and are additional documentation for, for example, the WebSocket API. Currently there is one article:

Libraries

This list includes libraries that help developers interact with the Pterodactyl API without directly doing HTTP requests / holding a websocket.
More entries will be added soon.

Dart:

  • The library by the one and only, TekExplorer - dartactyl

Contributing

This repository's OpenAPI spec and articles are edited using Stoplight Studio.