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

# Create an API key

> Creates an API key for this environment. The key is only returned once. Signed-in users only: an API key can't create keys.



## OpenAPI

````yaml /openapi.json post /keys
openapi: 3.1.0
info:
  title: subscriber.dev API
  description: >-
    Trigger workflows, manage subscribers and send broadcasts. Authenticate with
    an API key in the X-API-Key header: the key decides the environment. Docs:
    https://docs.subscriber.dev
  version: '1.0'
  contact: {}
servers:
  - url: https://api.subscriber.dev
    description: Cloud
security: []
tags: []
paths:
  /keys:
    post:
      tags:
        - API keys
      summary: Create an API key
      description: >-
        Creates an API key for this environment. The key is only returned once.
        Signed-in users only: an API key can't create keys.
      operationId: createEnvironmentKey
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEnvironmentKeyRequest'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedEnvironmentKey'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Environment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limited. Wait a second and retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearer: []
components:
  schemas:
    CreateEnvironmentKeyRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
        access:
          description: >-
            limited (the default) can trigger workflows and create or update
            subscribers. full can call every endpoint an API key can.
          type: string
          enum:
            - limited
            - full
        scopes:
          description: Pick scopes yourself instead of access.
          minItems: 1
          type: array
          items:
            type: string
            enum:
              - workflows:trigger
              - workflows:read
              - workflows:write
              - broadcasts:read
              - broadcasts:write
              - subscribers:read
              - subscribers:write
              - emails:test
              - integrations:read
              - integrations:write
              - uploads:write
              - events:read
              - analytics:read
              - billing:read
      required:
        - name
    CreatedEnvironmentKey:
      type: object
      properties:
        publicId:
          type: string
        name:
          type: string
        start:
          type: string
          description: The first characters of the key, to recognise it
        scopes:
          type: array
          items:
            type: string
            enum:
              - workflows:trigger
              - workflows:read
              - workflows:write
              - broadcasts:read
              - broadcasts:write
              - subscribers:read
              - subscribers:write
              - emails:test
              - integrations:read
              - integrations:write
              - uploads:write
              - events:read
              - analytics:read
              - billing:read
        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'
        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))$
        key:
          type: string
          description: The API key. It's only shown this once.
      required:
        - publicId
        - name
        - start
        - scopes
        - lastUsedAt
        - createdAt
        - key
    ErrorResponse:
      type: object
      properties:
        statusCode:
          type: integer
          example: 404
        message:
          type: string
          example: Workflow not found
        error:
          type: string
          example: Not Found
        errors:
          description: Which fields failed validation, on a 400.
          type: array
          items:
            type: object
            properties:
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
              message:
                type: string
              code:
                type: string
            required:
              - path
              - message
      required:
        - statusCode
        - message
  securitySchemes:
    bearer:
      scheme: bearer
      type: http
      description: >-
        A session token from `subscriber login`, used by subscriber.dev's own
        apps. Requests about an environment also need its ID in the
        `x-environment-id` header. From your own code, use an API key.

````

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