Gate HTTP API

Gate provides a powerful API that exposes its functionality to a wide ecosystem of languages and tools. Using modern technologies like Protocol Buffers, gRPC, and ConnectRPC with schemas managed through buf.build.

Quick Start

Simply enable the API in Gate's configuration, choose your preferred language's client library, and start building!

config.yml

api:
  enabled: true
  bind: localhost:8080

Configuration management is versioned: GetConfig returns an opaque version, and ApplyConfig requires a matching if_match value. It accepts either a complete YAML/JSON configuration or an RFC 7396 JSON Merge Patch. Runtime application is limited to route changes in an already-enabled Java Lite configuration; restart-required changes are rejected.

Official SDKs

Gate's API definitions are hosted on buf.build/minekube/gate, where you can directly pull client libraries using your preferred language's package manager:

TypeScript

via npm packages

Python

via pip packages

Go

via go modules

Rust

via crates

Kotlin

via Maven artifacts

Java

via Maven artifacts

Features

Why Gate API?

The HTTP API enables you to build and deploy functionality independently from your proxy - perfect for rapid iteration without disrupting your players.

Independent Updates

Apply proven live-safe changes without restarting Gate or disconnecting players

Cross-Language Support

Access Gate's core functionality from any programming language

Plugin Development

Build extensions and plugins in your preferred language

Automation

Automate server registration and management tasks

Custom Tools

Create administrative interfaces and management tools

Integration

Connect Gate with external systems and services

Learn More

To understand the key technologies used in Gate's API, check out the Glossary.