@swamp/gcp/apihub
v2026.04.23.1
Google Cloud apihub infrastructure models
Repository
https://github.com/systeminit/swamp-extensions
Labels
gcpgoogle-cloudapihubcloudinfrastructure
Contents
Quality score
Verified by SwampHow well-documented and verifiable this extension is.
Grade A
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
Install
$ swamp extension pull @swamp/gcp/apihub@swamp/gcp/apihub/addonsv2026.04.23.1addons.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
getGet a addons
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the addons |
syncSync addons state from GCP
manage_configmanage config
| Argument | Type | Description |
|---|---|---|
| config? | any |
Resources
state(infinite)— Addon resource.
@swamp/gcp/apihub/apihubinstancesv2026.04.23.1apihubinstances.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| config? | object | Available configurations to provision an ApiHub Instance. |
| description? | string | Optional. Description of the ApiHub instance. |
| labels? | record | Optional. Instance labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources |
| name? | string | Identifier. Format: `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`. |
| apiHubInstanceId? | string | Optional. Identifier to assign to the Api Hub instance. Must be unique within scope of the parent resource. If the field is not provided, system generated id will be used. This value should be 4-40 characters, and valid characters are `/a-z[0-9]-_/`. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a apiHubInstances
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a apiHubInstances
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the apiHubInstances |
updateUpdate apiHubInstances attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
deleteDelete the apiHubInstances
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the apiHubInstances |
syncSync apiHubInstances state from GCP
lookuplookup
Resources
state(infinite)— An ApiHubInstance represents the instance resources of the API Hub. Currently...
@swamp/gcp/apihub/apisv2026.04.23.1apis.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| apiFunctionalRequirements? | object | The attribute values associated with resource. |
| apiRequirements? | object | The attribute values associated with resource. |
| apiStyle? | object | The attribute values associated with resource. |
| apiTechnicalRequirements? | object | The attribute values associated with resource. |
| attributes? | record | Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource. |
| businessUnit? | object | The attribute values associated with resource. |
| description? | string | Optional. The description of the API resource. |
| displayName? | string | Required. The display name of the API resource. |
| documentation? | object | Documentation details. |
| fingerprint? | string | Optional. Fingerprint of the API resource. This must be unique for each API resource. It can neither be unset nor be updated to an existing fingerprint of another API resource. |
| maturityLevel? | object | The attribute values associated with resource. |
| name? | string | Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}` |
| owner? | object | Owner details. |
| selectedVersion? | string | Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}` |
| targetUser? | object | The attribute values associated with resource. |
| team? | object | The attribute values associated with resource. |
| apiId? | string | Optional. The ID to use for the API resource, which will become the final component of the API's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another API resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a apis
getGet a apis
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the apis |
updateUpdate apis attributes
deleteDelete the apis
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the apis |
syncSync apis state from GCP
Resources
state(infinite)— An API resource in the API Hub.
@swamp/gcp/apihub/apis-versionsv2026.04.23.1apis_versions.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accreditation? | object | The attribute values associated with resource. |
| attributes? | record | Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource. |
| compliance? | object | The attribute values associated with resource. |
| deployments? | array | Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is `projects/{project}/locations/{location}/deployments/{deployment}` |
| description? | string | Optional. The description of the version. |
| displayName? | string | Required. The display name of the version. |
| documentation? | object | Documentation details. |
| lifecycle? | object | The attribute values associated with resource. |
| name? | string | Identifier. The name of the version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}` |
| selectedDeployment? | string | Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is `projects/{project}/locations/{location}/deployments/{deployment}` |
| versionId? | string | Optional. The ID to use for the API version, which will become the final component of the version's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another version in the API resource. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format `projects/{project}/locations/{location}/apis/{api}/versions/{version}`, it |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a versions
getGet a versions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the versions |
updateUpdate versions attributes
deleteDelete the versions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the versions |
syncSync versions state from GCP
Resources
state(infinite)— Represents a version of the API resource in API hub. This is also referred to...
@swamp/gcp/apihub/apis-versions-definitionsv2026.04.23.1apis_versions_definitions.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a definitions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the definitions |
syncSync definitions state from GCP
Resources
state(infinite)— Represents a definition for example schema, request, response definitions con...
@swamp/gcp/apihub/apis-versions-specsv2026.04.23.1apis_versions_specs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| attributes? | record | Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource. |
| contents? | object | The spec contents. |
| details? | object | SpecDetails contains the details parsed from supported spec types. |
| displayName? | string | Required. The display name of the spec. This can contain the file name of the spec. |
| documentation? | object | Documentation details. |
| lintResponse? | object | LintResponse contains the response from the linter. |
| name? | string | Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` |
| parsingMode? | enum | Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing. |
| sourceUri? | string | Optional. The URI of the spec source in case file is uploaded from an external version control system. |
| specType? | object | The attribute values associated with resource. |
| specId? | string | Optional. The ID to use for the spec, which will become the final component of the spec's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another spec in the API resource. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`, it |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a specs
getGet a specs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the specs |
updateUpdate specs attributes
deleteDelete the specs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the specs |
syncSync specs state from GCP
fetch_additional_spec_contentfetch additional spec content
get_contentsget contents
lintlint
Resources
state(infinite)— Represents a spec associated with an API version in the API Hub. Note that sp...
@swamp/gcp/apihub/attributesv2026.04.23.1attributes.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| allowedValues? | array | Optional. The list of allowed values when the attribute value is of type enum. This is required when the data_type of the attribute is ENUM. The maximum number of allowed values of an attribute will be 1000. |
| cardinality? | number | Optional. The maximum number of values that the attribute can have when associated with an API Hub resource. Cardinality 1 would represent a single-valued attribute. It must not be less than 1 or greater than 20. If not specified, the cardinality would be set to 1 by default and represent a single-valued attribute. |
| dataType? | enum | Required. The type of the data of the attribute. |
| description? | string | Optional. The description of the attribute. |
| displayName? | string | Required. The display name of the attribute. |
| name? | string | Identifier. The name of the attribute in the API Hub. Format: `projects/{project}/locations/{location}/attributes/{attribute}` |
| scope? | enum | Required. The scope of the attribute. It represents the resource in the API Hub to which the attribute can be linked. |
| attributeId? | string | Optional. The ID to use for the attribute, which will become the final component of the attribute's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another attribute resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a attributes
getGet a attributes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the attributes |
updateUpdate attributes attributes
deleteDelete the attributes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the attributes |
syncSync attributes state from GCP
Resources
state(infinite)— An attribute in the API Hub. An attribute is a name value pair which can be a...
@swamp/gcp/apihub/curationsv2026.04.23.1curations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| description? | string | Optional. The description of the curation. |
| displayName? | string | Required. The display name of the curation. |
| endpoint? | object | The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. |
| name? | string | Identifier. The name of the curation. Format: `projects/{project}/locations/{location}/curations/{curation}` |
| curationId? | string | Optional. The ID to use for the curation resource, which will become the final component of the curations's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified ID is already used by another curation resource in the API hub. * If not provided, a system generated ID will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a curations
getGet a curations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the curations |
updateUpdate curations attributes
deleteDelete the curations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the curations |
syncSync curations state from GCP
Resources
state(infinite)— A curation resource in the API Hub.
@swamp/gcp/apihub/dependenciesv2026.04.23.1dependencies.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| attributes? | record | Optional. The list of user defined attributes associated with the dependency resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource. |
| consumer? | object | Reference to an entity participating in a dependency. |
| description? | string | Optional. Human readable description corresponding of the dependency. |
| errorDetail? | object | Details describing error condition of a dependency. |
| name? | string | Identifier. The name of the dependency in the API Hub. Format: `projects/{project}/locations/{location}/dependencies/{dependency}` |
| supplier? | object | Reference to an entity participating in a dependency. |
| dependencyId? | string | Optional. The ID to use for the dependency resource, which will become the final component of the dependency's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if duplicate id is provided by the client. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are `a-z[0-9]-_`. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a dependencies
getGet a dependencies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dependencies |
updateUpdate dependencies attributes
deleteDelete the dependencies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dependencies |
syncSync dependencies state from GCP
Resources
state(infinite)— A dependency resource defined in the API hub describes a dependency directed ...
@swamp/gcp/apihub/deploymentsv2026.04.23.1deployments.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| attributes? | record | Optional. The list of user defined attributes associated with the deployment resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource. |
| deploymentType? | object | The attribute values associated with resource. |
| description? | string | Optional. The description of the deployment. |
| displayName? | string | Required. The display name of the deployment. |
| documentation? | object | Documentation details. |
| endpoints? | array | Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses. |
| environment? | object | The attribute values associated with resource. |
| managementUrl? | object | The attribute values associated with resource. |
| name? | string | Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}` |
| resourceUri? | string | Required. The resource URI identifies the deployment within its gateway. For Apigee gateways, its recommended to use the format: organizations/{org}/environments/{env}/apis/{api}. For ex: if a proxy with name `orders` is deployed in `staging` environment of `cymbal` organization, the resource URI would be: `organizations/cymbal/environments/staging/apis/orders`. |
| slo? | object | The attribute values associated with resource. |
| sourceEnvironment? | string | Optional. The environment at source for the deployment. For example: prod, dev, staging, etc. |
| sourceProject? | string | Optional. The project to which the deployment belongs. For Google Cloud gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier. |
| sourceUri? | object | The attribute values associated with resource. |
| deploymentId? | string | Optional. The ID to use for the deployment resource, which will become the final component of the deployment's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another deployment resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a deployments
getGet a deployments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deployments |
updateUpdate deployments attributes
deleteDelete the deployments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deployments |
syncSync deployments state from GCP
Resources
state(infinite)— Details of the deployment where APIs are hosted. A deployment could represent...
@swamp/gcp/apihub/discoveredapiobservationsv2026.04.23.1discoveredapiobservations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
getGet a discoveredApiObservations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the discoveredApiObservations |
syncSync discoveredApiObservations state from GCP
Resources
state(infinite)— Respresents an API Observation observed in one of the sources.
@swamp/gcp/apihub/externalapisv2026.04.23.1externalapis.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| attributes? | record | Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource. |
| description? | string | Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points). |
| displayName? | string | Required. Display name of the external API. Max length is 63 characters (Unicode Code Points). |
| documentation? | object | Documentation details. |
| endpoints? | array | Optional. List of endpoints on which this API is accessible. |
| name? | string | Identifier. Format: `projects/{project}/locations/{location}/externalApi/{externalApi}`. |
| paths? | array | Optional. List of paths served by this API. |
| externalApiId? | string | Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another External API resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a externalApis
getGet a externalApis
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the externalApis |
updateUpdate externalApis attributes
deleteDelete the externalApis
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the externalApis |
syncSync externalApis state from GCP
Resources
state(infinite)— An external API represents an API being provided by external sources. This ca...
@swamp/gcp/apihub/hostprojectregistrationsv2026.04.23.1hostprojectregistrations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| gcpProject? | string | Required. Immutable. Google cloud project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number. |
| name? | string | Identifier. The name of the host project registration. Format: "projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}". |
| hostProjectRegistrationId? | string | Required. The ID to use for the Host Project Registration, which will become the final component of the host project registration's resource name. The ID must be the same as the Google cloud project specified in the host_project_registration.gcp_project field. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a hostProjectRegistrations
getGet a hostProjectRegistrations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the hostProjectRegistrations |
syncSync hostProjectRegistrations state from GCP
Resources
state(infinite)— Host project registration refers to the registration of a Google cloud projec...
@swamp/gcp/apihub/locationsv2026.04.23.1locations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
syncSync locations state from GCP
collect_api_datacollect api data
| Argument | Type | Description |
|---|---|---|
| actionId? | any | |
| apiData? | any | |
| collectionType? | any | |
| pluginInstance? | any |
lookup_runtime_project_attachmentlookup runtime project attachment
retrieve_api_viewsretrieve api views
search_resourcessearch resources
| Argument | Type | Description |
|---|---|---|
| filter? | any | |
| pageSize? | any | |
| pageToken? | any | |
| query? | any |
Resources
state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/apihub/pluginsv2026.04.23.1plugins.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| actionsConfig? | array | Optional. The configuration of actions supported by the plugin. **REQUIRED**: This field must be provided when creating or updating a Plugin. The server will reject requests if this field is missing. |
| configTemplate? | object | ConfigTemplate represents the configuration template for a plugin. |
| description? | string | Optional. The plugin description. Max length is 2000 characters (Unicode code points). |
| displayName? | string | Required. The display name of the plugin. Max length is 50 characters (Unicode code points). |
| documentation? | object | Documentation details. |
| gatewayType? | enum | Optional. The type of the gateway. |
| hostingService? | object | The information related to the service implemented by the plugin developer, used to invoke the plugin's functionality. |
| name? | string | Identifier. The name of the plugin. Format: `projects/{project}/locations/{location}/plugins/{plugin}` |
| pluginCategory? | enum | Optional. The category of the plugin, identifying its primary category or purpose. This field is required for all plugins. |
| type? | object | The attribute values associated with resource. |
| pluginId? | string | Optional. The ID to use for the Plugin resource, which will become the final component of the Plugin's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another Plugin resource in the API hub instance. * If not provided, a system generated id will be used. This value should be 4-63 characters, overall resource name which will be of format `projects/{project}/locations/{location}/plugins/{plugin}`, i |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a plugins
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a plugins
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the plugins |
deleteDelete the plugins
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the plugins |
syncSync plugins state from GCP
disabledisable
enableenable
get_style_guideget style guide
update_style_guideupdate style guide
| Argument | Type | Description |
|---|---|---|
| contents? | any | |
| linter? | any | |
| name? | any |
Resources
state(infinite)— A plugin resource in the API Hub.
@swamp/gcp/apihub/plugins-instancesv2026.04.23.1plugins_instances.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| actions? | array | Required. The action status for the plugin instance. |
| additionalConfig? | record | Optional. The additional information for this plugin instance corresponding to the additional config template of the plugin. This information will be sent to plugin hosting service on each call to plugin hosted service. The key will be the config_variable_template.display_name to uniquely identify the config variable. |
| authConfig? | object | AuthConfig represents the authentication information. |
| displayName? | string | Required. The display name for this plugin instance. Max length is 255 characters. |
| name? | string | Identifier. The unique name of the plugin instance resource. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` |
| sourceEnvironmentsConfig? | record | Optional. The source environment's config present in the gateway instance linked to the plugin instance. The key is the `source_environment` name from the SourceEnvironment message. |
| sourceProjectId? | string | Optional. The source project id of the plugin instance. This will be the id of runtime project in case of Google Cloud based plugins and org id in case of non-Google Cloud based plugins. This field will be a required field for Google provided on-ramp plugins. |
| pluginInstanceId? | string | Optional. The ID to use for the plugin instance, which will become the final component of the plugin instance's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another plugin instance in the plugin resource. * If not provided, a system generated id will be used. This value should be 4-63 characters, and valid characters are /a-z[0-9]-_/. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a instances
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a instances
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the instances |
updateUpdate instances attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
deleteDelete the instances
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the instances |
syncSync instances state from GCP
disable_actiondisable action
| Argument | Type | Description |
|---|---|---|
| actionId? | any |
enable_actionenable action
| Argument | Type | Description |
|---|---|---|
| actionId? | any |
execute_actionexecute action
| Argument | Type | Description |
|---|---|---|
| actionExecutionDetail? | any |
manage_source_datamanage source data
| Argument | Type | Description |
|---|---|---|
| action? | any | |
| data? | any | |
| dataType? | any | |
| relativePath? | any |
Resources
state(infinite)— Represents a plugin instance resource in the API Hub. A PluginInstance is a s...
@swamp/gcp/apihub/runtimeprojectattachmentsv2026.04.23.1runtimeprojectattachments.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name? | string | Identifier. The resource name of a runtime project attachment. Format: "projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}". |
| runtimeProject? | string | Required. Immutable. Google cloud project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number. |
| runtimeProjectAttachmentId? | string | Required. The ID to use for the Runtime Project Attachment, which will become the final component of the Runtime Project Attachment's name. The ID must be the same as the project ID of the Google cloud project specified in the runtime_project_attachment.runtime_project field. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a runtimeProjectAttachments
getGet a runtimeProjectAttachments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the runtimeProjectAttachments |
deleteDelete the runtimeProjectAttachments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the runtimeProjectAttachments |
syncSync runtimeProjectAttachments state from GCP
Resources
state(infinite)— Runtime project attachment represents an attachment from the runtime project ...
2026.04.04.1101.7 KBApr 4, 2026
Google Cloud apihub infrastructure models
Release Notes
- Updated: addons, apis, apis_versions, apis_versions_specs, dependencies, deployments, externalapis, plugins, plugins_instances
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudapihubcloudinfrastructure
2026.04.03.3101.3 KBApr 3, 2026
Google Cloud apihub infrastructure models
Release Notes
- Updated: locations, addons, apihubinstances, apis, apis_versions, apis_versions_definitions, apis_versions_specs, attributes, curations, dependencies, deployments, discoveredapiobservations, externalapis, hostprojectregistrations, plugins, plugins_instances, runtimeprojectattachments
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudapihubcloudinfrastructure
2026.04.03.199.2 KBApr 3, 2026
Google Cloud apihub infrastructure models
Release Notes
- Updated: locations, addons, apihubinstances, apis, apis_versions, apis_versions_definitions, apis_versions_specs, attributes, curations, dependencies, deployments, discoveredapiobservations, externalapis, hostprojectregistrations, plugins, plugins_instances, runtimeprojectattachments
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudapihubcloudinfrastructure
2026.04.02.298.2 KBApr 2, 2026
Google Cloud apihub infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudapihubcloudinfrastructure
2026.03.27.190.4 KBMar 27, 2026
Google Cloud apihub infrastructure models
Release Notes
- Added: locations, addons, apihubinstances, apis, apis_versions, apis_versions_definitions, apis_versions_specs, attributes, curations, dependencies, deployments, discoveredapiobservations, externalapis, hostprojectregistrations, plugins, plugins_instances, runtimeprojectattachments
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudapihubcloudinfrastructure