Listar os codespaces na sua organização

Você pode listar todos os codespaces atualmente ativos ou interrompidos para sua organização.

Quem pode usar esse recurso?

To list all of the current codespaces for your organization, you must be an organization owner.

As organizações com os planos do GitHub Team e do GitHub Enterprise podem pagar pelo uso de membros e colaboradores do GitHub Codespaces. Depois, essas organizações podem acessar configurações e políticas para gerenciar codespaces pagos pela organização. Para obter mais informações, confira "Como escolher quem tem a propriedade e paga pelos codespaces em sua organização" e "Planos do GitHub."

Visão geral

Como proprietário de uma organização, você pode listar todos os codespaces atualmente ativos ou interrompidos para sua organização. Talvez você queira fazer isso para verificar quantos codespaces os usuários estão criando, para garantir que eles não estejam incorrendo em custos desnecessários. Para saber mais sobre preço, confira Sobre o faturamento do GitHub Codespaces.

A maneira mais fácil de listar os codespaces para uma organização é usando GitHub CLI. Você também pode usar a API REST, que fornece mais informações sobre cada codespace.

Para obter informações de como ver o uso total atual do Codespaces na organização ou empresa e gerar um relatório detalhado, confira Como visualizar o uso do GitHub Codespaces.

Usar GitHub CLI para listar codespaces

Para listar todos os codespaces atuais de uma organização especificada, use o comando a seguir.

Shell
gh codespace list --org ORGANIZATION

Este comando retorna uma lista que inclui as seguintes informações para cada codespace:

  • O nome e o nome de exibição
  • O usuário que criou o codespace
  • O repositório e o branch
  • O estado atual do codespace

Para listar todos os codespaces atuais de uma organização que foram criados por um usuário específico, use o comando a seguir.

Shell
gh codespace list --org ORGANIZATION --user USER

Note

Nos comandos acima, substitua ORGANIZATION pelo nome da organização que você está consultando. Você precisa ser proprietário da organização.

Usar a API REST para listar codespaces

Você pode usar o ponto de extremidade da API /orgs/{org}/codespaces como um método alternativo para listar os codespaces atuais de uma organização. Isso retorna mais informações que GitHub CLI; por exemplo, os detalhes do tipo de computador.

Para obter mais informações sobre esse ponto de extremidade, confira Pontos de extremidade da API REST para organizações do Codespaces.