Menu Docs
Página inicial do Docs
/ /
Atlas CLI
/ / /

lista de apiKeys do projeto Atlas

Nesta página

  • Sintaxe
  • Opções
  • Opções herdadas
  • Exemplos

Retornar todas as chaves de API da organização atribuídas ao seu projeto.

Para usar esse comando, você deve se autenticar com uma conta de usuário ou uma chave de API com a role de administrador do usuário do projeto.

Sintaxe do comando
atlas projects apiKeys list [options]
Nome
Tipo
Obrigatório
Descrição
-c, --compact
false
Sinalizador que habilita a estrutura de resposta de array compacta para uma saída JSON. A opção --compact retorna objetos de array como respostas de nível superior e permite a compatibilidade com versões anteriores para scripts baseados em versões anteriores do CLI. A omissão da opção --compact para uma saída JSON retorna objeto de array dentro de uma sub-array "resultados". Você deve especificar --output JSON para usar esta opção.
-h, --help
false
ajuda para lista
--limit
int
false
Número de itens por página de resultados, até um máximo de 500. Se você tiver mais de 500 resultados, especifique a opção --page para alterar a página de resultados. Este valor é padronizado para 100.
--omitCount
false
Sinalizador que indica se a resposta JSON retorna o número total de itens (totalCount) na resposta JSON.
-o, --output
string
false
Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON.
--page
int
false
Número da página que especifica uma página de resultados. Este valor é padronizado como 1.
--projectId
string
false
String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente.
Nome
Tipo
Obrigatório
Descrição
-P, --profile
string
false
Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
# Return a JSON-formatted list of organization API keys assigned to the project with ID 5e2211c17a3e5a48f5497de3:
atlas projects apiKeys list --projectId 5e1234c17a3e5a48f5497de3 --output json

Voltar

excluir