Skip to main content
← back to extensions

@swamp/gcp/apikeys

v2026.04.23.1

Google Cloud apikeys infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

gcpgoogle-cloudapikeyscloudinfrastructure

Contents

models

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/apikeys

@swamp/gcp/apikeys/keysv2026.04.23.1keys.ts

Global Arguments

ArgumentTypeDescription
annotations?recordAnnotations 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.
displayName?stringHuman-readable display name of this key that you can modify. The maximum length is 63 characters.
name?stringIdentifier. 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?objectDescribes the restrictions on the key.
serviceAccountEmail?stringOptional. The email address of [the service account](https://cloud.google.com/iam/docs/service-accounts) the key is bound to.
keyId?stringUser 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.
location?stringThe location for this resource (this resource only supports 'global')
createCreate a keys
getGet a keys
ArgumentTypeDescription
identifierstringThe name of the keys
updateUpdate keys attributes
deleteDelete the keys
ArgumentTypeDescription
identifierstringThe name of the keys
syncSync keys state from GCP
get_key_stringget key string
undeleteundelete

Resources

state(infinite)— The representation of a key managed by the API Keys API.