- Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de Atlas CLI.
Elimina la clave API de la organización especificada de tu proyecto.
Vista previa pública: El subcomando atlas api, generado automáticamente desde la API de administración de MongoDB Atlas, ofrece cobertura completa de la API de administración y se encuentra actualmente en vista previa pública (envíe sus comentarios en https://feedback.mongodb.com/forums/930808-atlas-cli). Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puede consultar a través del enlace de documentación del punto final de la API.
La clave API aún existe a nivel de organización. Para reasignar la clave API de organización a un proyecto, ejecute el comando atlas projects apiKeys assign.
Para ver los valores posibles para el argumento ID, ejecute atlas organisations apiKeys list.
Para utilizar este comando, debe autenticarse con una cuenta de usuario o una clave API con el rol de administrador de usuario del proyecto.
Sintaxis
atlas projects apiKeys delete <ID> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
ID | string | true | Cadena única de 24 dígitos que identifica su clave API. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--force | false | Bandera que indica si se debe omitir la solicitud de confirmación antes de continuar con la acción solicitada. | |
-h, --ayuda | false | ayuda para eliminar | |
--projectId | string | false | Cadena hexadecimal que identifica el proyecto que se utilizará. Esta opción anula la configuración del archivo de configuración o la variable de entorno. |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se usará en el archivo de configuración. Para obtener más información sobre los perfiles de la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Salida
Si el comando se ejecuta correctamente, la CLI devuelve un resultado similar al siguiente ejemplo. Los valores entre paréntesis representan sus valores.
API Key '<Name>' deleted
Ejemplos
# Remove an organization API key with the ID 5f46ae53d58b421fe3edc115 from the project with ID 5e2211c17a3e5a48f5497de3: atlas projects apiKeys delete 5f46ae53d58b421fe3edc115 --projectId 5e1234c17a3e5a48f5497de3