AuraVMS API Key Management API

Create, list, and revoke API keys.

Operations 3

GET /api/api-keys/ List all API keys for your organization #
POST /api/api-keys/ Create a new API key. The raw key is returned only once - save it immediately #
POST /api/api-keys/{key_id}/revoke/ Revoke an API key. It will immediately stop working #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/auravms-com:auravms-com-api-key-management-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

auravms-com-api-key-management-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: AuraVMS API Key Management API
  version: 1.1.0
  description: Create RFQs, manage suppliers, compare supplier quotations, and place purchase orders. Mutating operations can send supplier email or create business records; obtain user confirmation before calling them.
  contact:
    name: AuraVMS
    url: https://www.auravms.com/contact
  license:
    name: Proprietary
  x-versioning-policy: Stable versions are encoded in URL paths. Deprecated operations identify a replacement and advertise Deprecation and Sunset response headers before removal. See https://www.auravms.com/api-versioning.md.
  x-deprecation-policy: https://www.auravms.com/api-versioning.md
servers:
- url: https://api.auravms.com
  description: Production API
security:
- BearerAuth: []
tags:
- name: API Key Management
  description: Create, list, and revoke API keys.
paths:
  /api/api-keys/:
    get:
      operationId: get_api-keys_api_api_keys_1
      tags:
      - API Key Management
      summary: List all API keys for your organization
      description: List all API keys for your organization.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  keys:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        name:
                          type: string
                        key_prefix:
                          type: string
                        is_active:
                          type: boolean
                        last_used_at:
                          type: string
                        created_at:
                          type: string
                        expires_at:
                          type: 'null'
                        revoked_at:
                          type: 'null'
                      required:
                      - id
                      - name
                      - key_prefix
                      - is_active
                      - last_used_at
                      - created_at
                      - expires_at
                      - revoked_at
                      additionalProperties: true
                required:
                - success
                - keys
                additionalProperties: true
              example:
                success: true
                keys:
                - id: 1
                  name: ERP Integration
                  key_prefix: avms_09fc320d867
                  is_active: true
                  last_used_at: '2026-04-12T07:43:22Z'
                  created_at: '2026-04-12T07:42:37Z'
                  expires_at: null
                  revoked_at: null
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
        '401':
          description: Authentication required or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
        '403':
          description: The token cannot perform this action
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
        '404':
          description: The requested resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
    post:
      operationId: post_api-keys_api_api_keys_2
      tags:
      - API Key Management
      summary: Create a new API key. The raw key is returned only once - save it immediately
      description: Create a new API key. The raw key is returned only once - save it immediately. name is required. expires_in_days is optional (null = never expires). The raw key (avms_...) is shown only at creation time. Response includes capabilities and restricted lists.
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        description: Replay key for JSON mutations. Reuse with the same body returns the original response for 24 hours; reuse with a different body returns 409.
        schema:
          type: string
          minLength: 8
          maxLength: 255
          pattern: ^[A-Za-z0-9._:-]+$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                expires_in_days:
                  type: integer
              required:
              - name
              - expires_in_days
              additionalProperties: true
            example:
              name: ERP Integration
              expires_in_days: 365
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  key:
                    type: string
                  id:
                    type: integer
                  name:
                    type: string
                  key_prefix:
                    type: string
                  expires_at:
                    type: string
                  capabilities:
                    type: array
                    items:
                      type: string
                  restricted:
                    type: array
                    items:
                      type: string
                  warning:
                    type: string
                required:
                - success
                - key
                - id
                - name
                - key_prefix
                - expires_at
                - capabilities
                - restricted
                - warning
                additionalProperties: true
              example:
                success: true
                key: avms_09fc320d867528bb92b778f2ddc034fb24805f35
                id: 1
                name: ERP Integration
                key_prefix: avms_09fc320d867
                expires_at: '2027-04-12T07:42:37Z'
                capabilities:
                - Create and manage suppliers
                - '...'
                restricted:
                - Organization settings and team management
                - '...'
                warning: Save this key now. It cannot be retrieved again.
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
        '401':
          description: Authentication required or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
        '403':
          description: The token cannot perform this action
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
        '404':
          description: The requested resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
        '409':
          description: The idempotency key is still processing or was reused with a different request body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
  /api/api-keys/{key_id}/revoke/:
    post:
      operationId: post_api-keys_api_api_keys_key_id_revoke_3
      tags:
      - API Key Management
      summary: Revoke an API key. It will immediately stop working
      description: Revoke an API key. It will immediately stop working.
      parameters:
      - name: key_id
        in: path
        required: true
        description: API key ID
        schema:
          type: integer
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                required:
                - success
                - message
                additionalProperties: true
              example:
                success: true
                message: API key revoked.
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
        '401':
          description: Authentication required or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
        '403':
          description: The token cannot perform this action
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
        '404':
          description: The requested resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
components:
  schemas:
    ApiError:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT or avms_ API key
      description: Use a JWT access token or an API key created under Settings > API Keys. AuraVMS does not currently expose OAuth authorization.
externalDocs:
  description: AuraVMS API and agent guide
  url: https://www.auravms.com/docs