> For the complete documentation index, see [llms.txt](https://screamz2k.gitbook.io/phoenixc2/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://screamz2k.gitbook.io/phoenixc2/developer-reference/endpoints.md).

# Endpoints

{% hint style="info" %}
There's a insomnia.json file containing all endpoints inside the github repo.

This simplifies testing and shows example request bodies.
{% endhint %}

## Guide for contacting the API.

* Authorization works using a permanent API-key or session cookies generated when logging in.
* Endpoints accept **form** content-types only.
* JSON Output looks like this: 
  * `{"status": "error|success", "message": "the endpoint message"}`
* Status Codes:
  * 20\* is used if the operations was a success
  * 30\* to redirect to the frontend pages
  * 40\* for client-side errors (ex: failing parameters)
  * 50\* errors from the server side (ex: listener couldn't be started)