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

# Regenerar API key de um número

> REGENERA a API key padrão de um único número (o produto mantém exatamente uma key padrão por número — não existe "criar outra key"). Apenas tenant-scoped (403 NUMBER_SCOPE_NOT_ALLOWED para key de número). Informe o número em whatsappNumberId: a key anterior dele é rotacionada/invalidada e o novo valor bruto (campo `key`) é retornado UMA ÚNICA VEZ — guarde-o. Número desconhecido → 404 NUMBER_NOT_FOUND.

**Requer uma chave com escopo de tenant.**



## OpenAPI

````yaml openapi.pt.json POST /v1/api-keys
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/api-keys:
    post:
      tags:
        - API Keys
      summary: Regenerar API key de um número
      description: >-
        REGENERA a API key padrão de um único número (o produto mantém
        exatamente uma key padrão por número — não existe "criar outra key").
        Apenas tenant-scoped (403 NUMBER_SCOPE_NOT_ALLOWED para key de número).
        Informe o número em whatsappNumberId: a key anterior dele é
        rotacionada/invalidada e o novo valor bruto (campo `key`) é retornado
        UMA ÚNICA VEZ — guarde-o. Número desconhecido → 404 NUMBER_NOT_FOUND.


        **Requer uma chave com escopo de tenant.**
      operationId: post_api-keys
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                whatsappNumberId:
                  type: string
                  description: Id do número cuja key padrão será regenerada.
                  example: wn_1
              required:
                - whatsappNumberId
            example:
              whatsappNumberId: wn_1
      responses:
        '200':
          description: Regenerar key do número
          content:
            application/json:
              example:
                numberId: wn_1
                keyId: k_new
                keyPrefix: ps_
                keyLast4: wxyz
                key: ps_...newreal...
                createdAt: '2026-06-28T10:00:00.000Z'
        '400':
          description: Payload ou parâmetros inválidos
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Validation error
        '401':
          description: Header `x-api-key` / `x-api-key-id` ausente ou inválido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '403':
          description: Chave com escopo de número usada em endpoint exclusivo de tenant
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Number-scoped keys cannot call tenant endpoints
                code: NUMBER_SCOPE_NOT_ALLOWED
        '429':
          description: Limite de taxa excedido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Too many requests
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````