PropelAuth

PropelAuth Usage API

Inspect API key usage statistics

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.propelauth.com/reference/api/user
📖
GettingStarted
https://docs.propelauth.com/reference/api/getting-started
📖
Documentation
https://docs.propelauth.com/reference/api/org
📖
Documentation
https://docs.propelauth.com/mcp-authentication/overview

Specifications

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

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/propelauth/refs/heads/main/json-schema/propelauth-user-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/propelauth/refs/heads/main/json-schema/propelauth-org-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/propelauth/refs/heads/main/json-ld/propelauth-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/propelauth/refs/heads/main/examples/propelauth-create-user-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/propelauth/refs/heads/main/examples/propelauth-create-magic-link-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/propelauth/refs/heads/main/examples/propelauth-create-org-example.json

OpenAPI Specification

propelauth-usage-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: PropelAuth End-User API Keys Access Tokens Usage API
  description: 'Backend REST API for validating, issuing, listing, and revoking API keys that PropelAuth

    manages on behalf of your end users and tenant organizations. API keys can be scoped to a

    personal user, an organization, or imported from a legacy auth system. All endpoints

    require a PropelAuth Backend Integration API key.

    '
  version: 1.0.0
  contact:
    name: PropelAuth Support
    url: https://www.propelauth.com
    email: support@propelauth.com
  license:
    name: PropelAuth Terms
    url: https://www.propelauth.com/legal/terms-of-service
servers:
- url: https://{authId}.propelauthtest.com
  description: Test environment
  variables:
    authId:
      default: '0000000000'
- url: https://auth.example.com
  description: Production / Staging custom domain
security:
- BackendApiKey: []
tags:
- name: Usage
  description: Inspect API key usage statistics
paths:
  /api/backend/v1/end_user_api_keys/usage:
    get:
      summary: Fetch API Key Usage
      description: Return validation counts and usage stats for end-user API keys.
      operationId: fetchApiKeyUsage
      tags:
      - Usage
      parameters:
      - name: start_time_seconds
        in: query
        schema:
          type: integer
      - name: end_time_seconds
        in: query
        schema:
          type: integer
      - name: user_id
        in: query
        schema:
          type: string
          format: uuid
      - name: org_id
        in: query
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Usage report
          content:
            application/json:
              schema:
                type: object
                properties:
                  validations:
                    type: integer
                  cache_hits:
                    type: integer
                  cache_misses:
                    type: integer
components:
  securitySchemes:
    BackendApiKey:
      type: http
      scheme: bearer