Gcp/apigeeregistry

@swamp/gcp/apigeeregistryv2026.10.13.1· 20d agoBEHAVIORS

01README

Google Cloud apigeeregistry infrastructure models

02Release Notes

Updated: locations, apis, apis_artifacts, apis_deployments, apis_deployments_artifacts, apis_versions, apis_versions_artifacts, apis_versions_specs, apis_versions_specs_artifacts, artifacts, instances

03Behaviors11

@swamp/gcp/apigeeregistry/apisv2026.10.13.1apis.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
annotations?	record	no	Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
availability?	string	no	A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".
description?	string	no	A detailed description.
displayName?	string	no	Human-meaningful name.
labels?	record	no	Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys
name?	string	no	Resource name.
recommendedDeployment?	string	no	The recommended deployment of the API. Format: `projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}`
recommendedVersion?	string	no	The recommended version of the API. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
apiId?	string	no	Required. The ID to use for the API, which will become the final component of the API's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a apis

fn get(identifier: string)

Get a apis

Argument	Type	Required	Description
identifier	string	yes	The name of the apis

fn update(identifier?: string)

Update apis attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific apis by name (e.g. one discovered by list)

fn delete(identifier: string)

Delete the apis

Argument	Type	Required	Description
identifier	string	yes	The name of the apis

fn sync(identifier?: string)

Sync apis state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific apis by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List apis resources

Argument	Type	Required	Description
filter?	string	no	An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.
orderBy?	string	no	A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
pageSize?	number	no	The maximum number of APIs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_iam_policy()

get iam policy

fn set_iam_policy(policy?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

Resources

state(infinite)— A top-level description of an API. Produced by producers and are commitments ...

@swamp/gcp/apigeeregistry/apis-artifactsv2026.10.13.1apis_artifacts.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
annotations?	record	no	Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
contents?	string	no	Input only. The contents of the artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents.
labels?	record	no	Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys a
mimeType?	string	no	A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible "schema" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").
name?	string	no	Resource name.
artifactId?	string	no	Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a artifacts

fn get(identifier: string)

Get a artifacts

Argument	Type	Required	Description
identifier	string	yes	The name of the artifacts

fn delete(identifier: string)

Delete the artifacts

Argument	Type	Required	Description
identifier	string	yes	The name of the artifacts

fn sync(identifier?: string)

Sync artifacts state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific artifacts by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List artifacts resources

Argument	Type	Required	Description
filter?	string	no	An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
orderBy?	string	no	A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
pageSize?	number	no	The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_contents()

get contents

fn get_iam_policy()

get iam policy

fn replace_artifact(annotations?: any, contents?: any, createTime?: any, hash?: any, labels?: any, mimeType?: any, name?: any, sizeBytes?: any, updateTime?: any)

replace artifact

Argument	Type	Required
annotations?	any	no
contents?	any	no
createTime?	any	no
hash?	any	no
labels?	any	no
mimeType?	any	no
name?	any	no
sizeBytes?	any	no
updateTime?	any	no

fn set_iam_policy(policy?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

Resources

state(infinite)— Artifacts of resources. Artifacts are unique (single-value) per resource and ...

@swamp/gcp/apigeeregistry/apis-deploymentsv2026.10.13.1apis_deployments.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
accessGuidance?	string	no	Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.
annotations?	record	no	Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
apiSpecRevision?	string	no	The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec@revision}`
description?	string	no	A detailed description.
displayName?	string	no	Human-meaningful name.
endpointUri?	string	no	The address where the deployment is serving. Changes to this value will update the revision.
externalChannelUri?	string	no	The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.
intendedAudience?	string	no	Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.
labels?	record	no	Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys a
name?	string	no	Resource name.
apiDeploymentId?	string	no	Required. The ID to use for the deployment, which will become the final component of the deployment's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a deployments

fn get(identifier: string)

Get a deployments

Argument	Type	Required	Description
identifier	string	yes	The name of the deployments

fn update(identifier?: string)

Update deployments attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific deployments by name (e.g. one discovered by list)

fn delete(identifier: string)

Delete the deployments

Argument	Type	Required	Description
identifier	string	yes	The name of the deployments

fn sync(identifier?: string)

Sync deployments state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific deployments by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List deployments resources

Argument	Type	Required	Description
filter?	string	no	An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.
orderBy?	string	no	A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
pageSize?	number	no	The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_iam_policy()

get iam policy

fn list_revisions()

list revisions

fn rollback(revisionId?: any)

rollback

Argument	Type	Required	Description
revisionId?	any	no

fn set_iam_policy(policy?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no

fn tag_revision(tag?: any)

tag revision

Argument	Type	Required	Description
tag?	any	no

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

Resources

state(infinite)— Describes a service running at particular address that provides a particular ...

@swamp/gcp/apigeeregistry/apis-deployments-artifactsv2026.10.13.1apis_deployments_artifacts.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
annotations?	record	no	Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
contents?	string	no	Input only. The contents of the artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents.
labels?	record	no	Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys a
mimeType?	string	no	A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible "schema" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").
name?	string	no	Resource name.
artifactId?	string	no	Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a artifacts

fn get(identifier: string)

Get a artifacts

Argument	Type	Required	Description
identifier	string	yes	The name of the artifacts

fn delete(identifier: string)

Delete the artifacts

Argument	Type	Required	Description
identifier	string	yes	The name of the artifacts

fn sync(identifier?: string)

Sync artifacts state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific artifacts by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List artifacts resources

Argument	Type	Required	Description
filter?	string	no	An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
orderBy?	string	no	A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
pageSize?	number	no	The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_contents()

get contents

fn replace_artifact(annotations?: any, contents?: any, createTime?: any, hash?: any, labels?: any, mimeType?: any, name?: any, sizeBytes?: any, updateTime?: any)

replace artifact

Argument	Type	Required
annotations?	any	no
contents?	any	no
createTime?	any	no
hash?	any	no
labels?	any	no
mimeType?	any	no
name?	any	no
sizeBytes?	any	no
updateTime?	any	no

Resources

state(infinite)— Artifacts of resources. Artifacts are unique (single-value) per resource and ...

@swamp/gcp/apigeeregistry/apis-versionsv2026.10.13.1apis_versions.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
annotations?	record	no	Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
description?	string	no	A detailed description.
displayName?	string	no	Human-meaningful name.
labels?	record	no	Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys a
name?	string	no	Resource name.
primarySpec?	string	no	The primary spec for this version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
state?	string	no	A user-definable description of the lifecycle phase of this API version. Format: free-form, but we expect single words that describe API maturity, e.g., "CONCEPT", "DESIGN", "DEVELOPMENT", "STAGING", "PRODUCTION", "DEPRECATED", "RETIRED".
apiVersionId?	string	no	Required. The ID to use for the version, which will become the final component of the version's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a versions

fn get(identifier: string)

Get a versions

Argument	Type	Required	Description
identifier	string	yes	The name of the versions

fn update(identifier?: string)

Update versions attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific versions by name (e.g. one discovered by list)

fn delete(identifier: string)

Delete the versions

Argument	Type	Required	Description
identifier	string	yes	The name of the versions

fn sync(identifier?: string)

Sync versions state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific versions by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List versions resources

Argument	Type	Required	Description
filter?	string	no	An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.
orderBy?	string	no	A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
pageSize?	number	no	The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_iam_policy()

get iam policy

fn set_iam_policy(policy?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

Resources

state(infinite)— Describes a particular version of an API. ApiVersions are what consumers actu...

@swamp/gcp/apigeeregistry/apis-versions-artifactsv2026.10.13.1apis_versions_artifacts.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
annotations?	record	no	Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
contents?	string	no	Input only. The contents of the artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents.
labels?	record	no	Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys a
mimeType?	string	no	A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible "schema" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").
name?	string	no	Resource name.
artifactId?	string	no	Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a artifacts

fn get(identifier: string)

Get a artifacts

Argument	Type	Required	Description
identifier	string	yes	The name of the artifacts

fn delete(identifier: string)

Delete the artifacts

Argument	Type	Required	Description
identifier	string	yes	The name of the artifacts

fn sync(identifier?: string)

Sync artifacts state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific artifacts by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List artifacts resources

Argument	Type	Required	Description
filter?	string	no	An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
orderBy?	string	no	A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
pageSize?	number	no	The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_contents()

get contents

fn get_iam_policy()

get iam policy

fn replace_artifact(annotations?: any, contents?: any, createTime?: any, hash?: any, labels?: any, mimeType?: any, name?: any, sizeBytes?: any, updateTime?: any)

replace artifact

Argument	Type	Required
annotations?	any	no
contents?	any	no
createTime?	any	no
hash?	any	no
labels?	any	no
mimeType?	any	no
name?	any	no
sizeBytes?	any	no
updateTime?	any	no

fn set_iam_policy(policy?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

Resources

state(infinite)— Artifacts of resources. Artifacts are unique (single-value) per resource and ...

@swamp/gcp/apigeeregistry/apis-versions-specsv2026.10.13.1apis_versions_specs.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
annotations?	record	no	Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
contents?	string	no	Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents.
description?	string	no	A detailed description.
filename?	string	no	A possibly-hierarchical name used to refer to the spec from other specs.
labels?	record	no	Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys a
mimeType?	string	no	A style (format) descriptor for this spec that is specified as a [Media Type](https://en.wikipedia.org/wiki/Media_type). Possible values include `application/vnd.apigee.proto`, `application/vnd.apigee.openapi`, and `application/vnd.apigee.graphql`, with possible suffixes representing compression types. These hypothetical names are defined in the vendor tree defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final. Content types can specify compression. Currently only GZip compr
name?	string	no	Resource name.
sourceUri?	string	no	The original source URI of the spec (if one exists). This is an external location that can be used for reference purposes but which may not be authoritative since this external resource may change after the spec is retrieved.
apiSpecId?	string	no	Required. The ID to use for the spec, which will become the final component of the spec's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a specs

fn get(identifier: string)

Get a specs

Argument	Type	Required	Description
identifier	string	yes	The name of the specs

fn update(identifier?: string)

Update specs attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific specs by name (e.g. one discovered by list)

fn delete(identifier: string)

Delete the specs

Argument	Type	Required	Description
identifier	string	yes	The name of the specs

fn sync(identifier?: string)

Sync specs state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific specs by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List specs resources

Argument	Type	Required	Description
filter?	string	no	An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
orderBy?	string	no	A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
pageSize?	number	no	The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_contents()

get contents

fn get_iam_policy()

get iam policy

fn list_revisions()

list revisions

fn rollback(revisionId?: any)

rollback

Argument	Type	Required	Description
revisionId?	any	no

fn set_iam_policy(policy?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no

fn tag_revision(tag?: any)

tag revision

Argument	Type	Required	Description
tag?	any	no

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

Resources

state(infinite)— Describes a version of an API in a structured way. ApiSpecs provide formal de...

@swamp/gcp/apigeeregistry/apis-versions-specs-artifactsv2026.10.13.1apis_versions_specs_artifacts.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
annotations?	record	no	Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
contents?	string	no	Input only. The contents of the artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents.
labels?	record	no	Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys a
mimeType?	string	no	A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible "schema" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").
name?	string	no	Resource name.
artifactId?	string	no	Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a artifacts

fn get(identifier: string)

Get a artifacts

Argument	Type	Required	Description
identifier	string	yes	The name of the artifacts

fn delete(identifier: string)

Delete the artifacts

Argument	Type	Required	Description
identifier	string	yes	The name of the artifacts

fn sync(identifier?: string)

Sync artifacts state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific artifacts by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List artifacts resources

Argument	Type	Required	Description
filter?	string	no	An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
orderBy?	string	no	A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
pageSize?	number	no	The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_contents()

get contents

fn get_iam_policy()

get iam policy

fn replace_artifact(annotations?: any, contents?: any, createTime?: any, hash?: any, labels?: any, mimeType?: any, name?: any, sizeBytes?: any, updateTime?: any)

replace artifact

Argument	Type	Required
annotations?	any	no
contents?	any	no
createTime?	any	no
hash?	any	no
labels?	any	no
mimeType?	any	no
name?	any	no
sizeBytes?	any	no
updateTime?	any	no

fn set_iam_policy(policy?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

Resources

state(infinite)— Artifacts of resources. Artifacts are unique (single-value) per resource and ...

@swamp/gcp/apigeeregistry/artifactsv2026.10.13.1artifacts.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
annotations?	record	no	Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
contents?	string	no	Input only. The contents of the artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents.
labels?	record	no	Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys a
mimeType?	string	no	A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible "schema" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").
name?	string	no	Resource name.
artifactId?	string	no	Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a artifacts

fn get(identifier: string)

Get a artifacts

Argument	Type	Required	Description
identifier	string	yes	The name of the artifacts

fn delete(identifier: string)

Delete the artifacts

Argument	Type	Required	Description
identifier	string	yes	The name of the artifacts

fn sync(identifier?: string)

Sync artifacts state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific artifacts by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List artifacts resources

Argument	Type	Required	Description
filter?	string	no	An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.
orderBy?	string	no	A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
pageSize?	number	no	The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_contents()

get contents

fn get_iam_policy()

get iam policy

fn replace_artifact(annotations?: any, contents?: any, createTime?: any, hash?: any, labels?: any, mimeType?: any, name?: any, sizeBytes?: any, updateTime?: any)

replace artifact

Argument	Type	Required
annotations?	any	no
contents?	any	no
createTime?	any	no
hash?	any	no
labels?	any	no
mimeType?	any	no
name?	any	no
sizeBytes?	any	no
updateTime?	any	no

fn set_iam_policy(policy?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

Resources

state(infinite)— Artifacts of resources. Artifacts are unique (single-value) per resource and ...

@swamp/gcp/apigeeregistry/instancesv2026.10.13.1instances.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
config?	object	no	Required. Config of the Instance.
name?	string	no	Format: `projects//locations//instance`. Currently only `locations/global` is supported.
instanceId?	string	no	Required. Identifier to assign to the Instance. Must be unique within scope of the parent resource.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a instances

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a instances

Argument	Type	Required	Description
identifier	string	yes	The name of the instances

fn delete(identifier: string)

Delete the instances

Argument	Type	Required	Description
identifier	string	yes	The name of the instances

fn sync(identifier?: string)

Sync instances state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific instances by name (e.g. one discovered by list)

fn get_iam_policy()

get iam policy

fn set_iam_policy(policy?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

Resources

state(infinite)— An Instance represents the instance resources of the Registry. Currently, onl...

@swamp/gcp/apigeeregistry/locationsv2026.10.13.1locations.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
name	string	yes	The resource that owns the locations collection, if applicable.

fn get(identifier: string)

Get a locations

Argument	Type	Required	Description
identifier	string	yes	The name of the locations

fn sync(identifier?: string)

Sync locations state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific locations by name (e.g. one discovered by list)

fn list(filter?: string, pageSize?: number, maxPages?: number)

List locations resources

Argument	Type	Required	Description
filter?	string	no	A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
pageSize?	number	no	The maximum number of results to return. If not set, the service selects a default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— A resource that represents a Google Cloud location.

04Previous Versions19

2026.08.12.2Aug 12, 2026

Updated: locations, apis, apis_artifacts, apis_deployments, apis_deployments_artifacts, apis_versions, apis_versions_artifacts, apis_versions_specs, apis_versions_specs_artifacts, artifacts, instances

2026.07.29.1Jul 30, 2026

Updated: locations, apis, apis_artifacts, apis_deployments, apis_deployments_artifacts, apis_versions, apis_versions_artifacts, apis_versions_specs, apis_versions_specs_artifacts, artifacts, instances

2026.07.21.3Jul 21, 2026

Updated: locations, apis, apis_artifacts, apis_deployments, apis_deployments_artifacts, apis_versions, apis_versions_artifacts, apis_versions_specs, apis_versions_specs_artifacts, artifacts, instances

2026.07.21.1Jul 21, 2026

Updated: instances

2026.07.20.1Jul 20, 2026

Updated: locations, apis, apis_artifacts, apis_deployments, apis_deployments_artifacts, apis_versions, apis_versions_artifacts, apis_versions_specs, apis_versions_specs_artifacts, artifacts, instances

2026.07.19.2Jul 19, 2026

Updated: locations

2026.07.19.1Jul 19, 2026

Updated: locations, apis, apis_artifacts, apis_deployments, apis_deployments_artifacts, apis_versions, apis_versions_artifacts, apis_versions_specs, apis_versions_specs_artifacts, artifacts, instances

2026.07.18.2Jul 18, 2026

Updated: locations, apis, apis_artifacts, apis_deployments, apis_deployments_artifacts, apis_versions, apis_versions_artifacts, apis_versions_specs, apis_versions_specs_artifacts, artifacts, instances

2026.07.17.2Jul 17, 2026

Updated: apis, apis_artifacts, apis_deployments, apis_deployments_artifacts, apis_versions, apis_versions_artifacts, apis_versions_specs, apis_versions_specs_artifacts, artifacts, instances

2026.07.17.1Jul 17, 2026

Updated: apis, apis_artifacts, apis_deployments, apis_deployments_artifacts, apis_versions, apis_versions_artifacts, apis_versions_specs, apis_versions_specs_artifacts, artifacts, instances

2026.06.08.2Jun 8, 2026

Updated: locations, apis, apis_artifacts, apis_deployments, apis_deployments_artifacts, apis_versions, apis_versions_artifacts, apis_versions_specs, apis_versions_specs_artifacts, artifacts, instances

2026.06.07.1Jun 7, 2026

Updated: locations, apis, apis_artifacts, apis_deployments, apis_deployments_artifacts, apis_versions, apis_versions_artifacts, apis_versions_specs, apis_versions_specs_artifacts, artifacts, instances

2026.05.25.1May 25, 2026

Updated: locations, apis, apis_artifacts, apis_deployments, apis_deployments_artifacts, apis_versions, apis_versions_artifacts, apis_versions_specs, apis_versions_specs_artifacts, artifacts, instances

Modified 10 behaviors

2026.05.24.1May 24, 2026

Updated: locations, apis, apis_artifacts, apis_deployments, apis_deployments_artifacts, apis_versions, apis_versions_artifacts, apis_versions_specs, apis_versions_specs_artifacts, artifacts, instances

2026.05.21.2May 21, 2026

Updated: locations, apis, apis_artifacts, apis_deployments, apis_deployments_artifacts, apis_versions, apis_versions_artifacts, apis_versions_specs, apis_versions_specs_artifacts, artifacts, instances

2026.05.21.1May 21, 2026

Modified 9 behaviors

2026.05.19.2May 19, 2026

2026.05.19.1May 19, 2026

2026.05.18.1May 18, 2026

05Stats

93 / 100

Downloads

Archive size

133.9 KB

Verified by Swamp

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit2/2earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License1/2partial
no SPDX license declared
Verified public repository2/2earned

Repository

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

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64 windows · x86_64

07Labels

#gcp #google-cloud #apigeeregistry #cloud #infrastructure