curl --request PATCH \
  --url https://api.example.com/api-key/{apiKeyId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Sync ERP Domínio - Produção"
}
'

{
  "status": true,
  "mensagem": "OK"
}

Api Keys

Atualiza nome ou status (ativa/revoga) de uma API Key

Atualiza o nome ou status (ativo/inativo) de uma chave existente. Use para:

Renomear (name): organizar inventário de chaves (ex.: separar “ERP-Producao” de “ERP-Sandbox”)
Revogar (isActive: false): bloquear imediatamente uma chave comprometida ou que não é mais usada

Importante — revogação é imediata: ao definir isActive: false, todas as próximas chamadas com aquela chave falham com 401. A revogação é a ação correta quando você suspeita que a chave vazou (push em repositório público, ex-funcionário com acesso, etc.).

Não permite: alterar permissões ou data de expiração. Para isso, revogue a chave atual e crie uma nova.

Reativação: é possível reativar uma chave inativa enviando isActive: true, desde que ainda não tenha expirado. Após expiresAt, nenhuma reativação é aceita — crie uma nova chave.

PATCH

api-key

{apiKeyId}

curl --request PATCH \
  --url https://api.example.com/api-key/{apiKeyId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Sync ERP Domínio - Produção"
}
'

{
  "status": true,
  "mensagem": "OK"
}

Path Parameters

apiKeyId

string

required

Body

application/json

Campos a atualizar (somente name e/ou isActive)

name

string

required

Novo nome da chave. Útil para reorganizar inventário (ex.: separar "ERP-Producao" de "ERP-Sandbox").

Example:

"Sync ERP Domínio - Produção"

isActive

boolean

Status da chave. false revoga imediatamente — todas as próximas chamadas com a chave falham com 401. Use ao detectar vazamento, desligamento de funcionário ou para desativar integração obsoleta. Pode ser revertido para true enquanto não atingir expiresAt.

Example:

false

Response

Confirmação da atualização

status

boolean

required

Status da operação

Example:

true

mensagem

string

Mensagem de retorno

Example:

"OK"

Cria uma nova API Key Lista ajustes de registro de ponto