Octane

Octane Admin API

Administrative operations

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.getoctane.io

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/octane/refs/heads/main/openapi/octane-admin-api-openapi.yml

Other Resources

🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/octane/refs/heads/main/apis.yml

OpenAPI Specification

octane-admin-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Octane REST Admin API
  description: REST API for managing meters, customers, pricing plans, subscriptions, measurements, and real-time usage data for usage-based billing workflows. Octane enables infrastructure and SaaS companies to implement flexible pay-as-you-go billing similar to Snowflake and AWS.
  version: 1.0.0
  contact:
    name: Octane Support
    url: https://www.getoctane.io
servers:
- url: https://api.getoctane.io
  description: Octane Production API
security:
- BearerApiKeyAuth: []
tags:
- name: Admin
  description: Administrative operations
paths:
  /admin/api_key/roll:
    post:
      summary: Roll API Key
      description: Generate a new API key, invalidating the existing one.
      operationId: adminApiKeyRollPost
      tags:
      - Admin
      responses:
        '200':
          description: New API key
          content:
            application/json:
              schema:
                type: object
components:
  securitySchemes:
    BearerApiKeyAuth:
      type: http
      scheme: bearer
      description: API key passed as a Bearer token in the Authorization header.