halyard
Browse the docs

Get started

Gateway

Keys

Rate limits

Usage

Logs

SDKs

Reference

DocsGet started

Halyard documentation

Put an endpoint behind the gateway, issue keys for it and see every request it serves. Start with a quickstart, or jump to the part of the stack you are wiring up.

Quickstarts

All quickstarts

5 min

Protect your first endpoint

Point the gateway at an origin, deploy it to the edge and send your first authenticated request.

Start

4 min

Issue and scope keys

Create a key per customer and environment, then narrow it to the routes it should reach.

Start

6 min

Add a rate limit

Write a limit policy, run it in shadow mode against real traffic, then enforce it.

Start

3 min

Search and stream logs

Filter every request by key, route or status, and drain them to your own warehouse.

Start

Popular guides

SDKs and tools

REST API reference
TypeScript
npm i @halyard/sdk
Python
pip install halyard
Go
go get halyard.dev/go
Rust
cargo add halyard
CLI
brew install halyard

Stuck on something?

Email an engineer any time; Pro teams get an answer within one business day.

Read the blogContact support
Was this page useful?
Updated for Halyard 2.14