Skip to main content

API docs

The docs for the Pelican API can be found by going to /docs/api on your panel.

Sign in before accessing the API docs

You must sign in on the login page before accessing the docs.

For example:

https://yourpaneladdress.com/docs/api

You can also visit the docs on the demo instance here.

There are two APIs you can interact with. The first is the Application API. The application API is used more for adjusting the server configuration. The second is the client API. This API is more for interacting with the features that users normally interact with.