> ## 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.

# Rotacionar API key

> Rotaciona A API key do escopo chamador — o produto mantém UMA key por escopo, não várias. Uma key escopada a número rotaciona a key padrão daquele número; uma key escopada ao tenant rotaciona a key do tenant. A key antiga é revogada e a nova (campo key) é retornada UMA ÚNICA VEZ. Indisponível para concessões OAuth por número (403).



## OpenAPI

````yaml openapi.pt.json POST /v1/api-keys/regenerate
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/regenerate:
    post:
      tags:
        - API Keys
      summary: Rotacionar API key
      description: >-
        Rotaciona A API key do escopo chamador — o produto mantém UMA key por
        escopo, não várias. Uma key escopada a número rotaciona a key padrão
        daquele número; uma key escopada ao tenant rotaciona a key do tenant. A
        key antiga é revogada e a nova (campo key) é retornada UMA ÚNICA VEZ.
        Indisponível para concessões OAuth por número (403).
      operationId: post_api-keys_regenerate
      responses:
        '201':
          description: Rotacionar key
          content:
            application/json:
              example:
                id: key_03HZX...
                name: Default
                key: ps_THIS_IS_SHOWN_ONLY_ONCE
                keyPrefix: ps_abcd
                keyLast4: wxyz
                scope: number
                whatsappNumberId: num_01HZX...
                createdAt: '2026-06-28T10:00:00.000Z'
        '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
        '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)

````