Fwozen

Fwozen API keys API

Minting, rotating and revoking `fwz_` keys. Session credential only, always: a key can never mint another key.

Documentation GitHub OpenAPI

Operations 5

GET /v1/api-keys/scopes The API key scope vocabulary #

GET /v1/api-keys List API keys #

POST /v1/api-keys Create an API key #

POST /v1/api-keys/{apiKeyId}/rotate Rotate an API key with a grace window #

DELETE /v1/api-keys/{apiKeyId} Revoke an API key #

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/fwozen-com:fwozen-com-api-keys-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Fwozen Com API keys API
  version: 1.0.0
  contact:
    name: Fwozen support
    url: https://fwozen.com/docs
    email: hello@fwozen.com
  license:
    name: Fwozen Terms of Service
    url: https://fwozen.com/legal/terms
  description: 'Operations tagged API keys across 2 of this provider''s published API definitions: fwozen-com-openapi.json, fwozen-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.fwozen.com
security:
- bearerApiKey: []
tags:
- name: API Keys
  description: 'Minting, rotating and revoking `fwz_` keys. Session credential only, always: a key can never mint another key.'
paths:
  /v1/api-keys/scopes:
    get:
      operationId: listApiKeyScopes
      summary: The API key scope vocabulary
      tags:
      - API Keys
      security:
      - bearerJwt: []
      responses:
        '200':
          description: The API key scope vocabulary
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyScopes'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
      x-fwozen-rate-cost: 1
      x-fwozen-permissions:
      - apikey:manage
    servers:
    - url: https://api.fwozen.com
  /v1/api-keys:
    get:
      operationId: listApiKeys
      summary: List API keys
      tags:
      - API Keys
      security:
      - bearerJwt: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          default: 50
          type: integer
          minimum: 1
          maximum: 200
      - name: cursor
        in: query
        required: false
        schema:
          type: string
          maxLength: 512
      responses:
        '200':
          description: List API keys
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
      x-fwozen-rate-cost: 1
      x-fwozen-permissions:
      - apikey:manage
    post:
      operationId: createApiKey
      summary: Create an API key
      tags:
      - API Keys
      security:
      - bearerJwt: []
      responses:
        '201':
          description: Create an API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyWithSecret'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
      x-fwozen-rate-cost: 1
      x-fwozen-permissions:
      - apikey:manage
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateApiKeyInputInput'
    servers:
    - url: https://api.fwozen.com
  /v1/api-keys/{apiKeyId}/rotate:
    post:
      operationId: rotateApiKey
      summary: Rotate an API key with a grace window
      tags:
      - API Keys
      security:
      - bearerJwt: []
      parameters:
      - name: apiKeyId
        in: path
        required: true
        schema:
          type: string
          pattern: ^key_[1-9A-HJ-NP-Za-km-z]{16}$
      responses:
        '200':
          description: Rotate an API key with a grace window
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyWithSecret'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
      x-fwozen-rate-cost: 1
      x-fwozen-permissions:
      - apikey:manage
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RotateApiKeyInputInput'
    servers:
    - url: https://api.fwozen.com
  /v1/api-keys/{apiKeyId}:
    delete:
      operationId: revokeApiKey
      summary: Revoke an API key
      tags:
      - API Keys
      security:
      - bearerJwt: []
      parameters:
      - name: apiKeyId
        in: path
        required: true
        schema:
          type: string
          pattern: ^key_[1-9A-HJ-NP-Za-km-z]{16}$
      responses:
        '200':
          description: Revoke an API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKey'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
      x-fwozen-rate-cost: 1
      x-fwozen-permissions:
      - apikey:manage
    servers:
    - url: https://api.fwozen.com
components:
  schemas:
    ApiKeyScopes:
      type: object
      properties:
        scopes:
          type: array
          items:
            type: object
            properties:
              value:
                type: string
                enum:
                - freeze:read
                - freeze:write
                - schedule:read
                - schedule:write
                - exception:read
                - exception:write
                - repo:read
                - repo:write
                - audit:read
                - billing:read
                - billing:write
              label:
                type: string
              description:
                type: string
              defaultSelected:
                type: boolean
            required:
            - value
            - label
            - description
            - defaultSelected
            additionalProperties: false
        agentKeyMaxExpiryDays:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
      required:
      - scopes
      - agentKeyMaxExpiryDays
      additionalProperties: false
    RotateApiKeyInputInput:
      type: object
      properties:
        graceDays:
          default: 7
          type: integer
          minimum: 0
          maximum: 30
        expiresInDays:
          anyOf:
          - type: integer
            minimum: 1
            maximum: 730
          - type: 'null'
    ApiKeyWithSecret:
      type: object
      properties:
        key:
          $ref: '#/components/schemas/ApiKey'
        secret:
          type: string
          pattern: ^fwz_(live|test)_[1-9A-HJ-NP-Za-km-z]{40}$
      required:
      - key
      - secret
      additionalProperties: false
    Actor:
      type: object
      properties:
        type:
          type: string
          enum:
          - user
          - api_key
          - slack_user
          - scheduler
          - system
          - github_user
        id:
          anyOf:
          - type: string
          - type: 'null'
        displayName:
          type: string
        githubLogin:
          anyOf:
          - type: string
          - type: 'null'
        slackUserId:
          anyOf:
          - type: string
          - type: 'null'
        impersonatorId:
          anyOf:
          - type: string
          - type: 'null'
        apiKeyKind:
          default: null
          anyOf:
          - type: string
            enum:
            - human
            - agent
          - type: 'null'
      required:
      - type
      - id
      - displayName
      - githubLogin
      - slackUserId
      - impersonatorId
      - apiKeyKind
      additionalProperties: false
    CreateApiKeyInputInput:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 80
        scopes:
          minItems: 1
          maxItems: 11
          type: array
          items:
            type: string
            enum:
            - freeze:read
            - freeze:write
            - schedule:read
            - schedule:write
            - exception:read
            - exception:write
            - repo:read
            - repo:write
            - audit:read
            - billing:read
            - billing:write
        expiresInDays:
          anyOf:
          - type: integer
            minimum: 1
            maximum: 730
          - type: 'null'
        environment:
          default: live
          type: string
          enum:
          - live
          - test
        kind:
          default: human
          type: string
          enum:
          - human
          - agent
      required:
      - name
      - scopes
      - expiresInDays
    ApiKeyPage:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ApiKey'
        nextCursor:
          anyOf:
          - type: string
          - type: 'null'
      required:
      - data
      - nextCursor
      additionalProperties: false
    ApiKey:
      type: object
      properties:
        id:
          type: string
          pattern: ^key_[1-9A-HJ-NP-Za-km-z]{16}$
        name:
          type: string
        keyPrefix:
          type: string
        scopes:
          type: array
          items:
            type: string
            enum:
            - freeze:read
            - freeze:write
            - schedule:read
            - schedule:write
            - exception:read
            - exception:write
            - repo:read
            - repo:write
            - audit:read
            - billing:read
            - billing:write
        environment:
          type: string
          enum:
          - live
          - test
        kind:
          type: string
          enum:
          - human
          - agent
        createdBy:
          $ref: '#/components/schemas/Actor'
        createdAt:
          type: string
          format: date-time
          pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
        expiresAt:
          anyOf:
          - type: string
            format: date-time
            pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
          - type: 'null'
        lastUsedAt:
          anyOf:
          - type: string
            format: date-time
            pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
          - type: 'null'
        revokedAt:
          anyOf:
          - type: string
            format: date-time
            pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
          - type: 'null'
        rotatedAt:
          anyOf:
          - type: string
            format: date-time
            pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
          - type: 'null'
        replacesKeyId:
          anyOf:
          - type: string
            pattern: ^key_[1-9A-HJ-NP-Za-km-z]{16}$
          - type: 'null'
      required:
      - id
      - name
      - keyPrefix
      - scopes
      - environment
      - kind
      - createdBy
      - createdAt
      - expiresAt
      - lastUsedAt
      - revokedAt
      - rotatedAt
      - replacesKeyId
      additionalProperties: false
    ErrorEnvelope:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  path:
                    type: string
                  message:
                    type: string
                required:
                - path
                - message
                additionalProperties: false
            docsUrl:
              type: string
            requestId:
              type: string
            warnings:
              type: array
              items:
                type: string
          required:
          - type
          - code
          - message
          - requestId
          additionalProperties: false
      required:
      - error
      additionalProperties: false
  responses:
    Forbidden:
      description: Authenticated, but not permitted.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: No such resource — also returned for another organization's id.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    BadRequest:
      description: Malformed request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    RateLimited:
      description: Rate limit exceeded. Honour the `Retry-After` header.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: Missing or invalid credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    ValidationFailed:
      description: The request failed schema validation; see `error.details`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    bearerApiKey:
      type: http
      scheme: bearer
      bearerFormat: fwz_<env>_<40 base58>
      description: 'Org-scoped, never user-scoped: the scope list IS the authorization. Calling a

        session-only route with a key returns **403 `credential_type_not_allowed`**, never 401,

        so scripts get an actionable message.


        **Where one comes from.** Sign in at

        [https://fwozen.com/app/settings/api-keys](https://fwozen.com/app/settings/api-keys) as an owner or an

        admin, press **Create key**, tick the narrowest scopes that do the job (`freeze:read`

        for a deploy gate, `freeze:write` to freeze and thaw), pick an expiry, and copy the

        secret, which is shown once. `POST /v1/api-keys` is the same thing programmatically and

        takes a **session** credential only, so a key can never mint another key. Scopes are

        fixed at creation and cannot be widened.


        - `freeze:read` — List freezes, freeze targets and freeze state, including GET /v1/freeze-state.

        - `freeze:write` — Start a freeze, lift one, extend one, create a thaw override, retry targets.

        - `schedule:read` — List schedules, occurrences and previews.

        - `schedule:write` — Create, edit, delete, skip and import schedules.

        - `exception:read` — List per-PR exceptions and exception requests.

        - `exception:write` — Grant, decide and revoke per-PR exceptions.

        - `repo:read` — List repositories, watched branches and enforcement state.

        - `repo:write` — Enable or disable repositories and change watched-branch settings.

        - `audit:read` — Read the audit log and stream the CSV export.

        - `billing:read` — Read the billing summary, plan, trial state and resolved entitlements.

        - `billing:write` — Start the 14-day no-card trial, and ask for a Stripe Checkout or Customer Portal link. It cannot pay for anything: those routes return a URL for a human to open and take no card details of any kind.'
    bearerJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: A short-lived RS256 session token from `GET /api/auth/token` on the web origin. Used by the dashboard, the CLI and agents; audience-bound to this API.
x-refined-from:
- fwozen-com-openapi.json
- fwozen-com-openapi.yml
x-provenance:
  method: harvested
  publisher: Fwozen
  source: https://fwozen.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)