> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superlog.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Create an ingest key

> Creates a key that applications send logs, traces, and metrics with, and returns its value once. The key can only add telemetry to this workspace. Put it in the app's environment or secret manager, never in a committed file. Browser apps may embed it.



## OpenAPI

````yaml /api-reference/openapi.json post /ingest-keys
openapi: 3.1.0
info:
  description: >-
    Manage a Superlog workspace's automations, runs, tag mode, model access, and
    secrets, read its telemetry, build dashboards and alerts over it, run
    synthetic checks, and export them to Terraform. Every request acts as the
    member who created the API key.
  title: Superlog management API
  version: 1.0.0
servers:
  - url: https://superlog.sh/api/v1
security:
  - bearerAuth: []
tags:
  - description: Connected integrations and the IDs automations and tag mode use.
    name: Integrations
  - description: The workspace and its members.
    name: Workspace
  - description: Keys that authenticate the management API and MCP server.
    name: API keys
  - description: Create and change automations.
    name: Automations
  - description: Start, follow, and cancel automation runs.
    name: Runs
  - description: What Superlog can use and change when someone mentions it in Slack.
    name: Tag mode
  - description: Model API keys, subscriptions, and available models.
    name: Models
  - description: Credentials agents can use without seeing them.
    name: Secrets
  - description: Read the workspace's logs, traces, and metrics.
    name: Telemetry
  - description: >-
      Exceptions in the workspace's telemetry, grouped into issues by
      fingerprint.
    name: Errors
  - description: Create and change dashboards over the workspace's telemetry.
    name: Dashboards
  - description: Threshold alerts on the workspace's telemetry that post to Slack.
    name: Alerts
  - description: HTTP checks that request a URL on a schedule and post failures to Slack.
    name: Synthetics
  - description: Configuration for the superloglabs/superlog Terraform provider.
    name: Terraform
paths:
  /ingest-keys:
    post:
      tags:
        - Telemetry
      summary: Create an ingest key
      description: >-
        Creates a key that applications send logs, traces, and metrics with, and
        returns its value once. The key can only add telemetry to this
        workspace. Put it in the app's environment or secret manager, never in a
        committed file. Browser apps may embed it.
      operationId: create_ingest_key
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 120
                  description: What the key is for, such as the service or environment.
              required:
                - name
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                type: object
                properties:
                  endpoint:
                    type: string
                    description: >-
                      The OTLP/HTTP endpoint. SDKs add /v1/logs, /v1/traces, and
                      /v1/metrics.
                  environment:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties:
                      type: string
                    description: OpenTelemetry SDK settings for the key.
                  key:
                    type: object
                    properties:
                      createdAt:
                        type: string
                      id:
                        type: string
                      lastUsedAt:
                        anyOf:
                          - type: string
                          - type: 'null'
                        description: >-
                          When the key last sent telemetry. Null until it is
                          used.
                      name:
                        type: string
                      prefix:
                        type: string
                        description: The start of the key, to tell keys apart.
                    required:
                      - createdAt
                      - id
                      - lastUsedAt
                      - name
                      - prefix
                    additionalProperties: false
                  token:
                    type: string
                    description: The key. It is not shown again.
                required:
                  - endpoint
                  - environment
                  - key
                  - token
                additionalProperties: false
          description: Created
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: The request is invalid. `issues` lists each invalid field.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: The API key is missing, revoked, or its creator left the workspace.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: >-
            The resource does not exist in this workspace, or the feature it
            belongs to is not enabled.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: >-
            The request conflicts with the current state, such as a name already
            in use.
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          description: A stable machine-readable error code, when there is one.
          type: string
        error:
          type: string
          description: What went wrong.
        issues:
          description: Validation problems, one per invalid field.
          type: array
          items:
            type: object
            properties:
              message:
                type: string
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
            required:
              - message
              - path
            additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      description: A workspace API key, created in Superlog under Settings → API keys.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.