Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/panel/advanced/api-docs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import Admonition from '@theme/Admonition';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

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

<Admonition type="warning" title="Sign in before accessing the API docs">
You must sign in on the login page **before** accessing the docs.
</Admonition>

For example:
```bash
https://yourpaneladdress.com/docs/api
```

You can also visit the docs on the demo instance [here](https://demo.pelican.dev/docs/api).

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.
1 change: 1 addition & 0 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ const sidebars: SidebarsConfig = {
'panel/advanced/mysql',
'panel/advanced/artisan',
'panel/advanced/docker',
'panel/advanced/api-docs',
'panel/advanced/plugins',
]
}
Expand Down