Creates a new API key. NOTE: Key is a global resource; hence the only supported value for location is global.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: apikeys2 --scope <scope> projects locations-keys-create ...

Required Scalar Argument

• <parent> (string)
  • Required. The project in which the API key is created.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

V2Key:
  annotations: { string: string }
  create-time: string
  delete-time: string
  display-name: string
  etag: string
  key-string: string
  name: string
  restrictions:
    browser-key-restrictions:
      allowed-referrers: [string]
    ios-key-restrictions:
      allowed-bundle-ids: [string]
    server-key-restrictions:
      allowed-ips: [string]
  uid: string
  update-time: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r . annotations=key=et
  • Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
  • the value will be associated with the given key
• create-time=magna
  • Output only. A timestamp identifying the time this key was originally created.
• delete-time=no
  • Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty.
• display-name=ipsum
  • Human-readable display name of this key that you can modify. The maximum length is 63 characters.
• etag=voluptua.
  • Output only. A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154.
• key-string=at
  • Output only. An encrypted and signed value held by this key. This field can be accessed only through the GetKeyString method.
• name=sanctus
  • Output only. The resource name of the key. The name has the form: projects//locations/global/keys/. For example: projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2 NOTE: Key is a global resource; hence the only supported value for location is global.

• restrictions.browser-key-restrictions allowed-referrers=sed

  • A list of regular expressions for the referrer URLs that are allowed to make API calls with this key.
  • Each invocation of this argument appends the given value to the array.

• ..ios-key-restrictions allowed-bundle-ids=amet.

  • A list of bundle IDs that are allowed when making API calls with this key.
  • Each invocation of this argument appends the given value to the array.

• ..server-key-restrictions allowed-ips=takimata

  • A list of the caller IP addresses that are allowed to make API calls with this key.
  • Each invocation of this argument appends the given value to the array.

• ... uid=amet.

  • Output only. Unique id in UUID4 format.
• update-time=duo
  • Output only. A timestamp identifying the time this key was last updated.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

• -p key-id=string
  • User specified key id (optional). If specified, it will become the final component of the key resource name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: [a-z]([a-z0-9-]{0,61}[a-z0-9])?. The id must NOT be a UUID-like string.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").