Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. apigee
  5. Api
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.apigee.Api

Explore with Pulumi AI

Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-gcp

To get more information about API proxies see, see:

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,
        detect_md5hash: Optional[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)
public Api(String name, ApiArgs args)
public Api(String name, ApiArgs args, CustomResourceOptions options)

type: gcp:apigee:Api
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ApiArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ApiArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ApiArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
    DetectMd5hash = "string",
    Name = "string",
});
Copy
example, err := apigee.NewApi(ctx, "gcpApiResource", &apigee.ApiArgs{
	ConfigBundle:  pulumi.String("string"),
	OrgId:         pulumi.String("string"),
	DetectMd5hash: pulumi.String("string"),
	Name:          pulumi.String("string"),
})
Copy
var gcpApiResource = new Api("gcpApiResource", ApiArgs.builder()
    .configBundle("string")
    .orgId("string")
    .detectMd5hash("string")
    .name("string")
    .build());
Copy
gcp_api_resource = gcp.apigee.Api("gcpApiResource",
    config_bundle="string",
    org_id="string",
    detect_md5hash="string",
    name="string")
Copy
const gcpApiResource = new gcp.apigee.Api("gcpApiResource", {
    configBundle: "string",
    orgId: "string",
    detectMd5hash: "string",
    name: "string",
});
Copy
type: gcp:apigee:Api
properties:
    configBundle: string
    detectMd5hash: string
    name: string
    orgId: string
Copy

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:

ConfigBundle This property is required. string
Path to the config zip bundle.

OrgId
This property is required.
Changes to this property will trigger replacement.
string
The Apigee Organization name associated with the Apigee instance.
DetectMd5hash string
Name Changes to this property will trigger replacement. string
The ID of the API proxy.
ConfigBundle This property is required. string
Path to the config zip bundle.

OrgId
This property is required.
Changes to this property will trigger replacement.
string
The Apigee Organization name associated with the Apigee instance.
DetectMd5hash string
Name Changes to this property will trigger replacement. string
The ID of the API proxy.
configBundle This property is required. String
Path to the config zip bundle.

orgId
This property is required.
Changes to this property will trigger replacement.
String
The Apigee Organization name associated with the Apigee instance.
detectMd5hash String
name Changes to this property will trigger replacement. String
The ID of the API proxy.
configBundle This property is required. string
Path to the config zip bundle.

orgId
This property is required.
Changes to this property will trigger replacement.
string
The Apigee Organization name associated with the Apigee instance.
detectMd5hash string
name Changes to this property will trigger replacement. string
The ID of the API proxy.
config_bundle This property is required. str
Path to the config zip bundle.

org_id
This property is required.
Changes to this property will trigger replacement.
str
The Apigee Organization name associated with the Apigee instance.
detect_md5hash str
name Changes to this property will trigger replacement. str
The ID of the API proxy.
configBundle This property is required. String
Path to the config zip bundle.

orgId
This property is required.
Changes to this property will trigger replacement.
String
The Apigee Organization name associated with the Apigee instance.
detectMd5hash String
name Changes to this property will trigger replacement. 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:

Id string
The provider-assigned unique ID for this managed resource.
LatestRevisionId string
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 last_modified timestamp.
MetaDatas List<ApiMetaData>
Metadata describing the API proxy. Structure is documented below.
Revisions List<string>
A list of revisions of this API proxy.
Id string
The provider-assigned unique ID for this managed resource.
LatestRevisionId string
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 last_modified timestamp.
MetaDatas []ApiMetaData
Metadata describing the API proxy. Structure is documented below.
Revisions []string
A list of revisions of this API proxy.
id String
The provider-assigned unique ID for this managed resource.
latestRevisionId String
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 last_modified timestamp.
metaDatas List<ApiMetaData>
Metadata describing the API proxy. Structure is documented below.
revisions List<String>
A list of revisions of this API proxy.
id string
The provider-assigned unique ID for this managed resource.
latestRevisionId string
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 last_modified timestamp.
metaDatas ApiMetaData[]
Metadata describing the API proxy. Structure is documented below.
revisions string[]
A list of revisions of this API proxy.
id str
The provider-assigned unique ID for this managed resource.
latest_revision_id str
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 last_modified timestamp.
meta_datas Sequence[ApiMetaData]
Metadata describing the API proxy. Structure is documented below.
revisions Sequence[str]
A list of revisions of this API proxy.
id String
The provider-assigned unique ID for this managed resource.
latestRevisionId String
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 last_modified timestamp.
metaDatas List<Property Map>
Metadata describing the API proxy. Structure is documented below.
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,
        detect_md5hash: Optional[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,
        revisions: Optional[Sequence[str]] = None) -> Api
func 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:  _:    type: gcp:apigee:Api    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ConfigBundle string
Path to the config zip bundle.

DetectMd5hash string
LatestRevisionId string
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 last_modified timestamp.
MetaDatas List<ApiMetaData>
Metadata describing the API proxy. Structure is documented below.
Name Changes to this property will trigger replacement. string
The ID of the API proxy.
OrgId Changes to this property will trigger replacement. string
The Apigee Organization name associated with the Apigee instance.
Revisions List<string>
A list of revisions of this API proxy.
ConfigBundle string
Path to the config zip bundle.

DetectMd5hash string
LatestRevisionId string
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 last_modified timestamp.
MetaDatas []ApiMetaDataArgs
Metadata describing the API proxy. Structure is documented below.
Name Changes to this property will trigger replacement. string
The ID of the API proxy.
OrgId Changes to this property will trigger replacement. string
The Apigee Organization name associated with the Apigee instance.
Revisions []string
A list of revisions of this API proxy.
configBundle String
Path to the config zip bundle.

detectMd5hash String
latestRevisionId String
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 last_modified timestamp.
metaDatas List<ApiMetaData>
Metadata describing the API proxy. Structure is documented below.
name Changes to this property will trigger replacement. String
The ID of the API proxy.
orgId Changes to this property will trigger replacement. String
The Apigee Organization name associated with the Apigee instance.
revisions List<String>
A list of revisions of this API proxy.
configBundle string
Path to the config zip bundle.

detectMd5hash string
latestRevisionId string
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 last_modified timestamp.
metaDatas ApiMetaData[]
Metadata describing the API proxy. Structure is documented below.
name Changes to this property will trigger replacement. string
The ID of the API proxy.
orgId Changes to this property will trigger replacement. string
The Apigee Organization name associated with the Apigee instance.
revisions string[]
A list of revisions of this API proxy.
config_bundle str
Path to the config zip bundle.

detect_md5hash str
latest_revision_id str
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 last_modified timestamp.
meta_datas Sequence[ApiMetaDataArgs]
Metadata describing the API proxy. Structure is documented below.
name Changes to this property will trigger replacement. str
The ID of the API proxy.
org_id Changes to this property will trigger replacement. str
The Apigee Organization name associated with the Apigee instance.
revisions Sequence[str]
A list of revisions of this API proxy.
configBundle String
Path to the config zip bundle.

detectMd5hash String
latestRevisionId String
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 last_modified timestamp.
metaDatas List<Property Map>
Metadata describing the API proxy. Structure is documented below.
name Changes to this property will trigger replacement. String
The ID of the API proxy.
orgId Changes to this property will trigger replacement. String
The Apigee Organization name associated with the Apigee instance.
revisions List<String>
A list of revisions of this API proxy.

Supporting Types

ApiMetaData
, ApiMetaDataArgs

CreatedAt string
Time at which the API proxy was created, in milliseconds since epoch.
LastModifiedAt string
Time at which the API proxy was most recently modified, in milliseconds since epoch.
SubType string
The type of entity described
CreatedAt string
Time at which the API proxy was created, in milliseconds since epoch.
LastModifiedAt string
Time at which the API proxy was most recently modified, in milliseconds since epoch.
SubType string
The type of entity described
createdAt String
Time at which the API proxy was created, in milliseconds since epoch.
lastModifiedAt String
Time at which the API proxy was most recently modified, in milliseconds since epoch.
subType String
The type of entity described
createdAt string
Time at which the API proxy was created, in milliseconds since epoch.
lastModifiedAt string
Time at which the API proxy was most recently modified, in milliseconds since epoch.
subType string
The type of entity described
created_at str
Time at which the API proxy was created, in milliseconds since epoch.
last_modified_at str
Time at which the API proxy was most recently modified, in milliseconds since epoch.
sub_type str
The type of entity described
createdAt String
Time at which the API proxy was created, in milliseconds since epoch.
lastModifiedAt String
Time at which the API proxy was most recently modified, in milliseconds since epoch.
subType 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}}
Copy
$ pulumi import gcp:apigee/api:Api default {{org_id}}/{{name}}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-gcp