Skip to content

Autenticação

A API aceita um bearer token no cabeçalho Authorization. Pra CI, scripts e agentes, use um token de API: uma credencial de longa duração que age em seu nome.

Criar um token

Pelo CLI:

goship token create github-actions                      # expira em 90 dias
goship token create deploy-bot --expires-in-days 0      # sem validade

O token é impresso uma única vez. Só ele vai pro stdout, então dá pra capturar direto:

export GOSHIP_TOKEN=$(goship token create github-actions)

Ou pelo painel, em Profile → API tokens.

Usar

curl -H "Authorization: Bearer $GOSHIP_TOKEN" https://api.goship.sh/api/v1/orgs

No CLI, basta a variável GOSHIP_TOKEN estar definida — veja CLI → Login, organização, projeto e ambiente.

Listar e revogar

goship token list
goship token rm github-actions

A revogação vale na hora. Um token vazado deve ser revogado e substituído, não “escondido”.

O que um token pode fazer

Tudo o que você pode fazer nas suas organizações — fazer deploy, ler logs, rodar comandos, criar apps, mudar variáveis, escalar, gerenciar bancos e domínios. Uma exceção: um token nunca acessa a área administrativa, mesmo que a sua conta seja de administrador.

O próprio goship login usa um token desses: depois do login pelo navegador, o CLI guarda um token chamado “goship CLI on <sua máquina>”, válido por 90 dias. Ele aparece em Profile → API tokens, e goship logout revoga.

Limites

Até 50 tokens ativos por conta. A validade máxima é de 366 dias; 0 cria um token sem validade.

OAuth 2.0 / OIDC pra integrações de terceiros e escopos por token: em breve.