Formato do token
Todos os tokens começam com o prefixovmk_. Passe o token no cabeçalho x-api-key:
Como obter um token
Os tokens são criados no painel da VMArea:1
Acesse API Keys
Navegue até Configurações → API Keys.
2
Crie uma nova chave
Clique em New API Key.
3
Nomeie e configure
Dê um nome descritivo à chave (ex.:
deploy-pipeline).4
Selecione os escopos
Escolha os escopos necessários — conceda apenas o que for preciso.
5
Defina validade (opcional)
Tokens sem validade permanecem ativos até serem revogados manualmente.
6
Copie o segredo
Clique em Create. Copie o segredo imediatamente — ele é exibido apenas uma vez e não pode ser recuperado depois.
Ciclo de vida do token
- Um token fica ativo a partir do momento da criação.
- Se uma validade foi definida, o token é rejeitado automaticamente após essa data/hora.
- Você pode revogar qualquer token pelo painel a qualquer momento.
- Excluir um token é permanente; requisições que o usarem receberão
401 Unauthorized.
Escopos
Os tokens carregam apenas as permissões concedidas na criação. Uma requisição que exige um escopo que o token não possui retorna403 Forbidden. Veja Escopos e permissões para a lista completa.
Exemplos de uso
Boas práticas de segurança
- Use o conjunto mínimo de escopos necessário para a integração.
- Faça rotação de tokens regularmente, especialmente após qualquer suspeita de exposição.
- Defina validade para tokens usados em ambientes de CI/CD.
- Trate seu token
vmk_com o mesmo cuidado que uma senha.