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 Object Types API

The authorization model - object types and their relations.

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

Tagged areas include Object Types. 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 1 schema. 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.

5 operations 2 paths 1 schemas 1 DELETE2 GET1 POST1 PUT

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 Object Types 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.

Object Types 5

The authorization model - object types and their relations.

GET
/v1/object-types
List object types
listObjectTypes → 200
POST
/v1/object-types
Create an object type
createObjectType body → 200
GET
/v1/object-types/{type}
Get an object type
getObjectType 1 param → 200
PUT
/v1/object-types/{type}
Update an object type
updateObjectType 1 param body → 200
DELETE
/v1/object-types/{type}
Delete an object type
deleteObjectType 1 param → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is ObjectType (2 properties). Each schema is shown below with its type and property counts.

ObjectType
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

warrant-dev-object-types-api-openapi.yml Raw ↑

Other APIs Warrant publishes across the network.

Warrant Check API
Warrant Objects API
Warrant Roles and Permissions API
Warrant Warrants API