Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Warrant Check API

Real-time access checks and relationship queries.

Warrant Check API is one of 5 APIs that Warrant publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Check. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://api.warrant.dev, http://localhost:8000.

2 operations 2 paths 6 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.warrant.dev/v1
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Warrant Check API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — API key passed as Authorization: ApiKey YOURAPIKEY. Self-hosted deployments configure the key via ApiKey in the server config.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Check 2

Real-time access checks and relationship queries.

POST
/v2/authorize
Check access
checkAccess body → 200401
GET
/v1/query
Query relationships
queryAccess 3 params → 200401

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Warrant (5 properties), QueryResult (5 properties), CheckRequest (4 properties), Subject (3 properties). Each schema is shown below with its type and property counts.

QueryResult
object
5 properties
CheckResult
object
2 properties
Subject
object
3 properties 2 required
Warrant
object
5 properties 4 required
Error
object
2 properties
CheckRequest
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

warrant-dev-check-api-openapi.yml Raw ↑

Other APIs Warrant publishes across the network.

Warrant Object Types API
Warrant Objects API
Warrant Roles and Permissions API
Warrant Warrants API