gcloud services api-keys describe Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud services api-keys describe - describe an API key's metadata
- SYNOPSIS
gcloud services api-keys describe(KEY:--location=LOCATION)[GCLOUD_WIDE_FLAG …]
- DESCRIPTION
- Describe an API key's metadata.
- EXAMPLES
- To describe an API key using Key:
gcloudservicesapi-keysdescribe1234ORgcloudservicesapi-keysdescribeprojects/myproject/locations/global/keys/1234To describe an API key with key and project:
gcloudservicesapi-keysdescribe1234--project=myprojectTo describe an API key with key, project, and location:
gcloudservicesapi-keysdescribe1234--project=myproject--location=global - POSITIONAL ARGUMENTS
- Key resource - The name of the key to describe. The arguments in this group canbe used to specify the attributes of this resource. (NOTE) Some attributes arenot given arguments in this group but can be set in other ways.
To set the
projectattribute:- provide the argument
keyon the command line with a fully specifiedname; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
KEY- ID of the key or fully qualified identifier for the key.
To set the
keyattribute:- provide the argument
keyon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--location=LOCATION- Location of the key.
To set the
locationattribute:- provide the argument
keyon the command line with a fully specifiedname; - provide the argument
--locationon the command line; - location will default to global.
- provide the argument
- provide the argument
- Key resource - The name of the key to describe. The arguments in this group canbe used to specify the attributes of this resource. (NOTE) Some attributes arenot given arguments in this group but can be set in other ways.
- GCLOUD WIDE FLAGS
- These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$gcloud helpfor details. - NOTES
- These variants are also available:
gcloudalphaservicesapi-keysdescribegcloudbetaservicesapi-keysdescribe
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.