Heron

Heron Credentials API

The Credentials API from Heron — 4 operation(s) for credentials.

GitHub OpenAPI

Operations 5

GET /api/credentials/keys List API keys #
POST /api/credentials/keys Create a new API key #
DELETE /api/credentials/keys/{heron_id} Delete an API key #
PUT /api/credentials/keys/{heron_id}/activate Activate an API key #
PUT /api/credentials/keys/{heron_id}/deactivate Deactivate an API key #

Documentation

📖
Documentation
https://docs.herondata.io/
📖
APIReference
https://docs.herondata.io/api-reference/authentication
📖
GettingStarted
https://docs.herondata.io/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/authentication/heron-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/openapi/heron-credentials-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/asyncapi/heron-webhooks-asyncapi.yml

Other Resources

🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/llms/heron-llms.txt
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/asyncapi/heron-webhooks-asyncapi.yml

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/heron-credentials-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

heron-credentials-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: support@herondata.io
    name: Support
  title: Heron Data Credentials API
  version: '2021-07-19'
servers:
- description: Production
  url: https://app.herondata.io
security:
- ApiKeyAuth:
  - key_XXX
tags:
- name: Credentials
paths:
  /api/credentials/keys:
    get:
      description: List all API keys for the authenticated user. Returns key metadata including name, token prefix, creation date, and active status. The `last_used` field is the most recent usage timestamp, or null if usage data is not available. Full tokens are never returned - only the first 8 characters where the first 4 are "key_".
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  keys:
                    items:
                      $ref: '#/components/schemas/ApiKeyWithLastUsedSchema'
                    type: array
                type: object
          description: List of API keys
      summary: List API keys
      tags:
      - Credentials
      operationId: getApiCredentialsKeys
      x-operation-id-source: derived
    post:
      description: Create a new named API key for the authenticated user. The full token is returned only in this response - it cannot be retrieved again.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateKeySchema'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyCreatedSchema'
          description: API key created. The full token is only returned in this response.
        '400':
          description: Invalid request
      summary: Create a new API key
      tags:
      - Credentials
      operationId: postApiCredentialsKeys
      x-operation-id-source: derived
  /api/credentials/keys/{heron_id}:
    delete:
      description: Permanently delete an API key. This cannot be undone. Consider deactivating instead if you might need to rollback.
      parameters:
      - in: path
        name: heron_id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Key deleted
        '404':
          description: Key not found
      summary: Delete an API key
      tags:
      - Credentials
      operationId: deleteApiCredentialsKeysByHeronId
      x-operation-id-source: derived
  /api/credentials/keys/{heron_id}/activate:
    put:
      description: Re-activate a previously deactivated API key.
      parameters:
      - in: path
        name: heron_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyStatusSchema'
          description: Key activated
        '404':
          description: Key not found
      summary: Activate an API key
      tags:
      - Credentials
      operationId: putApiCredentialsKeysByHeronIdActivate
      x-operation-id-source: derived
  /api/credentials/keys/{heron_id}/deactivate:
    put:
      description: Deactivate an API key. The key will stop working immediately but can be re-activated later. Use this instead of deleting to allow rollback.
      parameters:
      - in: path
        name: heron_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyStatusSchema'
          description: Key deactivated
        '404':
          description: Key not found
      summary: Deactivate an API key
      tags:
      - Credentials
      operationId: putApiCredentialsKeysByHeronIdDeactivate
      x-operation-id-source: derived
components:
  schemas:
    CreateKeySchema:
      properties:
        name:
          description: A descriptive name for the key
          maxLength: 128
          minLength: 1
          type: string
      required:
      - name
      type: object
    ApiKeyStatusSchema:
      properties:
        heron_id:
          readOnly: true
          type: string
        is_active:
          readOnly: true
          type: boolean
      type: object
    ApiKeyCreatedSchema:
      properties:
        created:
          format: date-time
          readOnly: true
          type: string
        heron_id:
          readOnly: true
          type: string
        is_active:
          readOnly: true
          type: boolean
        name:
          readOnly: true
          type: string
        token:
          description: Full token - shown only once
          readOnly: true
          type: string
        token_prefix:
          readOnly: true
          type: string
      type: object
    ApiKeyWithLastUsedSchema:
      properties:
        created:
          format: date-time
          readOnly: true
          type: string
        heron_id:
          readOnly: true
          type: string
        is_active:
          readOnly: true
          type: boolean
        last_used:
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        name:
          readOnly: true
          type: string
        token_prefix:
          readOnly: true
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: x-api-key
      type: apiKey
externalDocs:
  description: Read Tutorial
  url: https://docs.herondata.io/