invoicepdfs-com API Keys API

openapi: 3.2.0
info:
  title: Invoicepdfs Com API Keys API
  version: 0.3.0
  contact:
    name: InvoicePDFs
    url: https://invoicepdfs.com/
  license:
    name: MIT
  description: 'Operations tagged api-keys across 2 of this provider''s published API definitions: openapi.json, invoicepdfs-com-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: API Keys
paths:
  /api/v1/api-keys:
    get:
      tags:
      - API Keys
      summary: List Api Keys
      description: 'Every API key on the account, including revoked ones.


        Shows only the last four characters: the key itself is stored hashed and

        cannot be recovered.'
      operationId: list_api_keys
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyListResponse'
      security:
      - HTTPBearer: []
      x-visibility: public
    post:
      tags:
      - API Keys
      summary: Create Api Key
      description: 'Create an API key and return it once.


        The response is the only place the key appears — it is stored hashed, so a

        lost key cannot be recovered, only replaced.


        Keys are not scoped: any key can do anything this account can, including

        creating further keys and deleting data. Treat one as a full credential.'
      operationId: create_api_key
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiKeyCreateRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyCreateResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      security:
      - HTTPBearer: []
      x-visibility: public
  /api/v1/api-keys/{api_key_id}:
    delete:
      tags:
      - API Keys
      summary: Revoke Api Key
      description: 'Stop an API key working, permanently.


        Takes effect immediately and cannot be undone — issue a new key with

        `create_api_key` instead. The record is kept, so the key still appears in

        `list_api_keys` with a revoked date and the audit log stays readable.


        Revoking an already-revoked key succeeds and changes nothing.'
      operationId: revoke_api_key
      security:
      - HTTPBearer: []
      parameters:
      - name: api_key_id
        in: path
        required: true
        schema:
          type: string
          title: Api Key Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyRevokeResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
    get:
      tags:
      - API Keys
      summary: Get Api Key
      description: One API key's details by id, without the key itself.
      operationId: get_api_key
      security:
      - HTTPBearer: []
      parameters:
      - name: api_key_id
        in: path
        required: true
        schema:
          type: string
          title: Api Key Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyDetailResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
    patch:
      tags:
      - API Keys
      summary: Update Api Key
      description: 'Rename an API key.


        The key itself is unchanged and keeps working. To replace the secret while

        keeping the record, use `rotate_api_key`.'
      operationId: update_api_key
      security:
      - HTTPBearer: []
      parameters:
      - name: api_key_id
        in: path
        required: true
        schema:
          type: string
          title: Api Key Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiKeyPatchRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyDetailResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
  /api/v1/api-keys/{api_key_id}/rotate:
    post:
      tags:
      - API Keys
      summary: Rotate Api Key
      description: Revoke the existing key and create a new one with the same name.
      operationId: rotate_api_key
      security:
      - HTTPBearer: []
      parameters:
      - name: api_key_id
        in: path
        required: true
        schema:
          type: string
          title: Api Key Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyRotateResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
components:
  schemas:
    ApiKeyCreateResponse:
      properties:
        data:
          $ref: '#/components/schemas/ApiKeyCreated'
      type: object
      required:
      - data
      title: ApiKeyCreateResponse
    ApiKeyCreateRequest:
      properties:
        name:
          type: string
          maxLength: 128
          title: Name
          default: default
          examples:
          - production
      type: object
      title: ApiKeyCreateRequest
    ApiKeyListItem:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        last4:
          type: string
          title: Last4
        created_at:
          type: string
          title: Created At
        revoked_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Revoked At
      type: object
      required:
      - id
      - name
      - last4
      - created_at
      title: ApiKeyListItem
    ApiKeyCreated:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        api_key:
          type: string
          title: Api Key
        last4:
          type: string
          title: Last4
        created_at:
          type: string
          title: Created At
      type: object
      required:
      - id
      - name
      - api_key
      - last4
      - created_at
      title: ApiKeyCreated
    ApiKeyListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/ApiKeyListItem'
          type: array
          title: Data
        pagination:
          $ref: '#/components/schemas/CursorPagination'
      type: object
      required:
      - data
      title: ApiKeyListResponse
    CursorPagination:
      properties:
        has_more:
          type: boolean
          title: Has More
          default: false
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
      type: object
      title: CursorPagination
    ApiKeyPatchRequest:
      properties:
        name:
          type: string
          maxLength: 128
          title: Name
      type: object
      required:
      - name
      title: ApiKeyPatchRequest
    ApiKeyRotateResponse:
      properties:
        data:
          $ref: '#/components/schemas/ApiKeyCreated'
      type: object
      required:
      - data
      title: ApiKeyRotateResponse
    ApiKeyRevokeResponse:
      properties:
        data:
          additionalProperties:
            type: boolean
          type: object
          title: Data
      type: object
      required:
      - data
      title: ApiKeyRevokeResponse
    ApiErrorResponse:
      type: object
      title: ApiErrorResponse
      properties:
        error:
          type: object
          properties:
            status:
              type: integer
              example: 422
              description: HTTP status, mirroring the response status line.
            code:
              type: string
              example: unprocessable_entity
            message:
              type: string
              example: Request validation failed
            request_id:
              type: string
              nullable: true
              description: Trace id for this request; also returned as X-Trace-Id.
            details:
              type: object
              nullable: true
              description: Error-specific context. Validation failures carry `fields`.
          required:
          - status
          - code
          - message
      required:
      - error
    ApiKeyDetailResponse:
      properties:
        data:
          $ref: '#/components/schemas/ApiKeyListItem'
      type: object
      required:
      - data
      title: ApiKeyDetailResponse
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- openapi.json
- invoicepdfs-com-openapi.json
x-internal-tags:
- auth
- jobs
- logs