Introduction

Introduction

Welcome to the GarryPanel API documentation.

The API makes use of POST, GET, PATCH and DELETE requests.

Authentication

To authorize, use this code:

# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
-H "Authorization: Bearer api"
-H "Content-Type: application/json" \
-H "Accept: Application/vnd.pterodactyl.v1+json" \

Make sure to replace api with your API key.

You can obtain an API key from the Account API page within Pterodactyl. Remember, protect your API key as if it was a password.

We expect the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: Bearer api You must replace api with your API key.

Ratelimits

To prevent abuse, the GarryPanel API has a ratelimit in place.

Up to 60 requests are allowed per minute.

The amount of requests left can be found within the reply header.

Header

Description

x-ratelimit-limit

The amount of API requests allowed per minute.

x-ratelimit-remaining

The amount of API requests left.