CHIRP Wireless API Keys API

The Api-Keys API from CHIRP Wireless — 4 operation(s) for api-keys.

GitHub OpenAPI

Operations 5

GET /api/v2/organizations/api-key-scopes List available API key scopes #
GET /api/v2/organizations/api-keys List API keys #
POST /api/v2/organizations/api-keys Create API key #
DELETE /api/v2/organizations/api-keys/{id} Revoke API key #
POST /api/v2/organizations/api-keys/{id}/rotate Rotate 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/chirpwireless-io:chirpwireless-io-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.

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

OpenAPI Specification

chirpwireless-io-api-keys-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Chirpwireless Io API Keys API
  version: 1.0.0
  description: 'Operations tagged Api-Keys across 2 of this provider''s published API definitions: chirpwireless-io-openapi.yaml, chirpwireless-io-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.chirpwireless.io
  description: Chirp API
security:
- ApiKeyAuth: []
  OrgId: []
tags:
- name: API Keys
paths:
  /api/v2/organizations/api-key-scopes:
    get:
      operationId: listApiKeyScopes
      summary: List available API key scopes
      description: 'Retrieve all scopes that can be assigned to API keys.


        **Required scope:** `api-keys:read`'
      tags:
      - API Keys
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    labelKey:
                      type: string
                    value:
                      type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      parameters:
      - name: organizationId
        in: query
        required: true
        description: Organization ID (UUID)
        schema:
          type: string
    servers:
    - url: https://api.chirpwireless.io
      description: Chirp API
  /api/v2/organizations/api-keys:
    get:
      operationId: listApiKeys
      summary: List API keys
      description: 'Retrieve all API keys for the current user in the organization.


        **Required scope:** `api-keys:read`'
      tags:
      - API Keys
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    createdAt:
                      type: string
                    expiresAt:
                      type: string
                    id:
                      type: string
                    lastUsedAt:
                      type: string
                    name:
                      type: string
                    prefix:
                      type: string
                    scopes:
                      type: array
                      items:
                        type: string
                    status:
                      type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      parameters:
      - name: organizationId
        in: query
        required: true
        description: Organization ID (UUID)
        schema:
          type: string
    post:
      operationId: createApiKey
      summary: Create API key
      description: 'Create a new API key with specified scopes.


        **Required scope:** `api-keys:write`'
      tags:
      - API Keys
      responses:
        '200':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  key:
                    type: string
                    description: The API key secret (only shown once at creation)
                  scopes:
                    type: array
                    items:
                      type: string
                  expiresAt:
                    type: string
                  createdAt:
                    type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Human-readable API key name
                organizationId:
                  type: string
                scopes:
                  type: array
                  description: List of scopes to assign (e.g. devices:read, devices:write)
                  items:
                    type: string
                expiresAt:
                  type: string
                  description: Optional expiration date (ISO 8601)
              required:
              - name
              - organizationId
    servers:
    - url: https://api.chirpwireless.io
      description: Chirp API
  /api/v2/organizations/api-keys/{id}:
    delete:
      operationId: revokeApiKey
      summary: Revoke API key
      description: 'Permanently revoke an API key by ID.


        **Required scope:** `api-keys:write`'
      tags:
      - API Keys
      responses:
        '200':
          description: Successful response
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      parameters:
      - name: id
        in: path
        required: true
        description: API key ID (UUID)
        schema:
          type: string
      - name: organizationId
        in: query
        required: true
        description: Organization ID (UUID)
        schema:
          type: string
    servers:
    - url: https://api.chirpwireless.io
      description: Chirp API
  /api/v2/organizations/api-keys/{id}/rotate:
    post:
      operationId: rotateApiKey
      summary: Rotate API key
      description: 'Rotate an API key, generating a new secret while keeping the same scopes.


        **Required scope:** `api-keys:write`'
      tags:
      - API Keys
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  key:
                    type: string
                  prefix:
                    type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      parameters:
      - name: id
        in: path
        required: true
        description: API key ID (UUID)
        schema:
          type: string
      - name: organizationId
        in: query
        required: true
        description: Organization ID (UUID)
        schema:
          type: string
    servers:
    - url: https://api.chirpwireless.io
      description: Chirp API
components:
  schemas:
    Error:
      type: object
      required:
      - error
      - message
      properties:
        error:
          type: string
        message:
          type: string
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: unauthenticated
            message: missing X-API-Key header
    Forbidden:
      description: Insufficient permissions (missing required scope)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: permission_denied
            message: 'API key lacks required scope: devices:write'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'API key for authentication (format: `chirp_<key>`)'
    OrgId:
      type: apiKey
      in: header
      name: X-Organization-Id
      description: Organization UUID that the API key belongs to
x-refined-from:
- chirpwireless-io-openapi.yaml
- chirpwireless-io-openapi.yml
x-tagGroups:
- name: REST API
  tags:
  - Users
  - Devices
  - Sensors
  - Commands
  - Telemetry
  - Connections
  - Connectors
  - Dashboards
  - Orgs
  - Subscriptions
  - Api-Keys
  - Rules
- name: On-Prem / Advanced (gRPC)
  tags:
  - User Profile (gRPC)
  - Digital Device (gRPC)
  - Sensor Template (gRPC)
  - Connector (gRPC)
  - Connection (gRPC)
  - Dashboard (gRPC)
  - Widget (gRPC)
  - Actuator Command (gRPC)
  - Sensor Query (gRPC)
  - Organizations (gRPC)
  - Access Control (gRPC)