Warrant Objects API
Resources and subjects that participate in the authorization model.
Warrant Objects API is one of 5 APIs that Warrant publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Objects. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 5 operations across 2 paths, and defines 4 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Warrant Objects 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 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Resources and subjects that participate in the authorization model.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Object (4 properties), ObjectCreate (3 properties), Error (2 properties), ObjectUpdate (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Warrant 4
Other APIs Warrant publishes across the network.