Gcp/apigee

@swamp/gcp/apigeev2026.09.11.1· 1d agoMODELS

01README

Google Cloud apigee infrastructure models

02Release Notes

Updated: organizations

03Models76

analytics_datastores.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
datastoreConfig?	object	no	Name of the Cloud Storage bucket. Required for `gcs` target_type.
displayName?	string	no	Required. Display name in UI
targetType?	string	no	Destination storage type. Supported types `gcs` or `bigquery`.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a datastores

fn get(identifier: string)

Get a datastores

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

fn update(identifier?: string)

Update datastores attributes

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

fn delete(identifier: string)

Delete the datastores

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

fn sync(identifier?: string)

Sync datastores state from GCP

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

fn list(targetType?: string, maxPages?: number)

List datastores resources

Argument	Type	Required	Description
targetType?	string	no	Optional. TargetType is used to fetch all Datastores that match the type
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn test(createTime?: any, datastoreConfig?: any, displayName?: any, lastUpdateTime?: any, org?: any, self?: any, targetType?: any)

test

Argument	Type	Required
createTime?	any	no
datastoreConfig?	any	no
displayName?	any	no
lastUpdateTime?	any	no
org?	any	no
self?	any	no
targetType?	any	no

apimserviceextensions.tsv2026.09.07.1

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.
extensionProcessor?	string	no	Required. Name of the proxy deployed in the Apigee X instance.
extensions?	array	no	Optional. Whether this request should fail open.
lbForwardingRule?	string	no	Required. Name of the Google Cloud LB forwarding rule. Format: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule} projects/{project}/global/forwardingRules/{forwarding_rule}
name?	string	no	Identifier. unique name of the APIM service extension. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
network?	string	no	Required. The network where the forwarding rule is created. Format: projects/{project}/global/networks/{network}
networkConfigs?	array	no	Required. The region for the PSC NEG.
apimServiceExtensionId?	string	no	Optional. ID used to uniquely identify of the service extension. It must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
allowMissing?	string	no	Optional. If set to true, and the service extension is not found, a new service extension will be created. In this situation, `update_mask` is ignored.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create(waitForReady?: boolean)

Create a apimServiceExtensions

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 apimServiceExtensions

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

fn update(identifier?: string, waitForReady?: boolean)

Update apimServiceExtensions attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific apimServiceExtensions by name (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the apimServiceExtensions

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

fn sync(identifier?: string)

Sync apimServiceExtensions state from GCP

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

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

List apimServiceExtensions resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. Maximum number of items to return. If unspecified, at most 25 service extension will be returned.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

apiproducts.tsv2026.08.12.2

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.
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.
apiResources?	array	no	Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/*`: Indicates that all sub-URIs are included. - `/`: Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products.
approvalType?	string	no	Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in "pending" state. In this case, the API keys won\'t work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in "approved" state and can be used immediately. Note: Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities.
attributes?	array	no	API key of the attribute.
createdAt?	string	no	Response only. Creation time of this environment as milliseconds since epoch.
description?	string	no	Description of the API product. Include key information about the API product that is not captured by other fields.
displayName?	string	no	Name displayed in the UI or developer portal to developers registering for API access.
environments?	array	no	Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`.
graphqlOperationGroup?	object	no	Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product.
grpcOperationGroup?	object	no	Required. Name of the API proxy with which the gRPC operation and quota are associated.
lastModifiedAt?	string	no	Response only. Modified time of this environment as milliseconds since epoch.
llmOperationGroup?	object	no	Required. Name of the API proxy or remote service with which the resources, methods, and quota are associated.
llmQuota?	string	no	Optional. Number of LLM tokens permitted per app by this API product for the specified `llm_quota_interval` and `llm_quota_time_unit`. For example, an `llm_quota` of 50,000, for an `llm_quota_interval` of 12 and an `llm_quota_time_unit` of hours means 50,000 llm tokens are allowed to be used every 12 hours.
llmQuotaInterval?	string	no	Optional. Time interval over which the number of tokens from LLM responses is calculated.
llmQuotaTimeUnit?	string	no	Optional. Time unit defined for the `llm_quota_interval`. Valid values include `minute`, `hour`, `day`, or `month`.
name?	string	no	Internal name of the API product. Characters you can use in the name are restricted to: `A-Z0-9._\\-$ %`. Note: The internal name cannot be edited when updating the API product.
operationGroup?	object	no	Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product.
payloadOperationGroup?	object	no	Required. Name of the API proxy with which the payload operations and quota are associated.
proxies?	array	no	Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. Note: The API proxy names must already exist in the specified environment as they will be validated upon creation.
quota?	string	no	Number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours.
quotaCounterScope?	enum	no	Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself.
quotaInterval?	string	no	Time interval over which the number of request messages is calculated.
quotaTimeUnit?	string	no	Time unit defined for the `quotaInterval`. Valid values include `minute`, `hour`, `day`, or `month`.
scopes?	array	no	Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product.
space?	string	no	Optional. The resource ID of the parent Space. If not set, the parent resource will be the Organization. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a apiproducts

fn get(identifier: string)

Get a apiproducts

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

fn update(identifier?: string)

Update apiproducts attributes

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

fn delete(identifier: string)

Delete the apiproducts

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

fn sync(identifier?: string)

Sync apiproducts state from GCP

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

fn list(attributename?: string, attributevalue?: string, count?: string, expand?: boolean, space?: string, startKey?: string, maxPages?: number)

List apiproducts resources

Argument	Type	Required	Description
attributename?	string	no	Name of the attribute used to filter the search.
attributevalue?	string	no	Value of the attribute used to filter the search.
count?	string	no	Enter the number of API products you want returned in the API call. The limit is 1000.
expand?	boolean	no	Flag that specifies whether to expand the results. Set to `true` to get expanded details about each API.
space?	string	no	Optional. The Space to list API products for. When none provided, all the spaces the user has list access, will be used implicitly, and the same following rules will apply. Can be used in conjunction with start_key, expand and count for paginated response. Composite queries with attributename and attributevalue are not supported yet.
startKey?	string	no	Gets a list of API products starting with a specific API product in the list. For example, if you're returning 50 API products at a time (using the `count` query parameter), you can view products 50-99 by entering the name of the 50th API product in the first API (without using `startKey`). Product name is case sensitive.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn attributes(attribute?: any)

attributes

Argument	Type	Required	Description
attribute?	any	no

fn move(space?: any)

move

Argument	Type	Required	Description
space?	any	no

apiproducts_attributes.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn get(identifier: string)

Get a attributes

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

fn delete(identifier: string)

Delete the attributes

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

fn sync(identifier?: string)

Sync attributes state from GCP

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

fn list(maxPages?: number)

List attributes resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn update_api_product_attribute(name?: any, value?: any)

update api product attribute

Argument	Type	Required	Description
name?	any	no
value?	any	no

apiproducts_rateplans.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
apiproduct?	string	no	Name of the API product that the rate plan is associated with.
billingPeriod?	enum	no	Frequency at which the customer will be billed.
consumptionPricingRates?	array	no	Ending value of the range. Set to 0 or `null` for the last range of values.

fn create()

Create a rateplans

fn get(identifier: string)

Get a rateplans

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

fn update(identifier?: string)

Update rateplans attributes

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

fn delete(identifier: string)

Delete the rateplans

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

fn sync(identifier?: string)

Sync rateplans state from GCP

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

fn list(count?: number, expand?: boolean, orderBy?: string, startKey?: string, state?: string, maxPages?: number)

List rateplans resources

Argument	Type	Required	Description
count?	number	no	Number of rate plans to return in the API call. Use with the `startKey` parameter to provide more targeted filtering. The maximum limit is 1000. Defaults to 100.
expand?	boolean	no	Flag that specifies whether to expand the results. Set to `true` to get expanded details about each API. Defaults to `false`.
orderBy?	string	no	Name of the attribute used for sorting. Valid values include: * `name`: Name of the rate plan. * `state`: State of the rate plan (`DRAFT`, `PUBLISHED`). * `startTime`: Time when the rate plan becomes active. * `endTime`: Time when the rate plan expires. Note: Not supported by Apigee at this time.
startKey?	string	no	Name of the rate plan from which to start displaying the list of rate plans. If omitted, the list starts from the first item. For example, to view the rate plans from 51-150, set the value of `startKey` to the name of the 51st rate plan and set the value of `count` to 100.
state?	string	no	State of the rate plans (`DRAFT`, `PUBLISHED`) that you want to display.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

apis.tsv2026.08.12.2

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.
contentType?	string	no	The HTTP Content-Type header value specifying the content type of the body.
data?	string	no	The HTTP request/response body as raw binary.
extensions?	array	no	Application specific response metadata. Must be set in the first response for streaming APIs.
apiProxyType?	enum	no	Output only. The type of the API proxy.
labels?	record	no	User labels applied to this API Proxy.
latestRevisionId?	string	no	Output only. The id of the most recently created revision for this api proxy.
metaData?	object	no	Time at which the API proxy was created, in milliseconds since epoch.
name?	string	no	Output only. Name of the API proxy.
readOnly?	boolean	no	Output only. Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive.
revision?	array	no	Output only. List of revisions defined for the API proxy.
space?	string	no	Optional. The id of the space this proxy is associated with. Any IAM policies applied to the space will control access to this proxy. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
action?	string	no	Action to perform when importing an API proxy configuration bundle. Set this parameter to one of the following values: * `import` to import the API proxy configuration bundle. * `validate` to validate the API proxy configuration bundle without importing it.
validate?	string	no	Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

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(includeMetaData?: boolean, includeRevisions?: boolean, space?: string, maxPages?: number)

List apis resources

Argument	Type	Required	Description
includeMetaData?	boolean	no	Flag that specifies whether to include API proxy metadata in the response.
includeRevisions?	boolean	no	Flag that specifies whether to include a list of revisions in the response.
space?	string	no	Optional. The space ID to filter the list of proxies (optional). If unspecified, all proxies in the organization will be listed.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn move(space?: any)

move

Argument	Type	Required	Description
space?	any	no

apis_debugsessions.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn get(identifier: string)

Get a debugsessions

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

fn sync(identifier?: string)

Sync debugsessions state from GCP

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

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

List debugsessions resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. Maximum number of debug sessions to return. The page size defaults to 25.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

apis_deployments.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn get(identifier: string)

Get a 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(maxPages?: number)

List deployments resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

apis_keyvaluemaps.tsv2026.08.12.2

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.
encrypted?	boolean	no	Required. Flag that specifies whether entry values will be encrypted. This field is retained for backward compatibility and the value of encrypted will always be `true`. Apigee X and hybrid do not support unencrypted key value maps.
maskedValues?	boolean	no	Optional. Flag that specifies whether entry values will be masked when returned.
name?	string	no	Required. ID of the key value map.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a keyvaluemaps

fn get(identifier: string)

Get a keyvaluemaps

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

fn update(identifier?: string)

Update keyvaluemaps attributes

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

fn delete(identifier: string)

Delete the keyvaluemaps

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

fn sync(identifier?: string)

Sync keyvaluemaps state from GCP

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

apis_keyvaluemaps_entries.tsv2026.08.12.2

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	no	Resource URI that can be used to identify the scope of the key value map entries.
value?	string	no	Required. Data or payload that is being retrieved and associated with the unique key.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a entries

fn get(identifier: string)

Get a entries

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

fn update(identifier?: string)

Update entries attributes

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

fn delete(identifier: string)

Delete the entries

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

fn sync(identifier?: string)

Sync entries state from GCP

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

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

List entries resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. Maximum number of key value entries to return. If unspecified, at most 100 entries will be returned.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

apis_revisions.tsv2026.09.07.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.

fn get(identifier: string)

Get a revisions

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

fn delete(identifier: string)

Delete the revisions

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

fn sync(identifier?: string)

Sync revisions state from GCP

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

fn update_api_proxy_revision(contentType?: any, data?: any, extensions?: any, validate?: any)

update api proxy revision

Argument	Type	Required
contentType?	any	no
data?	any	no
extensions?	any	no
validate?	any	no

apis_revisions_deployments.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn get(identifier: string)

Get a 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(maxPages?: number)

List deployments resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

appgroups.tsv2026.09.07.1

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.
attributes?	array	no	API key of the attribute.
channelId?	string	no	channel identifier identifies the owner maintaing this grouping.
channelUri?	string	no	A reference to the associated storefront/marketplace.
displayName?	string	no	app group name displayed in the UI
email?	string	no	Optional. Email of the AppGroup.
name?	string	no	Immutable. Name of the AppGroup. Characters you can use in the name are restricted to: A-Z0-9._\\-$ %.
organization?	string	no	Immutable. the org the app group is created
status?	string	no	Valid values are `active` or `inactive`. Note that the status of the AppGroup should be updated via UpdateAppGroupRequest by setting the action as `active` or `inactive`.
action?	string	no	Activate or de-activate the AppGroup by setting the action as `active` or `inactive`. The `Content-Type` header must be set to `application/octet-stream`, with empty body.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a appgroups

fn get(identifier: string)

Get a appgroups

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

fn update(identifier?: string)

Update appgroups attributes

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

fn delete(identifier: string)

Delete the appgroups

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

fn sync(identifier?: string)

Sync appgroups state from GCP

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

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

List appgroups resources

Argument	Type	Required	Description
filter?	string	no	The filter expression to be used to get the list of AppGroups, where filtering can be done on status, channelId or channelUri of the app group. Examples: filter=status=active", filter=channelId=, filter=channelUri=
pageSize?	number	no	Count of AppGroups a single page can have in the response. If unspecified, at most 1000 AppGroups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_balance()

get balance

fn get_monetization_config()

get monetization config

fn update_monetization_config(billingType?: any)

update monetization config

Argument	Type	Required	Description
billingType?	any	no

appgroups_apps.tsv2026.09.07.1

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.
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.
apiProducts?	array	no	List of API products associated with the AppGroup app.
appGroup?	string	no	Immutable. Name of the parent AppGroup whose resource name format is of syntax (organizations//appgroups/).
appId?	string	no	Immutable. ID of the AppGroup app.
attributes?	array	no	API key of the attribute.
callbackUrl?	string	no	Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to AppGroup apps.
keyExpiresIn?	string	no	Immutable. Expiration time, in seconds, for the consumer key that is generated for the AppGroup app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set.
name?	string	no	Immutable. Name of the AppGroup app whose resource name format is of syntax (organizations//appgroups//apps/*).
scopes?	array	no	Scopes to apply to the AppGroup app. The specified scopes must already exist for the API product that you associate with the AppGroup app.
status?	string	no	Status of the App. Valid values include `approved` or `revoked`.
action?	string	no	Approve or revoke the consumer key by setting this value to `approve` or `revoke`. The `Content-Type` header must be set to `application/octet-stream`, with empty body.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a apps

fn get(identifier: string)

Get a apps

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

fn update(identifier?: string)

Update apps attributes

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

fn delete(identifier: string)

Delete the apps

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

fn sync(identifier?: string)

Sync apps state from GCP

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

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

List apps resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. Maximum number entries to return. If unspecified, at most 1000 entries will be returned.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

appgroups_apps_keys.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
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.
attributes?	array	no	API key of the attribute.
consumerKey?	string	no	Immutable. Consumer key.
consumerSecret?	string	no	Secret key.
expiresInSeconds?	string	no	Immutable. Expiration time, in seconds, for the consumer key. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set.
scopes?	array	no	Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.
status?	string	no	Status of the credential. Valid values include `approved` or `revoked`.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a keys

fn get(identifier: string)

Get a keys

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

fn delete(identifier: string)

Delete the keys

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

fn sync(identifier?: string)

Sync keys state from GCP

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

fn update_app_group_app_key(action?: any, apiProducts?: any, appGroupAppKey?: any)

update app group app key

Argument	Type	Required
action?	any	no
apiProducts?	any	no
appGroupAppKey?	any	no

appgroups_subscriptions.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
apiproduct?	string	no	Required. Name of the API product for which the appgroup is purchasing a subscription.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a subscriptions

fn get(identifier: string)

Get a subscriptions

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

fn sync(identifier?: string)

Sync subscriptions state from GCP

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

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

List subscriptions resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 100 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn expire()

expire

apps.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn get(identifier: string)

Get a apps

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

fn sync(identifier?: string)

Sync apps state from GCP

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

fn list(apiProduct?: string, apptype?: string, expand?: boolean, filter?: string, ids?: string, includeCred?: boolean, keyStatus?: string, pageSize?: number, rows?: string, startKey?: string, status?: string, maxPages?: number)

List apps resources

Argument	Type	Required	Description
apiProduct?	string	no	API product.
apptype?	string	no	Optional. 'apptype' is no longer available. Use a 'filter' instead.
expand?	boolean	no	Optional. Flag that specifies whether to return an expanded list of apps for the organization. Defaults to `false`.
filter?	string	no	Optional. The filter expression to be used to get the list of apps, where filtering can be done on developerEmail, apiProduct, consumerKey, status, appId, appName, appType and appGroup. Examples: "developerEmail=foo@bar.com", "appType=AppGroup", or "appType=Developer" "filter" is supported from ver 1.10.0 and above.
ids?	string	no	Optional. Comma-separated list of app IDs on which to filter.
includeCred?	boolean	no	Optional. Flag that specifies whether to include credentials in the response.
keyStatus?	string	no	Optional. Key status of the app. Valid values include `approved` or `revoked`. Defaults to `approved`.
pageSize?	number	no	Optional. Count of apps a single page can have in the response. If unspecified, at most 1000 apps will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. "page_size" is supported from ver 1.10.0 and above.
rows?	string	no	Optional. Maximum number of app IDs to return. Defaults to 1000, which is also the upper limit. To get more than 1000, use pagination with 'pageSize' and 'pageToken' parameters.
startKey?	string	no	Returns the list of apps starting from the specified app ID.
status?	string	no	Optional. Filter by the status of the app. Valid values are `approved` or `revoked`. Defaults to `approved`.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

datacollectors.tsv2026.08.12.2

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.
description?	string	no	A description of the data collector.
name?	string	no	ID of the data collector. Must begin with `dc_`.
type?	enum	no	Immutable. The type of data this data collector will collect.
dataCollectorId?	string	no	ID of the data collector. Overrides any ID in the data collector resource. Must be a string beginning with `dc_` that contains only letters, numbers, and underscores.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a datacollectors

fn get(identifier: string)

Get a datacollectors

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

fn update(identifier?: string)

Update datacollectors attributes

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

fn delete(identifier: string)

Delete the datacollectors

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

fn sync(identifier?: string)

Sync datacollectors state from GCP

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

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

List datacollectors resources

Argument	Type	Required	Description
pageSize?	number	no	Maximum number of data collectors to return. The page size defaults to 25.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

deployments.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn get(identifier: string)

Get a 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(sharedFlows?: boolean, maxPages?: number)

List deployments resources

Argument	Type	Required	Description
sharedFlows?	boolean	no	Optional. Flag that specifies whether to return shared flow or API proxy deployments. Set to `true` to return shared flow deployments; set to `false` to return API proxy deployments. Defaults to `false`.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

developers.tsv2026.09.07.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
accessType?	string	no	Access type.
appFamily?	string	no	Developer app family.
apps?	array	no	List of apps associated with the developer.
attributes?	array	no	API key of the attribute.
companies?	array	no	List of companies associated with the developer.
developerId?	string	no	ID of the developer. Note: IDs are generated internally by Apigee and are not guaranteed to stay the same over time.
email?	string	no	Required. Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid. Note that the email address has to be in lowercase only.
firstName?	string	no	Required. First name of the developer.
lastName?	string	no	Required. Last name of the developer.
userName?	string	no	Required. User name of the developer. Not used by Apigee hybrid.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a developers

fn get(identifier: string)

Get a developers

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

fn update(identifier?: string)

Update developers attributes

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

fn delete(identifier: string)

Delete the developers

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

fn sync(identifier?: string)

Sync developers state from GCP

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

fn list(app?: string, count?: string, expand?: boolean, ids?: string, includeCompany?: boolean, startKey?: string, maxPages?: number)

List developers resources

Argument	Type	Required	Description
app?	string	no	Optional. List only Developers that are associated with the app. Note that start_key, count are not applicable for this filter criteria.
count?	string	no	Optional. Number of developers to return in the API call. Use with the `startKey` parameter to provide more targeted filtering. The limit is 1000.
expand?	boolean	no	Specifies whether to expand the results. Set to `true` to expand the results. This query parameter is not valid if you use the `count` or `startKey` query parameters.
ids?	string	no	Optional. List of IDs to include, separated by commas.
includeCompany?	boolean	no	Flag that specifies whether to include company details in the response.
startKey?	string	no	Note: Must be used in conjunction with the `count` parameter. Email address of the developer from which to start displaying the list of developers. For example, if the an unfiltered list returns: ``` westley@example.com fezzik@example.com buttercup@example.com ``` and your `startKey` is `fezzik@example.com`, the list returned will be ``` fezzik@example.com buttercup@example.com ```
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn attributes(attribute?: any)

attributes

Argument	Type	Required	Description
attribute?	any	no

fn get_balance()

get balance

fn get_monetization_config()

get monetization config

fn set_developer_status(action?: any)

set developer status

Argument	Type	Required	Description
action?	any	no

fn update_monetization_config(billingType?: any)

update monetization config

Argument	Type	Required	Description
billingType?	any	no

developers_apps.tsv2026.09.07.1

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.
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.
apiProducts?	array	no	List of API products associated with the developer app.
appFamily?	string	no	Developer app family.
appId?	string	no	ID of the developer app. This ID is not user specified but is automatically generated on app creation. appId is a UUID.
attributes?	array	no	API key of the attribute.
callbackUrl?	string	no	Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.
developerId?	string	no	ID of the developer.
keyExpiresIn?	string	no	Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set.
name?	string	no	Name of the developer app.
scopes?	array	no	Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
status?	string	no	Status of the credential. Valid values include `approved` or `revoked`.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a apps

fn get(identifier: string)

Get a apps

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

fn update(identifier?: string)

Update apps attributes

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

fn delete(identifier: string)

Delete the apps

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

fn sync(identifier?: string)

Sync apps state from GCP

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

fn list(count?: string, expand?: boolean, shallowExpand?: boolean, startKey?: string, maxPages?: number)

List apps resources

Argument	Type	Required	Description
count?	string	no	Number of developer apps to return in the API call. Use with the `startKey` parameter to provide more targeted filtering. The limit is 1000.
expand?	boolean	no	Optional. Specifies whether to expand the results. Set to `true` to expand the results. This query parameter is not valid if you use the `count` or `startKey` query parameters. Note: If set to `true`, the `apigee.developerapps.get` permission is required.
shallowExpand?	boolean	no	Optional. Specifies whether to expand the results in shallow mode. Set to `true` to expand the results in shallow mode. Note: If set to `true`, the `apigee.developerapps.get` permission is required.
startKey?	string	no	Note: Must be used in conjunction with the `count` parameter. Name of the developer app from which to start displaying the list of developer apps. For example, if you're returning 50 developer apps at a time (using the `count` query parameter), you can view developer apps 50-99 by entering the name of the 50th developer app. The developer app name is case sensitive.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn attributes(attribute?: any)

attributes

Argument	Type	Required	Description
attribute?	any	no

fn generate_key_pair_or_update_developer_app_status(apiProducts?: any, appFamily?: any, appId?: any, attributes?: any, callbackUrl?: any, createdAt?: any, credentials?: any, developerId?: any, keyExpiresIn?: any, lastModifiedAt?: any, name?: any, scopes?: any, status?: any, action?: any)

generate key pair or update developer app status

Argument	Type	Required
apiProducts?	any	no
appFamily?	any	no
appId?	any	no
attributes?	any	no
callbackUrl?	any	no
createdAt?	any	no
credentials?	any	no
developerId?	any	no
keyExpiresIn?	any	no
lastModifiedAt?	any	no
name?	any	no
scopes?	any	no
status?	any	no
action?	any	no

developers_apps_attributes.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn get(identifier: string)

Get a attributes

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

fn delete(identifier: string)

Delete the attributes

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

fn sync(identifier?: string)

Sync attributes state from GCP

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

fn list(maxPages?: number)

List attributes resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn update_developer_app_attribute(name?: any, value?: any)

update developer app attribute

Argument	Type	Required	Description
name?	any	no
value?	any	no

developers_apps_keys.tsv2026.09.07.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
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.
apiProducts?	array	no	List of API products for which the credential can be used. Note: Do not specify the list of API products when creating a consumer key and secret for a developer app. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created.
attributes?	array	no	API key of the attribute.
consumerKey?	string	no	Consumer key.
consumerSecret?	string	no	Secret key.
expiresAt?	string	no	Time the developer app expires in milliseconds since epoch.
expiresInSeconds?	string	no	Input only. Expiration time, in seconds, for the consumer key. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set.
issuedAt?	string	no	Time the developer app was created in milliseconds since epoch.
scopes?	array	no	Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.
status?	string	no	Status of the credential. Valid values include `approved` or `revoked`.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a keys

fn get(identifier: string)

Get a keys

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

fn delete(identifier: string)

Delete the keys

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

fn sync(identifier?: string)

Sync keys state from GCP

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

fn replace_developer_app_key(apiProducts?: any, attributes?: any, consumerKey?: any, consumerSecret?: any, expiresAt?: any, expiresInSeconds?: any, issuedAt?: any, scopes?: any, status?: any)

replace developer app key

Argument	Type	Required
apiProducts?	any	no
attributes?	any	no
consumerKey?	any	no
consumerSecret?	any	no
expiresAt?	any	no
expiresInSeconds?	any	no
issuedAt?	any	no
scopes?	any	no
status?	any	no

fn update_developer_app_key(apiProducts?: any, attributes?: any, consumerKey?: any, consumerSecret?: any, expiresAt?: any, expiresInSeconds?: any, issuedAt?: any, scopes?: any, status?: any, action?: any)

update developer app key

Argument	Type	Required
apiProducts?	any	no
attributes?	any	no
consumerKey?	any	no
consumerSecret?	any	no
expiresAt?	any	no
expiresInSeconds?	any	no
issuedAt?	any	no
scopes?	any	no
status?	any	no
action?	any	no

developers_attributes.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn get(identifier: string)

Get a attributes

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

fn delete(identifier: string)

Delete the attributes

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

fn sync(identifier?: string)

Sync attributes state from GCP

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

fn list(maxPages?: number)

List attributes resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn update_developer_attribute(name?: any, value?: any)

update developer attribute

Argument	Type	Required	Description
name?	any	no
value?	any	no

developers_subscriptions.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
apiproduct?	string	no	Name of the API product for which the developer is purchasing a subscription.
endTime?	string	no	Time when the API product subscription ends in milliseconds since epoch.
startTime?	string	no	Time when the API product subscription starts in milliseconds since epoch.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a subscriptions

fn get(identifier: string)

Get a subscriptions

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

fn sync(identifier?: string)

Sync subscriptions state from GCP

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

fn list(count?: number, startKey?: string, maxPages?: number)

List subscriptions resources

Argument	Type	Required	Description
count?	number	no	Number of API product subscriptions to return in the API call. Use with `startKey` to provide more targeted filtering. Defaults to 100. The maximum limit is 1000.
startKey?	string	no	Name of the API product subscription from which to start displaying the list of subscriptions. If omitted, the list starts from the first item. For example, to view the API product subscriptions from 51-150, set the value of `startKey` to the name of the 51st subscription and set the value of `count` to 100.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn expire()

expire

dnszones.tsv2026.08.12.2

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.
description?	string	no	Required. Description of the resource. String of at most 1024 characters associated with this resource for the user's convenience.
domain?	string	no	Required. The domain name for hosts in this private zone, for instance "example.com.".
name?	string	no	Identifier. Unique name for the resource. Defined by the server Format: "organizations/{organization}/dnsZones/{dns_zone}".
peeringConfig?	object	no	Required. The VPC network where the records for that private DNS zone's namespace are available. Apigee will be performing DNS peering with this VPC network.
dnsZoneId?	string	no	Required. User assigned ID for this resource. Must be unique within the organization. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create(waitForReady?: boolean)

Create a dnsZones

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 dnsZones

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

fn delete(identifier: string)

Delete the dnsZones

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

fn sync(identifier?: string)

Sync dnsZones state from GCP

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

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

List dnsZones resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. Maximum number of DNS zones to return. If unspecified, at most 25 DNS zones will be returned.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

endpointattachments.tsv2026.08.12.2

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.
location?	string	no	Required. Location of the endpoint attachment.
name?	string	no	Name of the endpoint attachment. Use the following structure in your request: `organizations/{org}/endpointAttachments/{endpoint_attachment}`
serviceAttachment?	string	no	Format: projects//regions//serviceAttachments/*
endpointAttachmentId?	string	no	ID to use for the endpoint attachment. ID must start with a lowercase letter followed by up to 31 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. The minimum length is 2.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create(waitForReady?: boolean)

Create a endpointAttachments

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 endpointAttachments

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

fn delete(identifier: string)

Delete the endpointAttachments

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

fn sync(identifier?: string)

Sync endpointAttachments state from GCP

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

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

List endpointAttachments resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. Maximum number of endpoint attachments to return. If unspecified, at most 25 attachments will be returned.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

envgroups.tsv2026.09.07.1

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.
hostnames?	array	no	Required. Host names for this environment group.
name?	string	no	ID of the environment group.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create(waitForReady?: boolean)

Create a envgroups

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 envgroups

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

fn update(identifier?: string, waitForReady?: boolean)

Update envgroups attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific envgroups by name (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the envgroups

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

fn sync(identifier?: string)

Sync envgroups state from GCP

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

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

List envgroups resources

Argument	Type	Required	Description
pageSize?	number	no	Maximum number of environment groups to return. The page size defaults to 25.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_deployed_ingress_config(view?: any)

get deployed ingress config

Argument	Type	Required	Description
view?	any	no

envgroups_attachments.tsv2026.08.12.2

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.
environment?	string	no	Required. ID of the attached environment.
name?	string	no	ID of the environment group attachment.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a attachments

fn get(identifier: string)

Get a attachments

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

fn delete(identifier: string)

Delete the attachments

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

fn sync(identifier?: string)

Sync attachments state from GCP

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

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

List attachments resources

Argument	Type	Required	Description
pageSize?	number	no	Maximum number of environment group attachments to return. The page size defaults to 25.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

environments.tsv2026.09.07.2

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.
apiProxyType?	enum	no	Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
clientIpResolutionConfig?	object	no	Required. The index of the ip in the header. Positive indices 0, 1, 2, 3 chooses indices from the left (first ips) Negative indices -1, -2, -3 chooses indices from the right (last ips)
deploymentType?	enum	no	Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a [subset of actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers
description?	string	no	Optional. Description of the environment.
displayName?	string	no	Optional. Display name for this environment.
forwardProxyUri?	string	no	Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the only supported scheme is "http". The port must be supplied. To remove a forward proxy setting, update the field to an empty value. Note: At this time, PUT operations to add forwardProxyUri to an existing environment fail if the environment has nodeConfig set up. To successfully add the forwardProxyUri setting in this case, include the NodeConfig details with the request.
hasAttachedFlowHooks?	boolean	no
name?	string	no	Required. Name of the environment. Values must match the regular expression `^[.\\\\p{Alnum}-_]{1,255}$`
nodeConfig?	object	no	Output only. The current total number of gateway nodes that each environment currently has across all instances.
properties?	object	no	The property key
type?	enum	no	Optional. EnvironmentType selected for the environment.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create(waitForReady?: boolean)

Create a environments

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 environments

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

fn update(identifier?: string, waitForReady?: boolean)

Update environments attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific environments by name (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the environments

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

fn sync(identifier?: string)

Sync environments state from GCP

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

fn get_addons_config()

get addons config

fn get_api_security_runtime_config()

get api security runtime config

fn get_debugmask()

get debugmask

fn get_deployed_config()

get deployed config

fn get_iam_policy(options_requestedPolicyVersion?: any)

get iam policy

Argument	Type	Required	Description
options_requestedPolicyVersion?	any	no

fn get_security_actions_config()

get security actions config

fn get_trace_config()

get trace config

fn modify_environment(apiProxyType?: any, clientIpResolutionConfig?: any, createdAt?: any, deploymentType?: any, description?: any, displayName?: any, forwardProxyUri?: any, hasAttachedFlowHooks?: any, lastModifiedAt?: any, name?: any, nodeConfig?: any, properties?: any, state?: any, type?: any, updateMask?: any)

modify environment

Argument	Type	Required
apiProxyType?	any	no
clientIpResolutionConfig?	any	no
createdAt?	any	no
deploymentType?	any	no
description?	any	no
displayName?	any	no
forwardProxyUri?	any	no
hasAttachedFlowHooks?	any	no
lastModifiedAt?	any	no
name?	any	no
nodeConfig?	any	no
properties?	any	no
state?	any	no
type?	any	no
updateMask?	any	no

fn set_iam_policy(policy?: any, updateMask?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no
updateMask?	any	no

fn subscribe()

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

fn unsubscribe(name?: any)

unsubscribe

Argument	Type	Required	Description
name?	any	no

fn update_debugmask(faultJSONPaths?: any, faultXPaths?: any, name?: any, namespaces?: any, requestJSONPaths?: any, requestXPaths?: any, responseJSONPaths?: any, responseXPaths?: any, variables?: any, replaceRepeatedFields?: any, updateMask?: any)

update debugmask

Argument	Type	Required
faultJSONPaths?	any	no
faultXPaths?	any	no
name?	any	no
namespaces?	any	no
requestJSONPaths?	any	no
requestXPaths?	any	no
responseJSONPaths?	any	no
responseXPaths?	any	no
variables?	any	no
replaceRepeatedFields?	any	no
updateMask?	any	no

fn update_environment(apiProxyType?: any, clientIpResolutionConfig?: any, createdAt?: any, deploymentType?: any, description?: any, displayName?: any, forwardProxyUri?: any, hasAttachedFlowHooks?: any, lastModifiedAt?: any, name?: any, nodeConfig?: any, properties?: any, state?: any, type?: any)

update environment

Argument	Type	Required
apiProxyType?	any	no
clientIpResolutionConfig?	any	no
createdAt?	any	no
deploymentType?	any	no
description?	any	no
displayName?	any	no
forwardProxyUri?	any	no
hasAttachedFlowHooks?	any	no
lastModifiedAt?	any	no
name?	any	no
nodeConfig?	any	no
properties?	any	no
state?	any	no
type?	any	no

fn update_security_actions_config(enabled?: any, name?: any, updateTime?: any, updateMask?: any)

update security actions config

Argument	Type	Required
enabled?	any	no
name?	any	no
updateTime?	any	no
updateMask?	any	no

fn update_trace_config(endpoint?: any, exporter?: any, mtlsConfig?: any, otelCollectorSecurityScheme?: any, samplingConfig?: any, spanSemantics?: any, traceProtocol?: any, updateMask?: any)

update trace config

Argument	Type	Required
endpoint?	any	no
exporter?	any	no
mtlsConfig?	any	no
otelCollectorSecurityScheme?	any	no
samplingConfig?	any	no
spanSemantics?	any	no
traceProtocol?	any	no
updateMask?	any	no

environments_analytics_exports.tsv2026.08.12.2

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.
csvDelimiter?	string	no	Optional. Delimiter used in the CSV file, if `outputFormat` is set to `csv`. Defaults to the `,` (comma) character. Supported delimiter characters include comma (`,`), pipe (`\|`), and tab (`\\t`).
datastoreName?	string	no	Required. Name of the preconfigured datastore.
dateRange?	object	no	Required. End date (exclusive) of the data to export in the format `yyyy-mm-dd`. The date range ends at 00:00:00 UTC on the end date- which will not be in the output.
description?	string	no	Optional. Description of the export job.
name?	string	no	Required. Display name of the export job.
outputFormat?	string	no	Optional. Output format of the export. Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the delimiter for CSV output using the `csvDelimiter` property.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a exports

fn get(identifier: string)

Get a exports

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

fn sync(identifier?: string)

Sync exports state from GCP

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

fn list(maxPages?: number)

List exports resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

environments_apis_deployments.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn get(identifier: string)

Get a 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(maxPages?: number)

List deployments resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

environments_apis_revisions_debugsessions.tsv2026.08.12.2

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.
count?	number	no	Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.
filter?	string	no	Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition.
name?	string	no	A unique ID for this DebugSession.
timeout?	string	no	Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided.
tracesize?	number	no	Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.
validity?	number	no	Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a debugsessions

fn get(identifier: string)

Get a debugsessions

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

fn delete(identifier: string)

Delete the debugsessions

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

fn sync(identifier?: string)

Sync debugsessions state from GCP

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

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

List debugsessions resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. Maximum number of debug sessions to return. The page size defaults to 25.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

environments_apis_revisions_debugsessions_data.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.

fn get(identifier: string)

Get a data

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

fn sync(identifier?: string)

Sync data state from GCP

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

environments_archivedeployments.tsv2026.08.12.2

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.
gcsUri?	string	no	Input only. The Google Cloud Storage signed URL returned from GenerateUploadUrl and used to upload the Archive zip file.
labels?	record	no	User-supplied key-value pairs used to organize ArchiveDeployments. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62} Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63} No more than 64 labels can be associated with a given store.
name?	string	no	Name of the Archive Deployment in the following format: `organizations/{org}/environments/{env}/archiveDeployments/{id}`.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a archiveDeployments

fn get(identifier: string)

Get a archiveDeployments

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

fn update(identifier?: string)

Update archiveDeployments attributes

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

fn delete(identifier: string)

Delete the archiveDeployments

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

fn sync(identifier?: string)

Sync archiveDeployments state from GCP

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

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

List archiveDeployments resources

Argument	Type	Required	Description
filter?	string	no	Optional. An optional query used to return a subset of Archive Deployments using the semantics defined in https://google.aip.dev/160.
pageSize?	number	no	Optional. Maximum number of Archive Deployments to return. If unspecified, at most 25 deployments will be returned.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn generate_download_url()

generate download url

fn generate_upload_url()

generate upload url

environments_deployments.tsv2026.09.07.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn get(identifier: string)

Get a 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(sharedFlows?: boolean, maxPages?: number)

List deployments resources

Argument	Type	Required	Description
sharedFlows?	boolean	no	Optional. Flag that specifies whether to return shared flow or API proxy deployments. Set to `true` to return shared flow deployments; set to `false` to return API proxy deployments. Defaults to `false`.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_iam_policy(options_requestedPolicyVersion?: any)

get iam policy

Argument	Type	Required	Description
options_requestedPolicyVersion?	any	no

fn set_iam_policy(policy?: any, updateMask?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no
updateMask?	any	no

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

environments_flowhooks.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.

fn get(identifier: string)

Get a flowhooks

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

fn sync(identifier?: string)

Sync flowhooks state from GCP

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

fn attach_shared_flow_to_flow_hook(continueOnError?: any, description?: any, flowHookPoint?: any, sharedFlow?: any)

attach shared flow to flow hook

Argument	Type	Required
continueOnError?	any	no
description?	any	no
flowHookPoint?	any	no
sharedFlow?	any	no

fn detach_shared_flow_from_flow_hook()

detach shared flow from flow hook

environments_keystores.tsv2026.08.12.2

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	no	Required. Resource ID for this keystore. Values must match the regular expression `[\\w[:space:].-]{1,255}`.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a keystores

fn get(identifier: string)

Get a keystores

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

fn delete(identifier: string)

Delete the keystores

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

fn sync(identifier?: string)

Sync keystores state from GCP

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

environments_keystores_aliases.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
contentType?	string	no	The HTTP Content-Type header value specifying the content type of the body.
data?	string	no	The HTTP request/response body as raw binary.
extensions?	array	no	Application specific response metadata. Must be set in the first response for streaming APIs.
_password?	string	no	DEPRECATED: For improved security, specify the password in the request body instead of using the query parameter. To specify the password in the request body, set `Content-type: multipart/form-data` part with name `password`. Password for the private key file, if required.
alias?	string	no	Alias for the key/certificate pair. Values must match the regular expression `[\\w\\s-.]{1,255}`. This must be provided for all formats except `selfsignedcert`; self-signed certs may specify the alias in either this parameter or the JSON body.
format?	string	no	Required. Format of the data. Valid values include: `selfsignedcert`, `keycertfile`, or `pkcs12`
ignoreExpiryValidation?	string	no	Flag that specifies whether to ignore expiry validation. If set to `true`, no expiry validation will be performed.
ignoreNewlineValidation?	string	no	Flag that specifies whether to ignore newline validation. If set to `true`, no error is thrown when the file contains a certificate chain with no newline between each certificate. Defaults to `false`.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a aliases

fn get(identifier: string)

Get a aliases

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

fn update(identifier?: string)

Update aliases attributes

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

fn delete(identifier: string)

Delete the aliases

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

fn sync(identifier?: string)

Sync aliases state from GCP

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

fn csr()

csr

fn get_certificate()

get certificate

environments_keyvaluemaps.tsv2026.08.12.2

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.
encrypted?	boolean	no	Required. Flag that specifies whether entry values will be encrypted. This field is retained for backward compatibility and the value of encrypted will always be `true`. Apigee X and hybrid do not support unencrypted key value maps.
maskedValues?	boolean	no	Optional. Flag that specifies whether entry values will be masked when returned.
name?	string	no	Required. ID of the key value map.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a keyvaluemaps

fn get(identifier: string)

Get a keyvaluemaps

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

fn update(identifier?: string)

Update keyvaluemaps attributes

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

fn delete(identifier: string)

Delete the keyvaluemaps

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

fn sync(identifier?: string)

Sync keyvaluemaps state from GCP

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

environments_keyvaluemaps_entries.tsv2026.08.12.2

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	no	Resource URI that can be used to identify the scope of the key value map entries.
value?	string	no	Required. Data or payload that is being retrieved and associated with the unique key.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a entries

fn get(identifier: string)

Get a entries

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

fn update(identifier?: string)

Update entries attributes

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

fn delete(identifier: string)

Delete the entries

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

fn sync(identifier?: string)

Sync entries state from GCP

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

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

List entries resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. Maximum number of key value entries to return. If unspecified, at most 100 entries will be returned.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

environments_optimizedstats.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.

fn get(identifier: string)

Get a optimizedStats

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

fn sync(identifier?: string)

Sync optimizedStats state from GCP

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

environments_queries.tsv2026.08.12.2

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.
csvDelimiter?	string	no	Delimiter used in the CSV file, if `outputFormat` is set to `csv`. Defaults to the `,` (comma) character. Supported delimiter characters include comma (`,`), pipe (`\|`), and tab (`\\t`).
dimensions?	array	no	A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
envgroupHostname?	string	no	Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostAsyncQuery where analytics data will be grouped by organization and hostname.
filter?	string	no	Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
groupByTimeUnit?	string	no	Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
limit?	number	no	Maximum number of rows that can be returned in the result.
metrics?	array	no	Alias for the metric. Alias will be used to replace metric name in query results.
name?	string	no	Asynchronous Query Name.
outputFormat?	string	no	Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the delimiter for CSV output using the csvDelimiter property.
reportDefinitionId?	string	no	Asynchronous Report ID.
timeRange?	string	no	Required. Time range for the query. Can use the following predefined strings to specify the time range: `last60minutes` `last24hours` `last7days` Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" }
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a queries

fn get(identifier: string)

Get a queries

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

fn sync(identifier?: string)

Sync queries state from GCP

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

fn list(dataset?: string, from?: string, inclQueriesWithoutReport?: string, status?: string, submittedBy?: string, to?: string, maxPages?: number)

List queries resources

Argument	Type	Required	Description
dataset?	string	no	Filter response list by dataset. Example: `api`, `mint`
from?	string	no	Filter response list by returning asynchronous queries that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'.
inclQueriesWithoutReport?	string	no	Flag to include asynchronous queries that don't have a report denifition.
status?	string	no	Filter response list by asynchronous query status.
submittedBy?	string	no	Filter response list by user who submitted queries.
to?	string	no	Filter response list by returning asynchronous queries that created before this date time. Time must be in ISO date-time format like '2011-12-03T10:16:30Z'.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_result()

get result

fn get_resulturl()

get resulturl

environments_references.tsv2026.08.12.2

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.
description?	string	no	Optional. A human-readable description of this reference.
name?	string	no	Required. The resource id of this reference. Values must match the regular expression [\\w\\s\\-.]+.
refers?	string	no	Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resource_type.
resourceType?	string	no	The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a references

fn get(identifier: string)

Get a references

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

fn update(identifier?: string)

Update references attributes

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

fn delete(identifier: string)

Delete the references

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

fn sync(identifier?: string)

Sync references state from GCP

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

environments_resourcefiles.tsv2026.08.12.2

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.
contentType?	string	no	The HTTP Content-Type header value specifying the content type of the body.
data?	string	no	The HTTP request/response body as raw binary.
extensions?	array	no	Application specific response metadata. Must be set in the first response for streaming APIs.
type	string	yes	Required. Resource file type. {{ resource_file_type }}
name?	string	no	Required. Name of the resource file. Must match the regular expression: [a-zA-Z0-9:/\\\\!@#$%^&{}\\[\\]()+\\-=,.~'` ]{1,255}
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a resourcefiles

fn get(identifier: string)

Get a resourcefiles

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

fn update(identifier?: string)

Update resourcefiles attributes

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

fn delete(identifier: string)

Delete the resourcefiles

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

fn sync(identifier?: string)

Sync resourcefiles state from GCP

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

fn list(type?: string, maxPages?: number)

List resourcefiles resources

Argument	Type	Required	Description
type?	string	no	Optional. Type of resource files to list. {{ resource_file_type }}
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn list_environment_resources()

list environment resources

environments_securityactions.tsv2026.08.12.2

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.
allow?	object	no	Allow a request through if it matches this SecurityAction.
apiProxies?	array	no	Optional. If unset, this would apply to all proxies in the environment. If set, this action is enforced only if at least one proxy in the repeated list is deployed at the time of enforcement. If set, several restrictions are enforced on SecurityActions. There can be at most 100 enabled actions with proxies set in an env. Several other restrictions apply on conditions and are detailed later.
conditionConfig?	object	no	Optional. A list of access_tokens. Limit 1000 per action.
deny?	object	no	Optional. The HTTP response code if the Action = DENY.
description?	string	no	Optional. An optional user provided description of the SecurityAction.
expireTime?	string	no	The expiration for this SecurityAction.
flag?	object	no	The header name to be sent to the target.
name?	string	no	Immutable. This field is ignored during creation as per AIP-133. Please set the `security_action_id` field in the CreateSecurityActionRequest when creating a new SecurityAction. Format: organizations/{org}/environments/{env}/securityActions/{security_action}
state?	enum	no	Required. Only an ENABLED SecurityAction is enforced. An ENABLED SecurityAction past its expiration time will not be enforced.
ttl?	string	no	Input only. The TTL for this SecurityAction.
securityActionId?	string	no	Required. The ID to use for the SecurityAction, which will become the final component of the action's resource name. This value should be 0-61 characters, and valid format is (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create(waitForReady?: boolean)

Create a securityActions

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 securityActions

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

fn update(identifier?: string, waitForReady?: boolean)

Update securityActions attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific securityActions by name (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the securityActions

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

fn sync(identifier?: string)

Sync securityActions state from GCP

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

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

List securityActions resources

Argument	Type	Required	Description
filter?	string	no	The filter expression to filter List results. https://google.aip.dev/160. Allows for filtering over: state and api_proxies. E.g.: state = ACTIVE AND apiProxies:foo. Filtering by action is not supported https://github.com/aip-dev/google.aip.dev/issues/624
pageSize?	number	no	The maximum number of SecurityActions to return. If unspecified, at most 50 SecurityActions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn disable()

disable

fn enable()

enable

environments_securityincidents.tsv2026.08.12.2

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.
detectionTypes?	array	no	Output only. Detection types which are part of the incident. Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly Detection.
displayName?	string	no	Optional. Display name of the security incident.
firstDetectedTime?	string	no	Output only. The time when events associated with the incident were first detected.
lastDetectedTime?	string	no	Output only. The time when events associated with the incident were last detected.
lastObservabilityChangeTime?	string	no	Output only. The time when the incident observability was last changed.
name?	string	no	Immutable. Name of the security incident resource. Format: organizations/{org}/environments/{environment}/securityIncidents/{incident} Example: organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111
observability?	enum	no	Optional. Indicates if the user archived this incident.
riskLevel?	enum	no	Output only. Risk level of the incident.
trafficCount?	string	no	Total traffic detected as part of the incident.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn get(identifier: string)

Get a securityIncidents

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

fn update(identifier?: string)

Update securityIncidents attributes

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

fn sync(identifier?: string)

Sync securityIncidents state from GCP

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

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

List securityIncidents resources

Argument	Type	Required	Description
filter?	string	no	The filter expression to be used to get the list of security incidents, where filtering can be done on API Proxies. Example: filter = "api_proxy = /", "first_detected_time >", "last_detected_time <"
pageSize?	number	no	Optional. The maximum number of incidents to return. The service may return fewer than this value. If unspecified, at most 50 incidents will be returned.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn batch_update(requests?: any)

batch update

Argument	Type	Required	Description
requests?	any	no

environments_securityreports.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
csvDelimiter?	string	no	Delimiter used in the CSV file, if `outputFormat` is set to `csv`. Defaults to the `,` (comma) character. Supported delimiter characters include comma (`,`), pipe (`\|`), and tab (`\\t`).
dimensions?	array	no	A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
displayName?	string	no	Security Report display name which users can specify.
envgroupHostname?	string	no	Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostSecurityReport where analytics data will be grouped by organization and hostname.
filter?	string	no	Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
groupByTimeUnit?	string	no	Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
limit?	number	no	Maximum number of rows that can be returned in the result.
metrics?	array	no	Aggregation function: avg, min, max, or sum.
mimeType?	string	no	Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the delimiter for CSV output using the csvDelimiter property.
reportDefinitionId?	string	no	Report Definition ID.
timeRange?	string	no	Required. Time range for the query. Can use the following predefined strings to specify the time range: `last60minutes` `last24hours` `last7days` Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" }
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a securityReports

fn get(identifier: string)

Get a securityReports

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

fn sync(identifier?: string)

Sync securityReports state from GCP

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

fn list(dataset?: string, from?: string, pageSize?: number, status?: string, submittedBy?: string, to?: string, maxPages?: number)

List securityReports resources

Argument	Type	Required	Description
dataset?	string	no	Filter response list by dataset. Example: `api`, `mint`
from?	string	no	Filter response list by returning security reports that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'.
pageSize?	number	no	The maximum number of security report to return in the list response.
status?	string	no	Filter response list by security reports status.
submittedBy?	string	no	Filter response list by user who submitted queries.
to?	string	no	Filter response list by returning security reports that created before this date time. Time must be in ISO date-time format like '2011-12-03T10:16:30Z'.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_result()

get result

fn get_result_view()

get result view

environments_sharedflows_deployments.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn get(identifier: string)

Get a 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(maxPages?: number)

List deployments resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

environments_stats.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.

fn get(identifier: string)

Get a stats

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

fn sync(identifier?: string)

Sync stats state from GCP

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

environments_targetservers.tsv2026.08.12.2

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.
description?	string	no	Optional. A human-readable description of this TargetServer.
host?	string	no	Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
isEnabled?	boolean	no	Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true.
name?	string	no	Required. The resource id of this target server. Values must match the regular expression
port?	number	no	Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive.
protocol?	enum	no	Immutable. The protocol used by this TargetServer.
sSLInfo?	object	no	The SSL/TLS cipher suites to be used. For programmable proxies, it must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. For configurable proxies, it must follow the configuration specified in: https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. This setting has no effect for configurable proxies when negotiating TLS 1.3.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a targetservers

fn get(identifier: string)

Get a targetservers

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

fn update(identifier?: string)

Update targetservers attributes

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

fn delete(identifier: string)

Delete the targetservers

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

fn sync(identifier?: string)

Sync targetservers state from GCP

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

environments_traceconfig_overrides.tsv2026.08.12.2

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.
apiProxy?	string	no	ID of the API proxy that will have its trace configuration overridden.
name?	string	no	ID of the trace configuration override specified as a system-generated UUID.
samplingConfig?	object	no	Sampler of distributed tracing. OFF is the default value.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a overrides

fn get(identifier: string)

Get a overrides

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

fn update(identifier?: string)

Update overrides attributes

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

fn delete(identifier: string)

Delete the overrides

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

fn sync(identifier?: string)

Sync overrides state from GCP

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

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

List overrides resources

Argument	Type	Required	Description
pageSize?	number	no	Maximum number of trace configuration overrides to return. If not specified, the maximum number returned is 25. The maximum number cannot exceed 100.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

hostqueries.tsv2026.08.12.2

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.
csvDelimiter?	string	no	Delimiter used in the CSV file, if `outputFormat` is set to `csv`. Defaults to the `,` (comma) character. Supported delimiter characters include comma (`,`), pipe (`\|`), and tab (`\\t`).
dimensions?	array	no	A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
envgroupHostname?	string	no	Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostAsyncQuery where analytics data will be grouped by organization and hostname.
filter?	string	no	Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
groupByTimeUnit?	string	no	Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
limit?	number	no	Maximum number of rows that can be returned in the result.
metrics?	array	no	Alias for the metric. Alias will be used to replace metric name in query results.
name?	string	no	Asynchronous Query Name.
outputFormat?	string	no	Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the delimiter for CSV output using the csvDelimiter property.
reportDefinitionId?	string	no	Asynchronous Report ID.
timeRange?	string	no	Required. Time range for the query. Can use the following predefined strings to specify the time range: `last60minutes` `last24hours` `last7days` Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" }
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a hostQueries

fn get(identifier: string)

Get a hostQueries

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

fn sync(identifier?: string)

Sync hostQueries state from GCP

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

fn list(dataset?: string, envgroupHostname?: string, from?: string, inclQueriesWithoutReport?: string, status?: string, submittedBy?: string, to?: string, maxPages?: number)

List hostQueries resources

Argument	Type	Required	Description
dataset?	string	no	Filter response list by dataset. Example: `api`, `mint`
envgroupHostname?	string	no	Required. Filter response list by hostname.
from?	string	no	Filter response list by returning asynchronous queries that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'.
inclQueriesWithoutReport?	string	no	Flag to include asynchronous queries that don't have a report denifition.
status?	string	no	Filter response list by asynchronous query status.
submittedBy?	string	no	Filter response list by user who submitted queries.
to?	string	no	Filter response list by returning asynchronous queries that created before this date time. Time must be in ISO date-time format like '2011-12-03T10:16:30Z'.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_result()

get result

fn get_result_view()

get result view

hostsecurityreports.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
csvDelimiter?	string	no	Delimiter used in the CSV file, if `outputFormat` is set to `csv`. Defaults to the `,` (comma) character. Supported delimiter characters include comma (`,`), pipe (`\|`), and tab (`\\t`).
dimensions?	array	no	A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
displayName?	string	no	Security Report display name which users can specify.
envgroupHostname?	string	no	Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostSecurityReport where analytics data will be grouped by organization and hostname.
filter?	string	no	Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
groupByTimeUnit?	string	no	Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
limit?	number	no	Maximum number of rows that can be returned in the result.
metrics?	array	no	Aggregation function: avg, min, max, or sum.
mimeType?	string	no	Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the delimiter for CSV output using the csvDelimiter property.
reportDefinitionId?	string	no	Report Definition ID.
timeRange?	string	no	Required. Time range for the query. Can use the following predefined strings to specify the time range: `last60minutes` `last24hours` `last7days` Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" }
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a hostSecurityReports

fn get(identifier: string)

Get a hostSecurityReports

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

fn sync(identifier?: string)

Sync hostSecurityReports state from GCP

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

fn list(dataset?: string, envgroupHostname?: string, from?: string, pageSize?: number, status?: string, submittedBy?: string, to?: string, maxPages?: number)

List hostSecurityReports resources

Argument	Type	Required	Description
dataset?	string	no	Filter response list by dataset. Example: `api`, `mint`
envgroupHostname?	string	no	Required. Filter response list by hostname.
from?	string	no	Filter response list by returning security reports that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'.
pageSize?	number	no	The maximum number of security report to return in the list response.
status?	string	no	Filter response list by security report status.
submittedBy?	string	no	Filter response list by user who submitted queries.
to?	string	no	Filter response list by returning security reports that created before this date time. Time must be in ISO date-time format like '2011-12-03T10:16:30Z'.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_result()

get result

fn get_result_view()

get result view

hoststats.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.

fn get(identifier: string)

Get a hostStats

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

fn sync(identifier?: string)

Sync hostStats state from GCP

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

hybrid_issuers.tsv2026.08.12.2

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	Required. Must be of the form `hybrid/issuers`.

fn get(identifier: string)

Get a issuers

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

fn sync(identifier?: string)

Sync issuers state from GCP

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

fn list(maxPages?: number)

List issuers resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

instances.tsv2026.08.12.2

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.
accessLoggingConfig?	object	no	Optional. Boolean flag that specifies whether the customer access log feature is enabled.
consumerAcceptList?	array	no	Optional. Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list.
description?	string	no	Optional. Description of the instance.
diskEncryptionKeyName?	string	no	Optional. Customer Managed Encryption Key (CMEK) used for disk and volume encryption. If not specified, a Google-Managed encryption key will be used. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`
displayName?	string	no	Optional. Display name for the instance.
ipRange?	string	no	Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or `a.b.c.d/22,e.f.g.h/28`
location?	string	no	Required. Compute Engine location where the instance resides.
maintenanceUpdatePolicy?	object	no	Optional. Maintenance channel to specify relative scheduling for maintenance.
name?	string	no	Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\\d]$`.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

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 update(identifier?: string, waitForReady?: boolean)

Update instances attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific instances by name (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

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 list(pageSize?: number, maxPages?: number)

List instances resources

Argument	Type	Required	Description
pageSize?	number	no	Maximum number of instances to return. Defaults to 25.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn report_status(instanceUid?: any, reportTime?: any, resources?: any)

report status

Argument	Type	Required
instanceUid?	any	no
reportTime?	any	no
resources?	any	no

instances_attachments.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
environment?	string	no	ID of the attached environment.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a attachments

fn get(identifier: string)

Get a attachments

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

fn delete(identifier: string)

Delete the attachments

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

fn sync(identifier?: string)

Sync attachments state from GCP

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

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

List attachments resources

Argument	Type	Required	Description
pageSize?	number	no	Maximum number of instance attachments to return. Defaults to 25.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

instances_canaryevaluations.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
control?	string	no	Required. The stable version that is serving requests.
endTime?	string	no	Required. End time for the evaluation's analysis.
metricLabels?	object	no	The environment ID associated with the metrics.
startTime?	string	no	Required. Start time for the canary evaluation's analysis.
treatment?	string	no	Required. The newer version that is serving requests.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create(waitForReady?: boolean)

Create a canaryevaluations

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 canaryevaluations

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

fn sync(identifier?: string)

Sync canaryevaluations state from GCP

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

instances_nataddresses.tsv2026.08.12.2

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	no	Required. Resource ID of the NAT address.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create(waitForReady?: boolean)

Create a natAddresses

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 natAddresses

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

fn delete(identifier: string)

Delete the natAddresses

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

fn sync(identifier?: string)

Sync natAddresses state from GCP

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

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

List natAddresses resources

Argument	Type	Required	Description
pageSize?	number	no	Maximum number of natAddresses to return. Defaults to 25.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn activate()

activate

keyvaluemaps.tsv2026.08.12.2

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.
encrypted?	boolean	no	Required. Flag that specifies whether entry values will be encrypted. This field is retained for backward compatibility and the value of encrypted will always be `true`. Apigee X and hybrid do not support unencrypted key value maps.
maskedValues?	boolean	no	Optional. Flag that specifies whether entry values will be masked when returned.
name?	string	no	Required. ID of the key value map.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a keyvaluemaps

fn get(identifier: string)

Get a keyvaluemaps

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

fn update(identifier?: string)

Update keyvaluemaps attributes

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

fn delete(identifier: string)

Delete the keyvaluemaps

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

fn sync(identifier?: string)

Sync keyvaluemaps state from GCP

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

keyvaluemaps_entries.tsv2026.08.12.2

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	no	Resource URI that can be used to identify the scope of the key value map entries.
value?	string	no	Required. Data or payload that is being retrieved and associated with the unique key.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a entries

fn get(identifier: string)

Get a entries

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

fn update(identifier?: string)

Update entries attributes

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

fn delete(identifier: string)

Delete the entries

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

fn sync(identifier?: string)

Sync entries state from GCP

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

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

List entries resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. Maximum number of key value entries to return. If unspecified, at most 100 entries will be returned.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

optimizedhoststats.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.

fn get(identifier: string)

Get a optimizedHostStats

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

fn sync(identifier?: string)

Sync optimizedHostStats state from GCP

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

organizations.tsv2026.09.11.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
addonsConfig?	object	no	Flag that specifies whether the Advanced API Ops add-on is enabled.
apiConsumerDataEncryptionKeyName?	string	no	Optional. Cloud KMS key name used for encrypting API consumer data. If not specified or [BillingType](#BillingType) is `EVALUATION`, a Google-Managed encryption key will be used. Format: `projects//locations//keyRings//cryptoKeys/`
apiConsumerDataLocation?	string	no	Optional. This field is needed only for customers using non-default data residency regions. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use. For example: "us-west1" when control plane is in US or "europe-west2" when control plane is in EU.
attributes?	array	no	Not used by Apigee.
authorizedNetwork?	string	no	Optional. Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See [Getting started with the Service Networking API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). Valid only when [RuntimeType](#RuntimeType) is set to `CLOUD`. The value must be set before the creation of a runtime instance and can be updated only when there are no runtime instances. For example: `default`. When changing authorizedNetwork, you must reconfigure VPC peering. After VPC peering with previous network is deleted, [run the following command](https://cloud.google.com/sdk/gcloud/reference/services/vpc-peerings/delete): `gcloud services vpc-peerings delete --network=NETWORK`, where `NETWORK` is the name of the previous network. This will delete the previous Service Networking. Otherwise, you will get the following error: `The resource 'projects/...-tp' is already linked to another shared VPC host 'projects/...-tp`. Apigee also supports shared VPC (that is, the host network project is not the same as the one that is peering with Apigee). See [Shared VPC overview](https://cloud.google.com/vpc/docs/shared-vpc). To use a shared VPC network, use the following format: `projects/{host-project-id}/{region}/networks/{network-name}`. For example: `projects/my-sharedvpc-host/global/networks/mynetwork` Note: Not supported for Apigee hybrid.
billingType?	enum	no	Optional. Billing type of the Apigee organization. See [Apigee pricing](https://cloud.google.com/apigee/pricing).
controlPlaneEncryptionKeyName?	string	no	Optional. Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Only used for the data residency region "US" or "EU". If not specified or [BillingType](#BillingType) is `EVALUATION`, a Google-Managed encryption key will be used. Format: `projects//locations//keyRings//cryptoKeys/`
customerName?	string	no	Not used by Apigee.
description?	string	no	Optional. Description of the Apigee organization.
disableVpcPeering?	boolean	no	Optional. Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee. Valid only when RuntimeType is set to CLOUD. Required if an authorizedNetwork on the consumer project is not provided, in which case the flag should be set to true. The value must be set before the creation of any Apigee runtime instance and can be updated only when there are no runtime instances. Note: Apigee will be deprecating the vpc peering model that requires you to provide 'authorizedNetwork', by making the non-peering model as the default way of provisioning Apigee organization in future. So, this will be a temporary flag to enable the transition. Not supported for Apigee hybrid.
displayName?	string	no	Optional. Display name for the Apigee organization. Unused, but reserved for future use.
networkEgressRestricted?	boolean	no	Optional. Flag that specifies if internet egress is restricted for VPC Service Controls. Valid only when runtime_type is `CLOUD` and disable_vpc_peering is `true`.
portalDisabled?	boolean	no	Optional. Configuration for the Portals settings.
properties?	object	no	The property key
runtimeDatabaseEncryptionKeyName?	string	no	Optional. Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances. Update is not allowed after the organization is created. If not specified or [RuntimeType](#RuntimeType) is `TRIAL`, a Google-Managed encryption key will be used. For example: "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". Note: Not supported for Apigee hybrid.
runtimeType?	enum	no	Required. Runtime type of the Apigee organization based on the Apigee subscription purchased.
type?	enum	no	Not used by Apigee.
parent?	string	no	Required. Name of the Google Cloud project in which to associate the Apigee organization. Pass the information as a query parameter using the following structure in your request: `projects/`

fn create(waitForReady?: boolean)

Create a organizations

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 organizations

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

fn update(identifier?: string, waitForReady?: boolean)

Update organizations attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific organizations by name (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the organizations

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

fn sync(identifier?: string)

Sync organizations state from GCP

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

fn list(maxPages?: number)

List organizations resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_control_plane_access()

get control plane access

fn get_deployed_ingress_config(view?: any)

get deployed ingress config

Argument	Type	Required	Description
view?	any	no

fn get_mcp_server_config()

get mcp server config

fn get_project_mapping()

get project mapping

fn get_runtime_config()

get runtime config

fn get_security_settings()

get security settings

fn get_sync_authorization()

get sync authorization

fn set_addons(addonsConfig?: any)

set addons

Argument	Type	Required	Description
addonsConfig?	any	no

fn set_sync_authorization(etag?: any, identities?: any)

set sync authorization

Argument	Type	Required	Description
etag?	any	no
identities?	any	no

fn update_control_plane_access(analyticsPublisherIdentities?: any, name?: any, synchronizerIdentities?: any, watcherIdentities?: any, updateMask?: any)

update control plane access

Argument	Type	Required
analyticsPublisherIdentities?	any	no
name?	any	no
synchronizerIdentities?	any	no
watcherIdentities?	any	no
updateMask?	any	no

fn update_security_settings(mlRetrainingFeedbackEnabled?: any, name?: any, updateMask?: any)

update security settings

Argument	Type	Required
mlRetrainingFeedbackEnabled?	any	no
name?	any	no
updateMask?	any	no

reports.tsv2026.08.12.2

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.
chartType?	string	no	This field contains the chart type for the report
comments?	array	no	Legacy field: not used. This field contains a list of comments associated with custom report
dimensions?	array	no	This contains the list of dimensions for the report
displayName?	string	no	This is the display name for the report
filter?	string	no	This field contains the filter expression
fromTime?	string	no	Legacy field: not used. Contains the from time for the report
limit?	string	no	Legacy field: not used This field contains the limit for the result retrieved
metrics?	array	no	aggregate function
name?	string	no	Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id
offset?	string	no	Legacy field: not used. This field contains the offset for the data
properties?	array	no	name of the property
sortByCols?	array	no	Legacy field: not used much. Contains the list of sort by columns
sortOrder?	string	no	Legacy field: not used much. Contains the sort order for the sort columns
tags?	array	no	Legacy field: not used. This field contains a list of tags associated with custom report
timeUnit?	string	no	This field contains the time unit of aggregation for the report
toTime?	string	no	Legacy field: not used. Contains the end time for the report
topk?	string	no	Legacy field: not used. This field contains the top k parameter value for restricting the result
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a reports

fn get(identifier: string)

Get a reports

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

fn update(identifier?: string)

Update reports attributes

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

fn delete(identifier: string)

Delete the reports

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

fn sync(identifier?: string)

Sync reports state from GCP

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

fn list(expand?: boolean, maxPages?: number)

List reports resources

Argument	Type	Required	Description
expand?	boolean	no	Set to 'true' to get expanded details about each custom report.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

securityfeedback.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
comment?	string	no	Optional. Optional text the user can provide for additional, unstructured context.
displayName?	string	no	Optional. The display name of the feedback.
feedbackContexts?	array	no	Required. The attribute the user is providing feedback about.
feedbackType?	enum	no	Required. The type of feedback being submitted.
reason?	enum	no	Optional. The reason for the feedback.
securityFeedbackId?	string	no	Optional. The id for this feedback report. If not provided, it will be set to a system-generated UUID.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a securityFeedback

fn get(identifier: string)

Get a securityFeedback

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

fn update(identifier?: string)

Update securityFeedback attributes

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

fn delete(identifier: string)

Delete the securityFeedback

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

fn sync(identifier?: string)

Sync securityFeedback state from GCP

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

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

List securityFeedback resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. The maximum number of feedback reports to return. The service may return fewer than this value. LINT.IfChange(documented_page_size_limits) If unspecified, at most 10 feedback reports will be returned. The maximum value is 100; values above 100 will be coerced to 100. LINT.ThenChange( //depot/google3/edge/sense/boq/service/v1/securityfeedback/securityfeedback_rpc.go:page_size_limits )
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

securitymonitoringconditions.tsv2026.08.12.2

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.
apiHubGateway?	string	no	Optional. The API Hub gateway monitored by the security monitoring condition. This should only be set if risk_assessment_type is API_HUB. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
include?	object	no	Required. Name of this resource. For an Apigee API Proxy, this should be the id of the API proxy. For an API Hub Deployment, this should be the id of the deployment.
includeAllResources?	object	no	Include all resources under the scope.
name?	string	no	Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
profile?	string	no	Required. ID of security profile of the security monitoring condition.
riskAssessmentType?	enum	no	Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY.
scope?	string	no	Optional. Scope of the security monitoring condition. When RiskAssessmentType is APIGEE, the scope should be set to the environment of the resources. When RiskAssessmentType is API_HUB, the scope should not be set.
securityMonitoringConditionId?	string	no	Optional. Optional: The security monitoring condition id. If not specified, a monitoring condition uuid will be generated by the backend. This value should be 4-63 characters, and valid characters are /a-z-/.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a securityMonitoringConditions

fn get(identifier: string)

Get a securityMonitoringConditions

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

fn update(identifier?: string)

Update securityMonitoringConditions attributes

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

fn delete(identifier: string)

Delete the securityMonitoringConditions

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

fn sync(identifier?: string)

Sync securityMonitoringConditions state from GCP

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

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

List securityMonitoringConditions resources

Argument	Type	Required	Description
filter?	string	no	Optional. Filter for the monitoring conditions. When RiskAssessmentType is APIGEE, monitoring conditions can be filtered by profile and scope. For example: `profile=profile1 AND scope=env1` When RiskAssessmentType is API_HUB, monitoring conditions can be filtered by profile and api_hub_gateway. For example: `profile=profile1 AND api_hub_gateway=gateway1`
pageSize?	number	no	Optional. The maximum number of monitoring conditions to return.
riskAssessmentType?	string	no	Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

securityprofiles.tsv2026.09.07.1

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.
description?	string	no	Description of the security profile.
environments?	array	no	Output only. Time at which environment was attached to the security profile.
name?	string	no	Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
profileConfig?	object	no	Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
scoringConfigs?	array	no	Description of the config.
securityProfileId?	string	no	Required. The ID to use for the SecurityProfile, which will become the final component of the action\'s resource name. This value should be 1-63 characters and validated by "(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$)".
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a securityProfiles

fn get(identifier: string)

Get a securityProfiles

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

fn update(identifier?: string)

Update securityProfiles attributes

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

fn delete(identifier: string)

Delete the securityProfiles

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

fn sync(identifier?: string)

Sync securityProfiles state from GCP

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

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

List securityProfiles resources

Argument	Type	Required	Description
pageSize?	number	no	The maximum number of profiles to return. The service may return fewer than this value. If unspecified, at most 50 profiles will be returned.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn list_revisions(pageSize?: any, pageToken?: any)

list revisions

Argument	Type	Required	Description
pageSize?	any	no
pageToken?	any	no

securityprofilesv2.tsv2026.08.12.2

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.
description?	string	no	Optional. The description of the security profile.
name?	string	no	Identifier. Name of the security profile v2 resource. Format: organizations/{org}/securityProfilesV2/{profile}
profileAssessmentConfigs?	record	no	Required. The array of API Hub Gateway Types.
riskAssessmentType?	enum	no	Optional. The risk assessment type of the security profile. Defaults to ADVANCED_API_SECURITY.
securityProfileV2Id?	string	no	Required. The security profile id.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a securityProfilesV2

fn get(identifier: string)

Get a securityProfilesV2

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

fn update(identifier?: string)

Update securityProfilesV2 attributes

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

fn delete(identifier: string)

Delete the securityProfilesV2

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

fn sync(identifier?: string)

Sync securityProfilesV2 state from GCP

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

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

List securityProfilesV2 resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. The maximum number of profiles to return
riskAssessmentType?	string	no	Optional. The risk assessment type of the security profiles. Defaults to ADVANCED_API_SECURITY.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

sharedflows.tsv2026.08.12.2

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.
contentType?	string	no	The HTTP Content-Type header value specifying the content type of the body.
data?	string	no	The HTTP request/response body as raw binary.
extensions?	array	no	Application specific response metadata. Must be set in the first response for streaming APIs.
action?	string	no	Required. Must be set to either `import` or `validate`.
name?	string	no	Required. The name to give the shared flow
space?	string	no	Optional. The ID of the space to associated with this shared flow. Any IAM policies applied to the space will affect access to this shared flow. Note that this field is only respected when creating a new shared flow. It has no effect when creating a new revision for an existing shared flow.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a sharedflows

fn get(identifier: string)

Get a sharedflows

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

fn delete(identifier: string)

Delete the sharedflows

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

fn sync(identifier?: string)

Sync sharedflows state from GCP

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

fn list(includeMetaData?: boolean, includeRevisions?: boolean, space?: string, maxPages?: number)

List sharedflows resources

Argument	Type	Required	Description
includeMetaData?	boolean	no	Indicates whether to include shared flow metadata in the response.
includeRevisions?	boolean	no	Indicates whether to include a list of revisions in the response.
space?	string	no	Optional. The space ID used to filter the list of shared flows (optional). If unspecified, all shared flows in the organization will be listed. To learn how Spaces can be used to manage resources, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn move(space?: any)

move

Argument	Type	Required	Description
space?	any	no

sharedflows_deployments.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn get(identifier: string)

Get a 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(maxPages?: number)

List deployments resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

sharedflows_revisions.tsv2026.09.07.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.

fn get(identifier: string)

Get a revisions

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

fn delete(identifier: string)

Delete the revisions

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

fn sync(identifier?: string)

Sync revisions state from GCP

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

fn update_shared_flow_revision(contentType?: any, data?: any, extensions?: any, validate?: any)

update shared flow revision

Argument	Type	Required
contentType?	any	no
data?	any	no
extensions?	any	no
validate?	any	no

sharedflows_revisions_deployments.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn get(identifier: string)

Get a 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(maxPages?: number)

List deployments resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

sites_apicategories.tsv2026.08.12.2

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.
id?	string	no	ID of the category (a UUID).
name?	string	no	Name of the category.
siteId?	string	no	Name of the portal.
updateTime?	string	no	Time the category was last modified in milliseconds since epoch.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a apicategories

fn get(identifier: string)

Get a apicategories

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

fn update(identifier?: string)

Update apicategories attributes

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

fn delete(identifier: string)

Delete the apicategories

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

fn sync(identifier?: string)

Sync apicategories state from GCP

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

fn list(maxPages?: number)

List apicategories resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

sites_apidocs.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
anonAllowed?	boolean	no	Optional. Boolean flag that manages user access to the catalog item. When true, the catalog item has public visibility and can be viewed anonymously; otherwise, only registered users may view it. Note: when the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), and this flag is set to false, visibility is set to an indeterminate state and must be explicitly specified in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)). Additionally, when enrolled in the audience management feature, updates to this flag will be ignored as visibility permissions must be updated in the management UI.
apiProductName?	string	no	Required. Immutable. The `name` field of the associated [API product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). A portal may have only one catalog item associated with a given API product.
categoryIds?	array	no	Optional. The IDs of the API categories to which this catalog item belongs.
description?	string	no	Optional. Description of the catalog item. Max length is 10,000 characters.
edgeAPIProductName?	string	no	Optional. Immutable. DEPRECATED: use the `apiProductName` field instead
imageUrl?	string	no	Optional. Location of the image used for the catalog item in the catalog. This can be either an image with an external URL or a file path for [image files stored in the portal](/apigee/docs/api-platform/publish/portal/portal-files\"), for example, `/files/book-tree.jpg`. When specifying the URL of an external image, the image won't be uploaded to your assets; additionally, loading the image in the integrated portal will be subject to its availability, which may be blocked or restricted by [content security policies](/apigee/docs/api-platform/publish/portal/csp). Max length of file path is 2,083 characters.
published?	boolean	no	Optional. Denotes whether the catalog item is published to the portal or is in a draft state. When the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), the visibility can be set to public on creation by setting the anonAllowed flag to true or further managed in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) before it can be visible to any users. If not enrolled in the audience management feature, the visibility is managed by the `anonAllowed` flag.
requireCallbackUrl?	boolean	no	Optional. Whether a callback URL is required when this catalog item's API product is enabled in a developer app. When true, a portal user will be required to input a URL when managing the app (this is typically used for the app's OAuth flow).
title?	string	no	Required. The user-facing name of the catalog item. `title` must be a non-empty string with a max length of 255 characters.
visibility?	boolean	no	Optional. DEPRECATED: use the `published` field instead
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a apidocs

fn get(identifier: string)

Get a apidocs

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

fn update(identifier?: string)

Update apidocs attributes

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

fn delete(identifier: string)

Delete the apidocs

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

fn sync(identifier?: string)

Sync apidocs state from GCP

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

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

List apidocs resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 25 books will be returned. The maximum value is 100; values above 100 will be coerced to 100.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_documentation()

get documentation

fn update_documentation(asyncApiDocumentation?: any, graphqlDocumentation?: any, oasDocumentation?: any)

update documentation

Argument	Type	Required
asyncApiDocumentation?	any	no
graphqlDocumentation?	any	no
oasDocumentation?	any	no

spaces.tsv2026.09.07.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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.
displayName?	string	no	Optional. Display name of the space.
spaceId?	string	no	Required. Resource ID of the space.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a spaces

fn get(identifier: string)

Get a spaces

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

fn update(identifier?: string)

Update spaces attributes

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

fn delete(identifier: string)

Delete the spaces

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

fn sync(identifier?: string)

Sync spaces state from GCP

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

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

List spaces resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. The maximum number of spaces to return. The service may return fewer than this value. If unspecified, at most 50 spaces will be returned. The maximum value 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(options_requestedPolicyVersion?: any)

get iam policy

Argument	Type	Required	Description
options_requestedPolicyVersion?	any	no

fn set_iam_policy(policy?: any, updateMask?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no
updateMask?	any	no

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

04Previous Versions19

2026.09.07.2Sep 8, 2026

Updated: environments, environments_deployments, spaces

2026.09.03.1Sep 3, 2026

Updated: organizations

2026.08.18.1Aug 18, 2026

Updated: environments

2026.08.12.2Aug 12, 2026

Updated: hybrid_issuers, organizations, analytics_datastores, apimserviceextensions, apiproducts, apiproducts_attributes, apiproducts_rateplans, apis, apis_debugsessions, apis_deployments, apis_keyvaluemaps, apis_keyvaluemaps_entries, apis_revisions, apis_revisions_deployments, appgroups, appgroups_apps, appgroups_apps_keys, appgroups_subscriptions, apps, datacollectors, deployments, developers, developers_apps, developers_apps_attributes, developers_apps_keys, developers_attributes, developers_subscriptions, dnszones, endpointattachments, envgroups, envgroups_attachments, environments, environments_analytics_exports, environments_apis_deployments, environments_apis_revisions_debugsessions, environments_apis_revisions_debugsessions_data, environments_archivedeployments, environments_deployments, environments_flowhooks, environments_keystores, environments_keystores_aliases, environments_keyvaluemaps, environments_keyvaluemaps_entries, environments_optimizedstats, environments_queries, environments_references, environments_resourcefiles, environments_securityactions, environments_securityincidents, environments_securityreports, environments_sharedflows_deployments, environments_stats, environments_targetservers, environments_traceconfig_overrides, hostqueries, hostsecurityreports, hoststats, instances, instances_attachments, instances_canaryevaluations, instances_nataddresses, keyvaluemaps, keyvaluemaps_entries, optimizedhoststats, reports, securityfeedback, securitymonitoringconditions, securityprofiles, securityprofilesv2, sharedflows, sharedflows_deployments, sharedflows_revisions, sharedflows_revisions_deployments, sites_apicategories, sites_apidocs, spaces

2026.07.29.1Jul 30, 2026

Updated: hybrid_issuers, organizations, analytics_datastores, apimserviceextensions, apiproducts, apiproducts_attributes, apiproducts_rateplans, apis, apis_debugsessions, apis_deployments, apis_keyvaluemaps, apis_keyvaluemaps_entries, apis_revisions, apis_revisions_deployments, appgroups, appgroups_apps, appgroups_apps_keys, appgroups_subscriptions, apps, datacollectors, deployments, developers, developers_apps, developers_apps_attributes, developers_apps_keys, developers_attributes, developers_subscriptions, dnszones, endpointattachments, envgroups, envgroups_attachments, environments, environments_analytics_exports, environments_apis_deployments, environments_apis_revisions_debugsessions, environments_apis_revisions_debugsessions_data, environments_archivedeployments, environments_deployments, environments_flowhooks, environments_keystores, environments_keystores_aliases, environments_keyvaluemaps, environments_keyvaluemaps_entries, environments_optimizedstats, environments_queries, environments_references, environments_resourcefiles, environments_securityactions, environments_securityincidents, environments_securityreports, environments_sharedflows_deployments, environments_stats, environments_targetservers, environments_traceconfig_overrides, hostqueries, hostsecurityreports, hoststats, instances, instances_attachments, instances_canaryevaluations, instances_nataddresses, keyvaluemaps, keyvaluemaps_entries, optimizedhoststats, reports, securityfeedback, securitymonitoringconditions, securityprofiles, securityprofilesv2, sharedflows, sharedflows_deployments, sharedflows_revisions, sharedflows_revisions_deployments, sites_apicategories, sites_apidocs, spaces

2026.07.24.1Jul 24, 2026

Updated: apiproducts, environments

2026.07.21.3Jul 21, 2026

Updated: hybrid_issuers, organizations, analytics_datastores, apimserviceextensions, apiproducts, apiproducts_attributes, apiproducts_rateplans, apis, apis_debugsessions, apis_deployments, apis_keyvaluemaps, apis_keyvaluemaps_entries, apis_revisions, apis_revisions_deployments, appgroups, appgroups_apps, appgroups_apps_keys, appgroups_subscriptions, apps, datacollectors, deployments, developers, developers_apps, developers_apps_attributes, developers_apps_keys, developers_attributes, developers_subscriptions, dnszones, endpointattachments, envgroups, envgroups_attachments, environments, environments_analytics_exports, environments_apis_deployments, environments_apis_revisions_debugsessions, environments_apis_revisions_debugsessions_data, environments_archivedeployments, environments_deployments, environments_flowhooks, environments_keystores, environments_keystores_aliases, environments_keyvaluemaps, environments_keyvaluemaps_entries, environments_optimizedstats, environments_queries, environments_references, environments_resourcefiles, environments_securityactions, environments_securityincidents, environments_securityreports, environments_sharedflows_deployments, environments_stats, environments_targetservers, environments_traceconfig_overrides, hostqueries, hostsecurityreports, hoststats, instances, instances_attachments, instances_canaryevaluations, instances_nataddresses, keyvaluemaps, keyvaluemaps_entries, optimizedhoststats, reports, securityfeedback, securitymonitoringconditions, securityprofiles, securityprofilesv2, sharedflows, sharedflows_deployments, sharedflows_revisions, sharedflows_revisions_deployments, sites_apicategories, sites_apidocs, spaces

2026.07.21.1Jul 21, 2026

Updated: organizations, analytics_datastores, apiproducts, apiproducts_rateplans, apis, appgroups_subscriptions, developers, developers_subscriptions, dnszones, environments, environments_analytics_exports, environments_securityactions, environments_targetservers, environments_traceconfig_overrides, instances, instances_attachments, instances_canaryevaluations, securitymonitoringconditions, securityprofiles, securityprofilesv2, sites_apidocs

2026.07.20.2Jul 20, 2026

Updated: apiproducts, environments

2026.07.20.1Jul 20, 2026

Updated: hybrid_issuers, organizations, analytics_datastores, apimserviceextensions, apiproducts, apiproducts_attributes, apiproducts_rateplans, apis, apis_debugsessions, apis_deployments, apis_keyvaluemaps, apis_keyvaluemaps_entries, apis_revisions, apis_revisions_deployments, appgroups, appgroups_apps, appgroups_apps_keys, appgroups_subscriptions, apps, datacollectors, deployments, developers, developers_apps, developers_apps_attributes, developers_apps_keys, developers_attributes, developers_subscriptions, dnszones, endpointattachments, envgroups, envgroups_attachments, environments, environments_analytics_exports, environments_apis_deployments, environments_apis_revisions_debugsessions, environments_apis_revisions_debugsessions_data, environments_archivedeployments, environments_deployments, environments_flowhooks, environments_keystores, environments_keystores_aliases, environments_keyvaluemaps, environments_keyvaluemaps_entries, environments_optimizedstats, environments_queries, environments_references, environments_resourcefiles, environments_securityactions, environments_securityincidents, environments_securityreports, environments_sharedflows_deployments, environments_stats, environments_targetservers, environments_traceconfig_overrides, hostqueries, hostsecurityreports, hoststats, instances, instances_attachments, instances_canaryevaluations, instances_nataddresses, keyvaluemaps, keyvaluemaps_entries, optimizedhoststats, reports, securityfeedback, securitymonitoringconditions, securityprofiles, securityprofilesv2, sharedflows, sharedflows_deployments, sharedflows_revisions, sharedflows_revisions_deployments, sites_apicategories, sites_apidocs, spaces

2026.07.19.2Jul 19, 2026

Updated: hybrid_issuers, environments_resourcefiles

2026.07.19.1Jul 19, 2026

Updated: hybrid_issuers, organizations, analytics_datastores, apimserviceextensions, apiproducts, apiproducts_attributes, apiproducts_rateplans, apis, apis_debugsessions, apis_deployments, apis_keyvaluemaps, apis_keyvaluemaps_entries, apis_revisions, apis_revisions_deployments, appgroups, appgroups_apps, appgroups_apps_keys, appgroups_subscriptions, apps, datacollectors, deployments, developers, developers_apps, developers_apps_attributes, developers_apps_keys, developers_attributes, developers_subscriptions, dnszones, endpointattachments, envgroups, envgroups_attachments, environments, environments_analytics_exports, environments_apis_deployments, environments_apis_revisions_debugsessions, environments_apis_revisions_debugsessions_data, environments_archivedeployments, environments_deployments, environments_flowhooks, environments_keystores, environments_keystores_aliases, environments_keyvaluemaps, environments_keyvaluemaps_entries, environments_optimizedstats, environments_queries, environments_references, environments_resourcefiles, environments_securityactions, environments_securityincidents, environments_securityreports, environments_sharedflows_deployments, environments_stats, environments_targetservers, environments_traceconfig_overrides, hostqueries, hostsecurityreports, hoststats, instances, instances_attachments, instances_canaryevaluations, instances_nataddresses, keyvaluemaps, keyvaluemaps_entries, optimizedhoststats, reports, securityfeedback, securitymonitoringconditions, securityprofiles, securityprofilesv2, sharedflows, sharedflows_deployments, sharedflows_revisions, sharedflows_revisions_deployments, sites_apicategories, sites_apidocs, spaces

2026.07.18.2Jul 18, 2026

Updated: hybrid_issuers, organizations, analytics_datastores, apimserviceextensions, apiproducts, apiproducts_attributes, apiproducts_rateplans, apis, apis_debugsessions, apis_deployments, apis_keyvaluemaps, apis_keyvaluemaps_entries, apis_revisions, apis_revisions_deployments, appgroups, appgroups_apps, appgroups_apps_keys, appgroups_subscriptions, apps, datacollectors, deployments, developers, developers_apps, developers_apps_attributes, developers_apps_keys, developers_attributes, developers_subscriptions, dnszones, endpointattachments, envgroups, envgroups_attachments, environments, environments_analytics_exports, environments_apis_deployments, environments_apis_revisions_debugsessions, environments_apis_revisions_debugsessions_data, environments_archivedeployments, environments_deployments, environments_flowhooks, environments_keystores, environments_keystores_aliases, environments_keyvaluemaps, environments_keyvaluemaps_entries, environments_optimizedstats, environments_queries, environments_references, environments_resourcefiles, environments_securityactions, environments_securityincidents, environments_securityreports, environments_sharedflows_deployments, environments_stats, environments_targetservers, environments_traceconfig_overrides, hostqueries, hostsecurityreports, hoststats, instances, instances_attachments, instances_canaryevaluations, instances_nataddresses, keyvaluemaps, keyvaluemaps_entries, optimizedhoststats, reports, securityfeedback, securitymonitoringconditions, securityprofiles, securityprofilesv2, sharedflows, sharedflows_deployments, sharedflows_revisions, sharedflows_revisions_deployments, sites_apicategories, sites_apidocs, spaces

2026.07.17.3Jul 17, 2026

Updated: apimserviceextensions, apiproducts, apis, apis_keyvaluemaps, apis_keyvaluemaps_entries, appgroups, appgroups_apps, datacollectors, developers_apps, dnszones, endpointattachments, envgroups, envgroups_attachments, environments, environments_analytics_exports, environments_apis_revisions_debugsessions, environments_archivedeployments, environments_keystores, environments_keyvaluemaps, environments_keyvaluemaps_entries, environments_queries, environments_references, environments_resourcefiles, environments_securityactions, environments_securityincidents, environments_targetservers, environments_traceconfig_overrides, hostqueries, instances, instances_nataddresses, keyvaluemaps, keyvaluemaps_entries, reports, securityfeedback, securitymonitoringconditions, securityprofiles, securityprofilesv2, sharedflows, sites_apicategories, spaces

2026.07.17.2Jul 17, 2026

Updated: developers

2026.07.17.1Jul 17, 2026

Updated: organizations, apimserviceextensions, apiproducts, apiproducts_attributes, apiproducts_rateplans, apis, apis_keyvaluemaps, apis_keyvaluemaps_entries, appgroups, appgroups_apps, appgroups_apps_keys, appgroups_subscriptions, apps, datacollectors, developers, developers_apps, developers_apps_attributes, developers_apps_keys, developers_attributes, developers_subscriptions, dnszones, endpointattachments, envgroups, envgroups_attachments, environments, environments_apis_revisions_debugsessions, environments_archivedeployments, environments_deployments, environments_keystores, environments_keystores_aliases, environments_keyvaluemaps, environments_keyvaluemaps_entries, environments_queries, environments_references, environments_resourcefiles, environments_securityactions, environments_securityincidents, environments_securityreports, environments_targetservers, environments_traceconfig_overrides, hostqueries, hostsecurityreports, instances, instances_attachments, instances_canaryevaluations, instances_nataddresses, keyvaluemaps, keyvaluemaps_entries, reports, securityfeedback, securitymonitoringconditions, securityprofiles, securityprofilesv2, sharedflows, sites_apicategories, sites_apidocs, spaces

2026.07.08.1Jul 8, 2026

Updated: environments

2026.06.24.1Jun 23, 2026

Updated: apiproducts, environments

2026.06.08.2Jun 8, 2026

Updated: hybrid_issuers, organizations, analytics_datastores, apimserviceextensions, apiproducts, apiproducts_attributes, apiproducts_rateplans, apis, apis_debugsessions, apis_deployments, apis_keyvaluemaps, apis_keyvaluemaps_entries, apis_revisions, apis_revisions_deployments, appgroups, appgroups_apps, appgroups_apps_keys, appgroups_subscriptions, apps, datacollectors, deployments, developers, developers_apps, developers_apps_attributes, developers_apps_keys, developers_attributes, developers_subscriptions, dnszones, endpointattachments, envgroups, envgroups_attachments, environments, environments_analytics_exports, environments_apis_deployments, environments_apis_revisions_debugsessions, environments_apis_revisions_debugsessions_data, environments_archivedeployments, environments_deployments, environments_flowhooks, environments_keystores, environments_keystores_aliases, environments_keyvaluemaps, environments_keyvaluemaps_entries, environments_optimizedstats, environments_queries, environments_references, environments_resourcefiles, environments_securityactions, environments_securityincidents, environments_securityreports, environments_sharedflows_deployments, environments_stats, environments_targetservers, environments_traceconfig_overrides, hostqueries, hostsecurityreports, hoststats, instances, instances_attachments, instances_canaryevaluations, instances_nataddresses, keyvaluemaps, keyvaluemaps_entries, optimizedhoststats, reports, securityfeedback, securitymonitoringconditions, securityprofiles, securityprofilesv2, sharedflows, sharedflows_deployments, sharedflows_revisions, sharedflows_revisions_deployments, sites_apicategories, sites_apidocs, spaces

05Stats

100 / 100

Downloads

Archive size

753.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
License declared1/1earned
Verified public repository2/2earned

Repository

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

06Platforms

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

07Labels

#gcp #google-cloud #apigee #cloud #infrastructure