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 Warrants API

Relationship tuples (access rules) between subjects and objects.

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

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

This API exposes 3 operations across 1 path, and defines 3 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.

3 operations 1 paths 3 schemas 1 DELETE1 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 Warrants 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 3

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

Warrants 3

Relationship tuples (access rules) between subjects and objects.

GET
/v1/warrants
List / query warrants
queryWarrants 5 params → 200401
POST
/v1/warrants
Create a warrant
createWarrant body → 200
DELETE
/v1/warrants
Delete a warrant
deleteWarrant body → 200

Schemas 3

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

Subject
object
3 properties 2 required
Error
object
2 properties
Warrant
object
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Warrant publishes across the network.

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