published on Wednesday, Nov 18, 2026 by Pulumi
published on Wednesday, Nov 18, 2026 by Pulumi
To get more information about API proxies see, see:
- API documentation
- How-to Guides
Create Api Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Api(name: string, args: ApiArgs, opts?: CustomResourceOptions);@overload
def Api(resource_name: str,
args: ApiArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Api(resource_name: str,
opts: Optional[ResourceOptions] = None,
config_bundle: Optional[str] = None,
org_id: Optional[str] = None,
deletion_policy: Optional[str] = None,
detect_md5hash: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
name: Optional[str] = None)func NewApi(ctx *Context, name string, args ApiArgs, opts ...ResourceOption) (*Api, error)public Api(string name, ApiArgs args, CustomResourceOptions? opts = null)type: gcp:apigee:Api
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "gcp_apigee_api" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ApiArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ApiArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ApiArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApiArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var gcpApiResource = new Gcp.Apigee.Api("gcpApiResource", new()
{
ConfigBundle = "string",
OrgId = "string",
DeletionPolicy = "string",
DetectMd5hash = "string",
Labels =
{
{ "string", "string" },
},
Name = "string",
});
example, err := apigee.NewApi(ctx, "gcpApiResource", &apigee.ApiArgs{
ConfigBundle: pulumi.String("string"),
OrgId: pulumi.String("string"),
DeletionPolicy: pulumi.String("string"),
DetectMd5hash: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
})
resource "gcp_apigee_api" "gcpApiResource" {
lifecycle {
create_before_destroy = true
}
config_bundle = "string"
org_id = "string"
deletion_policy = "string"
detect_md5hash = "string"
labels = {
"string" = "string"
}
name = "string"
}
var gcpApiResource = new com.pulumi.gcp.apigee.Api("gcpApiResource", com.pulumi.gcp.apigee.ApiArgs.builder()
.configBundle("string")
.orgId("string")
.deletionPolicy("string")
.detectMd5hash("string")
.labels(Map.of("string", "string"))
.name("string")
.build());
gcp_api_resource = gcp.apigee.Api("gcpApiResource",
config_bundle="string",
org_id="string",
deletion_policy="string",
detect_md5hash="string",
labels={
"string": "string",
},
name="string")
const gcpApiResource = new gcp.apigee.Api("gcpApiResource", {
configBundle: "string",
orgId: "string",
deletionPolicy: "string",
detectMd5hash: "string",
labels: {
string: "string",
},
name: "string",
});
type: gcp:apigee:Api
properties:
configBundle: string
deletionPolicy: string
detectMd5hash: string
labels:
string: string
name: string
orgId: string
Api Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Api resource accepts the following input properties:
- Config
Bundle string - Path to the config zip bundle.
- Org
Id string - The Apigee Organization name associated with the Apigee instance.
- Deletion
Policy string - (Optional) Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE".
When a 'terraform destroy' or 'pulumi up' would delete the resource,
the command will fail if this field is set to "PREVENT" in Terraform state.
When set to "ABANDON", the command will remove the resource from Terraform
management without updating or deleting the resource in the API.
When set to "DELETE", deleting the resource is allowed.
- Detect
Md5hash string - (Optional) Detect changes to local config bundle file or changes made outside of Terraform. MD5 hash of the data, encoded using base64. Hash is automatically computed without need for user input.
- Labels Dictionary<string, string>
User labels applied to this API proxy. Changing only the labels does not create a new revision.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- Name string
- The ID of the API proxy.
- Config
Bundle string - Path to the config zip bundle.
- Org
Id string - The Apigee Organization name associated with the Apigee instance.
- Deletion
Policy string - (Optional) Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE".
When a 'terraform destroy' or 'pulumi up' would delete the resource,
the command will fail if this field is set to "PREVENT" in Terraform state.
When set to "ABANDON", the command will remove the resource from Terraform
management without updating or deleting the resource in the API.
When set to "DELETE", deleting the resource is allowed.
- Detect
Md5hash string - (Optional) Detect changes to local config bundle file or changes made outside of Terraform. MD5 hash of the data, encoded using base64. Hash is automatically computed without need for user input.
- Labels map[string]string
User labels applied to this API proxy. Changing only the labels does not create a new revision.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- Name string
- The ID of the API proxy.
- config_
bundle string - Path to the config zip bundle.
- org_
id string - The Apigee Organization name associated with the Apigee instance.
- deletion_
policy string - (Optional) Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE".
When a 'terraform destroy' or 'pulumi up' would delete the resource,
the command will fail if this field is set to "PREVENT" in Terraform state.
When set to "ABANDON", the command will remove the resource from Terraform
management without updating or deleting the resource in the API.
When set to "DELETE", deleting the resource is allowed.
- detect_
md5hash string - (Optional) Detect changes to local config bundle file or changes made outside of Terraform. MD5 hash of the data, encoded using base64. Hash is automatically computed without need for user input.
- labels map(string)
User labels applied to this API proxy. Changing only the labels does not create a new revision.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- name string
- The ID of the API proxy.
- config
Bundle String - Path to the config zip bundle.
- org
Id String - The Apigee Organization name associated with the Apigee instance.
- deletion
Policy String - (Optional) Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE".
When a 'terraform destroy' or 'pulumi up' would delete the resource,
the command will fail if this field is set to "PREVENT" in Terraform state.
When set to "ABANDON", the command will remove the resource from Terraform
management without updating or deleting the resource in the API.
When set to "DELETE", deleting the resource is allowed.
- detect
Md5hash String - (Optional) Detect changes to local config bundle file or changes made outside of Terraform. MD5 hash of the data, encoded using base64. Hash is automatically computed without need for user input.
- labels Map<String,String>
User labels applied to this API proxy. Changing only the labels does not create a new revision.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- name String
- The ID of the API proxy.
- config
Bundle string - Path to the config zip bundle.
- org
Id string - The Apigee Organization name associated with the Apigee instance.
- deletion
Policy string - (Optional) Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE".
When a 'terraform destroy' or 'pulumi up' would delete the resource,
the command will fail if this field is set to "PREVENT" in Terraform state.
When set to "ABANDON", the command will remove the resource from Terraform
management without updating or deleting the resource in the API.
When set to "DELETE", deleting the resource is allowed.
- detect
Md5hash string - (Optional) Detect changes to local config bundle file or changes made outside of Terraform. MD5 hash of the data, encoded using base64. Hash is automatically computed without need for user input.
- labels {[key: string]: string}
User labels applied to this API proxy. Changing only the labels does not create a new revision.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- name string
- The ID of the API proxy.
- config_
bundle str - Path to the config zip bundle.
- org_
id str - The Apigee Organization name associated with the Apigee instance.
- deletion_
policy str - (Optional) Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE".
When a 'terraform destroy' or 'pulumi up' would delete the resource,
the command will fail if this field is set to "PREVENT" in Terraform state.
When set to "ABANDON", the command will remove the resource from Terraform
management without updating or deleting the resource in the API.
When set to "DELETE", deleting the resource is allowed.
- detect_
md5hash str - (Optional) Detect changes to local config bundle file or changes made outside of Terraform. MD5 hash of the data, encoded using base64. Hash is automatically computed without need for user input.
- labels Mapping[str, str]
User labels applied to this API proxy. Changing only the labels does not create a new revision.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- name str
- The ID of the API proxy.
- config
Bundle String - Path to the config zip bundle.
- org
Id String - The Apigee Organization name associated with the Apigee instance.
- deletion
Policy String - (Optional) Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE".
When a 'terraform destroy' or 'pulumi up' would delete the resource,
the command will fail if this field is set to "PREVENT" in Terraform state.
When set to "ABANDON", the command will remove the resource from Terraform
management without updating or deleting the resource in the API.
When set to "DELETE", deleting the resource is allowed.
- detect
Md5hash String - (Optional) Detect changes to local config bundle file or changes made outside of Terraform. MD5 hash of the data, encoded using base64. Hash is automatically computed without need for user input.
- labels Map<String>
User labels applied to this API proxy. Changing only the labels does not create a new revision.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- name String
- The ID of the API proxy.
Outputs
All input properties are implicitly available as output properties. Additionally, the Api resource produces the following output properties:
- Effective
Labels Dictionary<string, string> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Id string
- The provider-assigned unique ID for this managed resource.
- Latest
Revision stringId - The id of the most recently created revision for this API proxy.
- Md5hash string
- (Computed) Base 64 MD5 hash of the uploaded data. It is speculative as remote does not return hash of the bundle. Remote changes are detected using returned lastModified timestamp.
- Meta
Datas List<ApiMeta Data> - Metadata describing the API proxy. Structure is documented below.
- Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- Revisions List<string>
- A list of revisions of this API proxy.
- Effective
Labels map[string]string - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Id string
- The provider-assigned unique ID for this managed resource.
- Latest
Revision stringId - The id of the most recently created revision for this API proxy.
- Md5hash string
- (Computed) Base 64 MD5 hash of the uploaded data. It is speculative as remote does not return hash of the bundle. Remote changes are detected using returned lastModified timestamp.
- Meta
Datas []ApiMeta Data - Metadata describing the API proxy. Structure is documented below.
- Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- Revisions []string
- A list of revisions of this API proxy.
- effective_
labels map(string) - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id string
- The provider-assigned unique ID for this managed resource.
- latest_
revision_ stringid - The id of the most recently created revision for this API proxy.
- md5hash string
- (Computed) Base 64 MD5 hash of the uploaded data. It is speculative as remote does not return hash of the bundle. Remote changes are detected using returned lastModified timestamp.
- meta_
datas list(object) - Metadata describing the API proxy. Structure is documented below.
- pulumi_
labels map(string) - The combination of labels configured directly on the resource and default labels configured on the provider.
- revisions list(string)
- A list of revisions of this API proxy.
- effective
Labels Map<String,String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id String
- The provider-assigned unique ID for this managed resource.
- latest
Revision StringId - The id of the most recently created revision for this API proxy.
- md5hash String
- (Computed) Base 64 MD5 hash of the uploaded data. It is speculative as remote does not return hash of the bundle. Remote changes are detected using returned lastModified timestamp.
- meta
Datas List<ApiMeta Data> - Metadata describing the API proxy. Structure is documented below.
- pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- revisions List<String>
- A list of revisions of this API proxy.
- effective
Labels {[key: string]: string} - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id string
- The provider-assigned unique ID for this managed resource.
- latest
Revision stringId - The id of the most recently created revision for this API proxy.
- md5hash string
- (Computed) Base 64 MD5 hash of the uploaded data. It is speculative as remote does not return hash of the bundle. Remote changes are detected using returned lastModified timestamp.
- meta
Datas ApiMeta Data[] - Metadata describing the API proxy. Structure is documented below.
- pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- revisions string[]
- A list of revisions of this API proxy.
- effective_
labels Mapping[str, str] - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id str
- The provider-assigned unique ID for this managed resource.
- latest_
revision_ strid - The id of the most recently created revision for this API proxy.
- md5hash str
- (Computed) Base 64 MD5 hash of the uploaded data. It is speculative as remote does not return hash of the bundle. Remote changes are detected using returned lastModified timestamp.
- meta_
datas Sequence[ApiMeta Data] - Metadata describing the API proxy. Structure is documented below.
- pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- revisions Sequence[str]
- A list of revisions of this API proxy.
- effective
Labels Map<String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id String
- The provider-assigned unique ID for this managed resource.
- latest
Revision StringId - The id of the most recently created revision for this API proxy.
- md5hash String
- (Computed) Base 64 MD5 hash of the uploaded data. It is speculative as remote does not return hash of the bundle. Remote changes are detected using returned lastModified timestamp.
- meta
Datas List<Property Map> - Metadata describing the API proxy. Structure is documented below.
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- revisions List<String>
- A list of revisions of this API proxy.
Look up Existing Api Resource
Get an existing Api resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ApiState, opts?: CustomResourceOptions): Api@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
config_bundle: Optional[str] = None,
deletion_policy: Optional[str] = None,
detect_md5hash: Optional[str] = None,
effective_labels: Optional[Mapping[str, str]] = None,
labels: Optional[Mapping[str, str]] = None,
latest_revision_id: Optional[str] = None,
md5hash: Optional[str] = None,
meta_datas: Optional[Sequence[ApiMetaDataArgs]] = None,
name: Optional[str] = None,
org_id: Optional[str] = None,
pulumi_labels: Optional[Mapping[str, str]] = None,
revisions: Optional[Sequence[str]] = None) -> Apifunc GetApi(ctx *Context, name string, id IDInput, state *ApiState, opts ...ResourceOption) (*Api, error)public static Api Get(string name, Input<string> id, ApiState? state, CustomResourceOptions? opts = null)public static Api get(String name, Output<String> id, ApiState state, CustomResourceOptions options)resources: existingApi: type: gcp:apigee:Api get: id: ${id}import {
to = gcp_apigee_api.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state ApiState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state ApiState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state ApiState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state ApiState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Config
Bundle string - Path to the config zip bundle.
- Deletion
Policy string - (Optional) Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE".
When a 'terraform destroy' or 'pulumi up' would delete the resource,
the command will fail if this field is set to "PREVENT" in Terraform state.
When set to "ABANDON", the command will remove the resource from Terraform
management without updating or deleting the resource in the API.
When set to "DELETE", deleting the resource is allowed.
- Detect
Md5hash string - (Optional) Detect changes to local config bundle file or changes made outside of Terraform. MD5 hash of the data, encoded using base64. Hash is automatically computed without need for user input.
- Effective
Labels Dictionary<string, string> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Labels Dictionary<string, string>
User labels applied to this API proxy. Changing only the labels does not create a new revision.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- Latest
Revision stringId - The id of the most recently created revision for this API proxy.
- Md5hash string
- (Computed) Base 64 MD5 hash of the uploaded data. It is speculative as remote does not return hash of the bundle. Remote changes are detected using returned lastModified timestamp.
- Meta
Datas List<ApiMeta Data> - Metadata describing the API proxy. Structure is documented below.
- Name string
- The ID of the API proxy.
- Org
Id string - The Apigee Organization name associated with the Apigee instance.
- Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- Revisions List<string>
- A list of revisions of this API proxy.
- Config
Bundle string - Path to the config zip bundle.
- Deletion
Policy string - (Optional) Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE".
When a 'terraform destroy' or 'pulumi up' would delete the resource,
the command will fail if this field is set to "PREVENT" in Terraform state.
When set to "ABANDON", the command will remove the resource from Terraform
management without updating or deleting the resource in the API.
When set to "DELETE", deleting the resource is allowed.
- Detect
Md5hash string - (Optional) Detect changes to local config bundle file or changes made outside of Terraform. MD5 hash of the data, encoded using base64. Hash is automatically computed without need for user input.
- Effective
Labels map[string]string - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Labels map[string]string
User labels applied to this API proxy. Changing only the labels does not create a new revision.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- Latest
Revision stringId - The id of the most recently created revision for this API proxy.
- Md5hash string
- (Computed) Base 64 MD5 hash of the uploaded data. It is speculative as remote does not return hash of the bundle. Remote changes are detected using returned lastModified timestamp.
- Meta
Datas []ApiMeta Data Args - Metadata describing the API proxy. Structure is documented below.
- Name string
- The ID of the API proxy.
- Org
Id string - The Apigee Organization name associated with the Apigee instance.
- Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- Revisions []string
- A list of revisions of this API proxy.
- config_
bundle string - Path to the config zip bundle.
- deletion_
policy string - (Optional) Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE".
When a 'terraform destroy' or 'pulumi up' would delete the resource,
the command will fail if this field is set to "PREVENT" in Terraform state.
When set to "ABANDON", the command will remove the resource from Terraform
management without updating or deleting the resource in the API.
When set to "DELETE", deleting the resource is allowed.
- detect_
md5hash string - (Optional) Detect changes to local config bundle file or changes made outside of Terraform. MD5 hash of the data, encoded using base64. Hash is automatically computed without need for user input.
- effective_
labels map(string) - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- labels map(string)
User labels applied to this API proxy. Changing only the labels does not create a new revision.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- latest_
revision_ stringid - The id of the most recently created revision for this API proxy.
- md5hash string
- (Computed) Base 64 MD5 hash of the uploaded data. It is speculative as remote does not return hash of the bundle. Remote changes are detected using returned lastModified timestamp.
- meta_
datas list(object) - Metadata describing the API proxy. Structure is documented below.
- name string
- The ID of the API proxy.
- org_
id string - The Apigee Organization name associated with the Apigee instance.
- pulumi_
labels map(string) - The combination of labels configured directly on the resource and default labels configured on the provider.
- revisions list(string)
- A list of revisions of this API proxy.
- config
Bundle String - Path to the config zip bundle.
- deletion
Policy String - (Optional) Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE".
When a 'terraform destroy' or 'pulumi up' would delete the resource,
the command will fail if this field is set to "PREVENT" in Terraform state.
When set to "ABANDON", the command will remove the resource from Terraform
management without updating or deleting the resource in the API.
When set to "DELETE", deleting the resource is allowed.
- detect
Md5hash String - (Optional) Detect changes to local config bundle file or changes made outside of Terraform. MD5 hash of the data, encoded using base64. Hash is automatically computed without need for user input.
- effective
Labels Map<String,String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- labels Map<String,String>
User labels applied to this API proxy. Changing only the labels does not create a new revision.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- latest
Revision StringId - The id of the most recently created revision for this API proxy.
- md5hash String
- (Computed) Base 64 MD5 hash of the uploaded data. It is speculative as remote does not return hash of the bundle. Remote changes are detected using returned lastModified timestamp.
- meta
Datas List<ApiMeta Data> - Metadata describing the API proxy. Structure is documented below.
- name String
- The ID of the API proxy.
- org
Id String - The Apigee Organization name associated with the Apigee instance.
- pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- revisions List<String>
- A list of revisions of this API proxy.
- config
Bundle string - Path to the config zip bundle.
- deletion
Policy string - (Optional) Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE".
When a 'terraform destroy' or 'pulumi up' would delete the resource,
the command will fail if this field is set to "PREVENT" in Terraform state.
When set to "ABANDON", the command will remove the resource from Terraform
management without updating or deleting the resource in the API.
When set to "DELETE", deleting the resource is allowed.
- detect
Md5hash string - (Optional) Detect changes to local config bundle file or changes made outside of Terraform. MD5 hash of the data, encoded using base64. Hash is automatically computed without need for user input.
- effective
Labels {[key: string]: string} - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- labels {[key: string]: string}
User labels applied to this API proxy. Changing only the labels does not create a new revision.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- latest
Revision stringId - The id of the most recently created revision for this API proxy.
- md5hash string
- (Computed) Base 64 MD5 hash of the uploaded data. It is speculative as remote does not return hash of the bundle. Remote changes are detected using returned lastModified timestamp.
- meta
Datas ApiMeta Data[] - Metadata describing the API proxy. Structure is documented below.
- name string
- The ID of the API proxy.
- org
Id string - The Apigee Organization name associated with the Apigee instance.
- pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- revisions string[]
- A list of revisions of this API proxy.
- config_
bundle str - Path to the config zip bundle.
- deletion_
policy str - (Optional) Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE".
When a 'terraform destroy' or 'pulumi up' would delete the resource,
the command will fail if this field is set to "PREVENT" in Terraform state.
When set to "ABANDON", the command will remove the resource from Terraform
management without updating or deleting the resource in the API.
When set to "DELETE", deleting the resource is allowed.
- detect_
md5hash str - (Optional) Detect changes to local config bundle file or changes made outside of Terraform. MD5 hash of the data, encoded using base64. Hash is automatically computed without need for user input.
- effective_
labels Mapping[str, str] - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- labels Mapping[str, str]
User labels applied to this API proxy. Changing only the labels does not create a new revision.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- latest_
revision_ strid - The id of the most recently created revision for this API proxy.
- md5hash str
- (Computed) Base 64 MD5 hash of the uploaded data. It is speculative as remote does not return hash of the bundle. Remote changes are detected using returned lastModified timestamp.
- meta_
datas Sequence[ApiMeta Data Args] - Metadata describing the API proxy. Structure is documented below.
- name str
- The ID of the API proxy.
- org_
id str - The Apigee Organization name associated with the Apigee instance.
- pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- revisions Sequence[str]
- A list of revisions of this API proxy.
- config
Bundle String - Path to the config zip bundle.
- deletion
Policy String - (Optional) Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE".
When a 'terraform destroy' or 'pulumi up' would delete the resource,
the command will fail if this field is set to "PREVENT" in Terraform state.
When set to "ABANDON", the command will remove the resource from Terraform
management without updating or deleting the resource in the API.
When set to "DELETE", deleting the resource is allowed.
- detect
Md5hash String - (Optional) Detect changes to local config bundle file or changes made outside of Terraform. MD5 hash of the data, encoded using base64. Hash is automatically computed without need for user input.
- effective
Labels Map<String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- labels Map<String>
User labels applied to this API proxy. Changing only the labels does not create a new revision.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- latest
Revision StringId - The id of the most recently created revision for this API proxy.
- md5hash String
- (Computed) Base 64 MD5 hash of the uploaded data. It is speculative as remote does not return hash of the bundle. Remote changes are detected using returned lastModified timestamp.
- meta
Datas List<Property Map> - Metadata describing the API proxy. Structure is documented below.
- name String
- The ID of the API proxy.
- org
Id String - The Apigee Organization name associated with the Apigee instance.
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- revisions List<String>
- A list of revisions of this API proxy.
Supporting Types
ApiMetaData, ApiMetaDataArgs
- Created
At string - Time at which the API proxy was created, in milliseconds since epoch.
- Last
Modified stringAt - Time at which the API proxy was most recently modified, in milliseconds since epoch.
- Sub
Type string - The type of entity described
- Created
At string - Time at which the API proxy was created, in milliseconds since epoch.
- Last
Modified stringAt - Time at which the API proxy was most recently modified, in milliseconds since epoch.
- Sub
Type string - The type of entity described
- created_
at string - Time at which the API proxy was created, in milliseconds since epoch.
- last_
modified_ stringat - Time at which the API proxy was most recently modified, in milliseconds since epoch.
- sub_
type string - The type of entity described
- created
At String - Time at which the API proxy was created, in milliseconds since epoch.
- last
Modified StringAt - Time at which the API proxy was most recently modified, in milliseconds since epoch.
- sub
Type String - The type of entity described
- created
At string - Time at which the API proxy was created, in milliseconds since epoch.
- last
Modified stringAt - Time at which the API proxy was most recently modified, in milliseconds since epoch.
- sub
Type string - The type of entity described
- created_
at str - Time at which the API proxy was created, in milliseconds since epoch.
- last_
modified_ strat - Time at which the API proxy was most recently modified, in milliseconds since epoch.
- sub_
type str - The type of entity described
- created
At String - Time at which the API proxy was created, in milliseconds since epoch.
- last
Modified StringAt - Time at which the API proxy was most recently modified, in milliseconds since epoch.
- sub
Type String - The type of entity described
Import
An API proxy can be imported using any of these accepted formats:
{{org_id}}/apis/{{name}}{{org_id}}/{{name}}
When using the pulumi import command, API proxy can be imported using one of the formats above. For example:
$ pulumi import gcp:apigee/api:Api default {{org_id}}/apis/{{name}}
$ pulumi import gcp:apigee/api:Api default {{org_id}}/{{name}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.
published on Wednesday, Nov 18, 2026 by Pulumi