Module google_apigee1::api[][src]

Structs

Apigee

Central instance to access all Apigee related resource activities

GoogleApiHttpBody

Message that represents an arbitrary HTTP body. It should only be used for payload formats that can’t be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.

GoogleCloudApigeeV1Access

There is no detailed description.

GoogleCloudApigeeV1AccessGet

Get action. For example, “Get” : { “name” : “target.name”, “value” : “default” }

GoogleCloudApigeeV1AccessRemove

Remove action. For example, “Remove” : { “name” : “target.name”, “success” : true }

GoogleCloudApigeeV1AccessSet

Set action. For example, “Set” : { “name” : “target.name”, “success” : true, “value” : “default” }

GoogleCloudApigeeV1ActivateNatAddressRequest

Request for ActivateNatAddressRequest. Activate the nat address request.

GoogleCloudApigeeV1Alias

Reference to a certificate or key/certificate pair.

GoogleCloudApigeeV1AliasRevisionConfig

There is no detailed description.

GoogleCloudApigeeV1ApiCategory

the Api category resource wrapped with response status, error_code etc.

GoogleCloudApigeeV1ApiCategoryData

the Api category resource.

GoogleCloudApigeeV1ApiProduct

There is no detailed description.

GoogleCloudApigeeV1ApiProductRef

There is no detailed description.

GoogleCloudApigeeV1ApiProxy

Metadata describing the API proxy

GoogleCloudApigeeV1ApiProxyRevision

API proxy revision.

GoogleCloudApigeeV1ApiResponseWrapper

There is no detailed description.

GoogleCloudApigeeV1App

There is no detailed description.

GoogleCloudApigeeV1AsyncQuery

There is no detailed description.

GoogleCloudApigeeV1AsyncQueryResult

There is no detailed description.

GoogleCloudApigeeV1AsyncQueryResultView

There is no detailed description.

GoogleCloudApigeeV1Attribute

Key-value pair to store extra metadata.

GoogleCloudApigeeV1Attributes

There is no detailed description.

GoogleCloudApigeeV1CanaryEvaluation

CanaryEvaluation represents the canary analysis between two versions of the runtime that is serving requests.

GoogleCloudApigeeV1CanaryEvaluationMetricLabels

Labels that can be used to filter Apigee metrics.

GoogleCloudApigeeV1CertInfo

X.509 certificate as defined in RFC 5280.

GoogleCloudApigeeV1Certificate

There is no detailed description.

GoogleCloudApigeeV1CommonNameConfig

There is no detailed description.

GoogleCloudApigeeV1ConfigVersion

Version of the API proxy configuration schema. Currently, only 4.0 is supported.

GoogleCloudApigeeV1Credential

There is no detailed description.

GoogleCloudApigeeV1CustomReport

There is no detailed description.

GoogleCloudApigeeV1CustomReportMetric

This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum

GoogleCloudApigeeV1DataCollector

Data collector configuration.

GoogleCloudApigeeV1DataCollectorConfig

Data collector and its configuration.

GoogleCloudApigeeV1Datastore

The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository.

GoogleCloudApigeeV1DatastoreConfig

Configuration detail for datastore

GoogleCloudApigeeV1DateRange

Date range of the data to export.

GoogleCloudApigeeV1DebugMask

There is no detailed description.

GoogleCloudApigeeV1DebugSession

There is no detailed description.

GoogleCloudApigeeV1DebugSessionTransaction

A transaction contains all of the debug information of the entire message flow of an API call processed by the runtime plane. The information is collected and recorded at critical points of the message flow in the runtime apiproxy.

GoogleCloudApigeeV1DeleteCustomReportResponse

There is no detailed description.

GoogleCloudApigeeV1Deployment

There is no detailed description.

GoogleCloudApigeeV1DeploymentChangeReport

Response for GenerateDeployChangeReport and GenerateUndeployChangeReport. This report contains any validation failures that would cause the deployment to be rejected, as well changes and conflicts in routing that may occur due to the new deployment. The existence of a routing warning does not necessarily imply that the deployment request is bad, if the desired state of the deployment request is to effect a routing change. The primary purposes of the routing messages are: 1) To inform users of routing changes that may have an effect on traffic currently being routed to other existing deployments. 2) To warn users if some base path in the proxy will not receive traffic due to an existing deployment having already claimed that base path. The presence of routing conflicts/changes will not cause non-dry-run DeployApiProxy/UndeployApiProxy requests to be rejected.

GoogleCloudApigeeV1DeploymentChangeReportRoutingChange

Describes a potential routing change that may occur as a result of some deployment operation.

GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict

Describes a routing conflict that may cause a deployment not to receive traffic at some base path.

GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment

Tuple representing a base path and the deployment containing it.

GoogleCloudApigeeV1DeploymentConfig

There is no detailed description.

GoogleCloudApigeeV1Developer

There is no detailed description.

GoogleCloudApigeeV1DeveloperApp

There is no detailed description.

GoogleCloudApigeeV1DeveloperAppKey

There is no detailed description.

GoogleCloudApigeeV1DimensionMetric

This message type encapsulates a metric grouped by dimension.

GoogleCloudApigeeV1EntityMetadata

Metadata common to many entities in this API.

GoogleCloudApigeeV1Environment

There is no detailed description.

GoogleCloudApigeeV1EnvironmentConfig

There is no detailed description.

GoogleCloudApigeeV1EnvironmentGroup

EnvironmentGroup configuration. An environment group is used to group one or more Apigee environments under a single host name.

GoogleCloudApigeeV1EnvironmentGroupAttachment

EnvironmentGroupAttachment is a resource which defines an attachment of an environment to an environment group.

GoogleCloudApigeeV1EnvironmentGroupConfig

EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup and its associated routing rules.

GoogleCloudApigeeV1Export

Details of an export job.

GoogleCloudApigeeV1ExportRequest

Request body for [CreateExportRequest]

GoogleCloudApigeeV1FlowHook

There is no detailed description.

GoogleCloudApigeeV1FlowHookConfig

There is no detailed description.

GoogleCloudApigeeV1GetSyncAuthorizationRequest

Request for GetSyncAuthorization.

GoogleCloudApigeeV1GraphQLOperation

GraphQLOperation represents the pairing of graphQL operation types and the graphQL operation name.

GoogleCloudApigeeV1GraphQLOperationConfig

GraphQLOperationConfig binds the resources in a proxy or remote service with the graphQL operation and its associated quota enforcement.

GoogleCloudApigeeV1GraphQLOperationGroup

List of graphQL operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy.

GoogleCloudApigeeV1IngressConfig

There is no detailed description.

GoogleCloudApigeeV1Instance

Apigee runtime instance.

GoogleCloudApigeeV1InstanceAttachment

InstanceAttachment represents the installation of an environment onto an instance.

GoogleCloudApigeeV1InstanceDeploymentStatus

The status of a deployment as reported by a single instance.

GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision

Revisions deployed in the MPs.

GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute

Route deployed in the ingress routing table.

GoogleCloudApigeeV1KeyAliasReference

There is no detailed description.

GoogleCloudApigeeV1KeyValueMap

A collection of key, value string pairs

GoogleCloudApigeeV1Keystore

Datastore for Certificates and Aliases.

GoogleCloudApigeeV1KeystoreConfig

There is no detailed description.

GoogleCloudApigeeV1ListApiCategoriesResponse

the response for ListApiCategoriesRequest.

GoogleCloudApigeeV1ListApiProductsResponse

There is no detailed description.

GoogleCloudApigeeV1ListApiProxiesResponse

There is no detailed description.

GoogleCloudApigeeV1ListAppsResponse

There is no detailed description.

GoogleCloudApigeeV1ListAsyncQueriesResponse

The response for ListAsyncQueries.

GoogleCloudApigeeV1ListCustomReportsResponse

This message encapsulates a list of custom report definitions

GoogleCloudApigeeV1ListDataCollectorsResponse

Response for ListDataCollectors.

GoogleCloudApigeeV1ListDatastoresResponse

The response for ListDatastores

GoogleCloudApigeeV1ListDebugSessionsResponse

There is no detailed description.

GoogleCloudApigeeV1ListDeploymentsResponse

There is no detailed description.

GoogleCloudApigeeV1ListDeveloperAppsResponse

There is no detailed description.

GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse

Response for ListEnvironmentGroupAttachments.

GoogleCloudApigeeV1ListEnvironmentGroupsResponse

Response for ListEnvironmentGroups.

GoogleCloudApigeeV1ListEnvironmentResourcesResponse

Response for ListEnvironmentResources

GoogleCloudApigeeV1ListExportsResponse

The response for ListExports

GoogleCloudApigeeV1ListHybridIssuersResponse

There is no detailed description.

GoogleCloudApigeeV1ListInstanceAttachmentsResponse

Response for ListInstanceAttachments.

GoogleCloudApigeeV1ListInstancesResponse

Response for ListInstances.

GoogleCloudApigeeV1ListNatAddressesResponse

Response for ListNatAddresses.

GoogleCloudApigeeV1ListOfDevelopersResponse

There is no detailed description.

GoogleCloudApigeeV1ListOrganizationsResponse

There is no detailed description.

GoogleCloudApigeeV1ListSharedFlowsResponse

There is no detailed description.

GoogleCloudApigeeV1ListTraceConfigOverridesResponse

Response for ListTraceConfigOverrides.

GoogleCloudApigeeV1Metadata

This message type encapsulates additional information about query execution.

GoogleCloudApigeeV1Metric

This message type encapsulates the metric data point. Example: { “name”: “sum(message_count)”, “values” : [ { “timestamp”: 1549004400000, “value”: “39.0” }, { “timestamp” : 1548997200000, “value” : “0.0” } ] } or { “name”: “sum(message_count)”, “values” : [“39.0”] }

GoogleCloudApigeeV1NatAddress

Apigee NAT(network address translation) address. A NAT address is a static external IP address used for Internet egress traffic.

GoogleCloudApigeeV1Operation

Operation represents the pairing of REST resource path and the actions (verbs) allowed on the resource path.

GoogleCloudApigeeV1OperationConfig

OperationConfig binds the resources in a proxy or remote service with the allowed REST methods and its associated quota enforcement.

GoogleCloudApigeeV1OperationGroup

List of operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy.

GoogleCloudApigeeV1OptimizedStats

There is no detailed description.

GoogleCloudApigeeV1OptimizedStatsNode

This message type encapsulates a data node as represented below: { “identifier”: { “names”: [ “apiproxy” ], “values”: [ “sirjee” ] }, “metric”: [ { “env”: “prod”, “name”: “sum(message_count)”, “values”: [ 36.0 ] } ] } OR { “env”: “prod”, “name”: “sum(message_count)”, “values”: [ 36.0 ] } Depending on whether a dimension is present in the query or not the data node type can be a simple metric value or dimension identifier with list of metrics.

GoogleCloudApigeeV1OptimizedStatsResponse

This message type encapsulates a response format for Js Optimized Scenario.

GoogleCloudApigeeV1Organization

There is no detailed description.

GoogleCloudApigeeV1OrganizationProjectMapping

There is no detailed description.

GoogleCloudApigeeV1PodStatus

There is no detailed description.

GoogleCloudApigeeV1Point

Point is a group of information collected by runtime plane at critical points of the message flow of the processed API request. This is a list of supported point IDs, categorized to three major buckets. For each category, debug points that we are currently supporting are listed below: - Flow status debug points: StateChange FlowInfo Condition Execution DebugMask Error - Flow control debug points: FlowCallout Paused Resumed FlowReturn BreakFlow Error - Runtime debug points: ScriptExecutor FlowCalloutStepDefinition CustomTarget StepDefinition Oauth2ServicePoint RaiseFault NodeJS The detail information of the given debug point is stored in a list of results.

GoogleCloudApigeeV1Properties

Message for compatibility with legacy Edge specification for Java Properties object in JSON.

GoogleCloudApigeeV1Property

A single property entry in the Properties message.

GoogleCloudApigeeV1ProvisionOrganizationRequest

Request for ProvisionOrganization.

GoogleCloudApigeeV1Query

There is no detailed description.

GoogleCloudApigeeV1QueryMetadata

There is no detailed description.

GoogleCloudApigeeV1QueryMetric

More info about Metric: https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics

GoogleCloudApigeeV1Quota

Quota contains the essential parameters needed that can be applied on a proxy/remote service, resources and methods combination associated with this API product. While setting of Quota is optional, setting it prevents requests from exceeding the provisioned parameters.

GoogleCloudApigeeV1Reference

A Reference configuration. References must refer to a keystore that also exists in the parent environment.

GoogleCloudApigeeV1ReferenceConfig

There is no detailed description.

GoogleCloudApigeeV1ReportInstanceStatusRequest

Request for ReportInstanceStatus.

GoogleCloudApigeeV1ReportInstanceStatusResponse

Placeholder for future enhancements to status reporting protocol

GoogleCloudApigeeV1ReportProperty

There is no detailed description.

GoogleCloudApigeeV1ResourceConfig

There is no detailed description.

GoogleCloudApigeeV1ResourceFile

Metadata about a resource file.

GoogleCloudApigeeV1ResourceFiles

List of resource files.

GoogleCloudApigeeV1ResourceStatus

The status of a resource loaded in the runtime.

GoogleCloudApigeeV1Result

Result is short for “action result”, could be different types identified by “action_result” field. Supported types: 1. DebugInfo : generic debug info collected by runtime recorded as a list of properties. For example, the contents could be virtual host info, state change result, or execution metadata. Required fields : properties, timestamp 2. RequestMessage: information of a http request. Contains headers, request URI and http methods type.Required fields : headers, uri, verb 3. ResponseMessage: information of a http response. Contains headers, reason phrase and http status code. Required fields : headers, reasonPhrase, statusCode 4. ErrorMessage: information of a http error message. Contains detail error message, reason phrase and status code. Required fields : content, headers, reasonPhrase, statusCode 5. VariableAccess: a list of variable access actions, can be Get, Set and Remove. Required fields : accessList

GoogleCloudApigeeV1RevisionStatus

The status of a specific resource revision.

GoogleCloudApigeeV1RoutingRule

There is no detailed description.

GoogleCloudApigeeV1RuntimeTraceConfig

NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed trace in an environment.

GoogleCloudApigeeV1RuntimeTraceConfigOverride

NEXT ID: 7 Trace configuration override for a specific API proxy in an environment.

GoogleCloudApigeeV1RuntimeTraceSamplingConfig

NEXT ID: 3 RuntimeTraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs.

GoogleCloudApigeeV1Schema

Response for Schema call

GoogleCloudApigeeV1SchemaSchemaElement

Message type for the schema element

GoogleCloudApigeeV1SchemaSchemaProperty

Properties for the schema field.

GoogleCloudApigeeV1ServiceIssuersMapping

There is no detailed description.

GoogleCloudApigeeV1Session

Session carries the debug session id and its creation time.

GoogleCloudApigeeV1SharedFlow

The metadata describing a shared flow

GoogleCloudApigeeV1SharedFlowRevision

The metadata describing a shared flow revision.

GoogleCloudApigeeV1Stats

This message type encapsulates a stats response.

GoogleCloudApigeeV1StatsEnvironmentStats

This message type encapsulates the environment wrapper: “environments”: [ { “metrics”: [ { “name”: “sum(message_count)”, “values”: [ “2.52056245E8” ] } ], “name”: “prod” } ]

GoogleCloudApigeeV1StatsHostStats

This message type encapsulates the hostname wrapper: “hosts”: [ { “metrics”: [ { “name”: “sum(message_count)”, “values”: [ “2.52056245E8” ] } ], “name”: “example.com” } ]

GoogleCloudApigeeV1Subscription

Pub/Sub subscription of an environment.

GoogleCloudApigeeV1SyncAuthorization

There is no detailed description.

GoogleCloudApigeeV1TargetServer

TargetServer configuration. TargetServers are used to decouple a proxy’s TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.

GoogleCloudApigeeV1TargetServerConfig

There is no detailed description.

GoogleCloudApigeeV1TestDatastoreResponse

The response for TestDatastore

GoogleCloudApigeeV1TlsInfo

TLS configuration information for VirtualHosts and TargetServers.

GoogleCloudApigeeV1TlsInfoCommonName

There is no detailed description.

GoogleCloudApigeeV1TlsInfoConfig

There is no detailed description.

GoogleCloudApigeeV1TraceConfig

TraceConfig defines the configurations in an environment of distributed trace.

GoogleCloudApigeeV1TraceConfigOverride

A representation of a configuration override.

GoogleCloudApigeeV1TraceSamplingConfig

TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs.

GoogleCloudApigeeV1UpdateError

Details on why a resource update failed in the runtime.

GoogleIamV1AuditConfig

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { “audit_configs”: [ { “service”: “allServices”, “audit_log_configs”: [ { “log_type”: “DATA_READ”, “exempted_members”: [ “user:jose@example.com” ] }, { “log_type”: “DATA_WRITE” }, { “log_type”: “ADMIN_READ” } ] }, { “service”: “sampleservice.googleapis.com”, “audit_log_configs”: [ { “log_type”: “DATA_READ” }, { “log_type”: “DATA_WRITE”, “exempted_members”: [ “user:aliya@example.com” ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

GoogleIamV1AuditLogConfig

Provides the configuration for logging a type of permissions. Example: { “audit_log_configs”: [ { “log_type”: “DATA_READ”, “exempted_members”: [ “user:jose@example.com” ] }, { “log_type”: “DATA_WRITE” } ] } This enables ‘DATA_READ’ and ‘DATA_WRITE’ logging, while exempting jose@example.com from DATA_READ logging.

GoogleIamV1Binding

Associates members with a role.

GoogleIamV1Policy

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { “bindings”: [ { “role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ] }, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [ “user:eve@example.com” ], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } } ], “etag”: “BwWWja0YfJA=”, “version”: 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’) - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the IAM documentation.

GoogleIamV1SetIamPolicyRequest

Request message for SetIamPolicy method.

GoogleIamV1TestIamPermissionsRequest

Request message for TestIamPermissions method.

GoogleIamV1TestIamPermissionsResponse

Response message for TestIamPermissions method.

GoogleLongrunningListOperationsResponse

The response message for Operations.ListOperations.

GoogleLongrunningOperation

This resource represents a long-running operation that is the result of a network API call.

GoogleProtobufEmpty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

GoogleRpcPreconditionFailure

Describes what preconditions have failed. For example, if an RPC failed because it required the Terms of Service to be acknowledged, it could list the terms of service violation in the PreconditionFailure message.

GoogleRpcPreconditionFailureViolation

A message type used to describe a single precondition failure.

GoogleRpcStatus

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

GoogleTypeExpr

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: “Summary size limit” description: “Determines if a summary is less than 100 chars” expression: “document.summary.size() < 100” Example (Equality): title: “Requestor is owner” description: “Determines if requestor is the document owner” expression: “document.owner == request.auth.claims.email” Example (Logic): title: “Public documents” description: “Determine whether the document should be publicly visible” expression: “document.type != ‘private’ && document.type != ‘internal’” Example (Data Manipulation): title: “Notification string” description: “Create a notification string with a timestamp.” expression: “’New message received at ’ + string(document.create_time)” The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

HybridIssuerListCall

Lists hybrid services and its trusted issuers service account ids. This api is authenticated and unauthorized(allow all the users) and used by runtime authn-authz service to query control plane’s issuer service account ids.

HybridMethods

A builder providing access to all methods supported on hybrid resources. It is not used directly, but through the Apigee hub.

OrganizationAnalyticDatastoreCreateCall

Create a Datastore for an org

OrganizationAnalyticDatastoreDeleteCall

Delete a Datastore from an org.

OrganizationAnalyticDatastoreGetCall

Get a Datastore

OrganizationAnalyticDatastoreListCall

List Datastores

OrganizationAnalyticDatastoreTestCall

Test if Datastore configuration is correct. This includes checking if credentials provided by customer have required permissions in target destination storage

OrganizationAnalyticDatastoreUpdateCall

Update a Datastore

OrganizationApiCreateCall

Creates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment. Create a new API proxy by setting the name query parameter to the name of the API proxy. Import an API proxy configuration bundle stored in zip format on your local machine to your organization by doing the following: * Set the name query parameter to the name of the API proxy. * Set the action query parameter to import. * Set the Content-Type header to multipart/form-data. * Pass as a file the name of API proxy configuration bundle stored in zip format on your local machine using the file form field. Note: To validate the API proxy configuration bundle only without importing it, set the action query parameter to validate. When importing an API proxy configuration bundle, if the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client.

OrganizationApiDeleteCall

Deletes an API proxy and all associated endpoints, policies, resources, and revisions. The API proxy must be undeployed before you can delete it.

OrganizationApiDeploymentListCall

Lists all deployments of an API proxy.

OrganizationApiGetCall

Gets an API proxy including a list of existing revisions.

OrganizationApiKeyvaluemapCreateCall

Creates a key value map in an api proxy.

OrganizationApiKeyvaluemapDeleteCall

Delete a key value map in an api proxy.

OrganizationApiListCall

Lists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy.

OrganizationApiRevisionDeleteCall

Deletes an API proxy revision and all policies, resources, endpoints, and revisions associated with it. The API proxy revision must be undeployed before you can delete it.

OrganizationApiRevisionDeploymentListCall

Lists all deployments of an API proxy revision.

OrganizationApiRevisionGetCall

Gets an API proxy revision. To download the API proxy configuration bundle for the specified revision as a zip file, set the format query parameter to bundle. If you are using curl, specify -o filename.zip to save the output to a file; otherwise, it displays to stdout. Then, develop the API proxy configuration locally and upload the updated API proxy configuration revision, as described in updateApiProxyRevision.

OrganizationApiRevisionUpdateApiProxyRevisionCall

Updates an existing API proxy revision by uploading the API proxy configuration bundle as a zip file from your local machine. You can update only API proxy revisions that have never been deployed. After deployment, an API proxy revision becomes immutable, even if it is undeployed. Set the Content-Type header to either multipart/form-data or application/octet-stream.

OrganizationApiproductAttributeCall

Updates or creates API product attributes. This API replaces the current list of attributes with the attributes specified in the request body. In this way, you can update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body. Note: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the ExpiresIn element on the OAuthV2 policy won’t be able to expire an access token in less than 180 seconds.

OrganizationApiproductAttributeDeleteCall

Deletes an API product attribute.

OrganizationApiproductAttributeGetCall

Gets the value of an API product attribute.

OrganizationApiproductAttributeListCall

Lists all API product attributes.

OrganizationApiproductAttributeUpdateApiProductAttributeCall

Updates the value of an API product attribute. Note: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the ExpiresIn element on the OAuthV2 policy won’t be able to expire an access token in less than 180 seconds.

OrganizationApiproductCreateCall

Creates an API product in an organization. You create API products after you have proxied backend services using API proxies. An API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata can include: - Scope - Environments - API proxies - Extensible profile API products enable you repackage APIs on-the-fly, without having to do any additional coding or configuration. Apigee recommends that you start with a simple API product including only required elements. You then provision credentials to apps to enable them to start testing your APIs. After you have authentication and authorization working against a simple API product, you can iterate to create finer grained API products, defining different sets of API resources for each API product. WARNING: - If you don’t specify an API proxy in the request body, any app associated with the product can make calls to any API in your entire organization. - If you don’t specify an environment in the request body, the product allows access to all environments. For more information, see What is an API product?

OrganizationApiproductDeleteCall

Deletes an API product from an organization. Deleting an API product causes app requests to the resource URIs defined in the API product to fail. Ensure that you create a new API product to serve existing apps, unless your intention is to disable access to the resources defined in the API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name.

OrganizationApiproductGetCall

Gets configuration details for an API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name.

OrganizationApiproductListCall

Lists all API product names for an organization. Filter the list by passing an attributename and attibutevalue. The limit on the number of API products returned by the API is 1000. You can paginate the list of API products returned using the startKey and count query parameters.

OrganizationApiproductUpdateCall

Updates an existing API product. You must include all required values, whether or not you are updating them, as well as any optional values that you are updating. The API product name required in the request URL is the internal name of the product, not the Display Name. While they may be the same, it depends on whether the API product was created via UI or API. View the list of API products to identify their internal names.

OrganizationAppGetCall

Gets the app profile for the specified app ID.

OrganizationAppListCall

Lists IDs of apps within an organization that have the specified app status (approved or revoked) or are of the specified app type (developer or company).

OrganizationCreateCall

Creates an Apigee organization. See Create an Apigee organization.

OrganizationDatacollectorCreateCall

Creates a new data collector.

OrganizationDatacollectorDeleteCall

Deletes a data collector.

OrganizationDatacollectorGetCall

Gets a data collector.

OrganizationDatacollectorListCall

Lists all data collectors.

OrganizationDatacollectorPatchCall

Updates a data collector.

OrganizationDeleteCall

Delete an Apigee organization. Only supported for SubscriptionType TRIAL.

OrganizationDeploymentListCall

Lists all deployments of API proxies or shared flows.

OrganizationDeveloperAppAttributeCall

Updates attributes for a developer app. This API replaces the current attributes with those specified in the request.

OrganizationDeveloperAppAttributeDeleteCall

Deletes a developer app attribute.

OrganizationDeveloperAppAttributeGetCall

Returns a developer app attribute.

OrganizationDeveloperAppAttributeListCall

Returns a list of all developer app attributes.

OrganizationDeveloperAppAttributeUpdateDeveloperAppAttributeCall

Updates a developer app attribute. Note: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn element on the OAuthV2 policy won’t be able to expire an access token in less than 180 seconds.

OrganizationDeveloperAppCreateCall

Creates an app associated with a developer. This API associates the developer app with the specified API product and auto-generates an API key for the app to use in calls to API proxies inside that API product. The name is the unique ID of the app that you can use in API calls. The DisplayName (set as an attribute) appears in the UI. If you don’t set the DisplayName attribute, the name appears in the UI.

OrganizationDeveloperAppDeleteCall

Deletes a developer app. Note: The delete operation is asynchronous. The developer app is deleted immediately, but its associated resources, such as app keys or access tokens, may take anywhere from a few seconds to a few minutes to be deleted.

OrganizationDeveloperAppGenerateKeyPairOrUpdateDeveloperAppStatuCall

Manages access to a developer app by enabling you to: * Approve or revoke a developer app * Generate a new consumer key and secret for a developer app To approve or revoke a developer app, set the action query parameter to approved or revoked, respectively, and the Content-Type header to application/octet-stream. If a developer app is revoked, none of its API keys are valid for API calls even though the keys are still approved. If successful, the API call returns the following HTTP status code: 204 No Content To generate a new consumer key and secret for a developer app, pass the new key/secret details. Rather than replace an existing key, this API generates a new key. In this case, multiple key pairs may be associated with a single developer app. Each key pair has an independent status (approved or revoked) and expiration time. Any approved, non-expired key can be used in an API call. For example, if you’re using API key rotation, you can generate new keys with expiration times that overlap keys that are going to expire. You might also generate a new consumer key/secret if the security of the original key/secret is compromised. The keyExpiresIn property defines the expiration time for the API key in milliseconds. If you don’t set this property or set it to -1, the API key never expires. Notes: * When generating a new key/secret, this API replaces the existing attributes, notes, and callback URLs with those specified in the request. Include or exclude any existing information that you want to retain or delete, respectively. * To migrate existing consumer keys and secrets to hybrid from another system, see the CreateDeveloperAppKey API.

OrganizationDeveloperAppGetCall

Returns the details for a developer app.

OrganizationDeveloperAppKeyApiproductDeleteCall

Removes an API product from an app’s consumer key. After the API product is removed, the app cannot access the API resources defined in that API product. Note: The consumer key is not removed, only its association with the API product.

OrganizationDeveloperAppKeyApiproductUpdateDeveloperAppKeyApiProductCall

Approve or revoke an app’s consumer key. After a consumer key is approved, the app can use it to access APIs. A consumer key that is revoked or pending cannot be used to access an API. Any access tokens associated with a revoked consumer key will remain active. However, Apigee hybrid checks the status of the consumer key and if set to revoked will not allow access to the API.

OrganizationDeveloperAppKeyCreateCall

Creates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee hybrid from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. Note: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteDeveloperAppKey API.

OrganizationDeveloperAppKeyCreateCreateCall

Creates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee hybrid from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. Note: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteDeveloperAppKey API.

OrganizationDeveloperAppKeyDeleteCall

Deletes an app’s consumer key and removes all API products associated with the app. After the consumer key is deleted, it cannot be used to access any APIs. Note: After you delete a consumer key, you may want to: 1. Create a new consumer key and secret for the developer app using the CreateDeveloperAppKey API, and subsequently add an API product to the key using the UpdateDeveloperAppKey API. 2. Delete the developer app, if it is no longer required.

OrganizationDeveloperAppKeyGetCall

Returns details for a consumer key for a developer app, including the key and secret value, associated API products, and other information.

OrganizationDeveloperAppKeyReplaceDeveloperAppKeyCall

Updates the scope of an app. This API replaces the existing scopes with those specified in the request. Include or exclude any existing scopes that you want to retain or delete, respectively. The specified scopes must already be defined for the API products associated with the app. This API sets the scopes element under the apiProducts element in the attributes of the app.

OrganizationDeveloperAppKeyUpdateDeveloperAppKeyCall

Adds an API product to a developer app key, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes to a developer app key. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. You can use the same key to access all API products associated with the app.

OrganizationDeveloperAppListCall

Lists all apps created by a developer in an Apigee organization. Optionally, you can request an expanded view of the developer apps. A maximum of 100 developer apps are returned per API call. You can paginate the list of deveoper apps returned using the startKey and count query parameters.

OrganizationDeveloperAppUpdateCall

Updates the details for a developer app. In addition, you can add an API product to a developer app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateDeveloperAppKey API. Using this API, you cannot update the following: * App name as it is the primary key used to identify the app and cannot be changed. * Scopes associated with the app. Instead, use the ReplaceDeveloperAppKey API. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively.

OrganizationDeveloperAttributeCall

Updates developer attributes. This API replaces the existing attributes with those specified in the request. Add new attributes, and include or exclude any existing attributes that you want to retain or remove, respectively. The custom attribute limit is 18. Note: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn element on the OAuthV2 policy won’t be able to expire an access token in less than 180 seconds.

OrganizationDeveloperAttributeDeleteCall

Deletes a developer attribute.

OrganizationDeveloperAttributeGetCall

Returns the value of the specified developer attribute.

OrganizationDeveloperAttributeListCall

Returns a list of all developer attributes.

OrganizationDeveloperAttributeUpdateDeveloperAttributeCall

Updates a developer attribute. Note: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn element on the OAuthV2 policy won’t be able to expire an access token in less than 180 seconds.

OrganizationDeveloperCreateCall

Creates a developer. Once created, the developer can register an app and obtain an API key. At creation time, a developer is set as active. To change the developer status, use the SetDeveloperStatus API.

OrganizationDeveloperDeleteCall

Deletes a developer. All apps and API keys associated with the developer are also removed. Warning: This API will permanently delete the developer and related artifacts. To avoid permanently deleting developers and their artifacts, set the developer status to inactive using the SetDeveloperStatus API. Note: The delete operation is asynchronous. The developer app is deleted immediately, but its associated resources, such as apps and API keys, may take anywhere from a few seconds to a few minutes to be deleted.

OrganizationDeveloperGetCall

Returns the developer details, including the developer’s name, email address, apps, and other information. Note: The response includes only the first 100 developer apps.

OrganizationDeveloperListCall

Lists all developers in an organization by email address. By default, the response does not include company developers. Set the includeCompany query parameter to true to include company developers. Note: A maximum of 1000 developers are returned in the response. You paginate the list of developers returned using the startKey and count query parameters.

OrganizationDeveloperSetDeveloperStatuCall

Sets the status of a developer. Valid values are active or inactive. A developer is active by default. If you set a developer’s status to inactive, the API keys assigned to the developer apps are no longer valid even though the API keys are set to approved. Inactive developers can still sign in to the developer portal and create apps; however, any new API keys generated during app creation won’t work. If successful, the API call returns the following HTTP status code: 204 No Content

OrganizationDeveloperUpdateCall

Updates a developer. This API replaces the existing developer details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. The custom attribute limit is 18. Note: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn element on the OAuthV2 policy won’t be able to expire an access token in less than 180 seconds.

OrganizationEnvgroupAttachmentCreateCall

Creates a new attachment of an environment to an environment group.

OrganizationEnvgroupAttachmentDeleteCall

Deletes an environment group attachment.

OrganizationEnvgroupAttachmentGetCall

Gets an environment group attachment.

OrganizationEnvgroupAttachmentListCall

Lists all attachments of an environment group.

OrganizationEnvgroupCreateCall

Creates a new environment group.

OrganizationEnvgroupDeleteCall

Deletes an environment group.

OrganizationEnvgroupGetCall

Gets an environment group.

OrganizationEnvgroupListCall

Lists all environment groups.

OrganizationEnvgroupPatchCall

Updates an environment group.

OrganizationEnvironmentAnalyticAdminGetSchemav2Call

Gets a list of metrics and dimensions that can be used to create analytics queries and reports. Each schema element contains the name of the field, its associated type, and a flag indicating whether it is a standard or custom field.

OrganizationEnvironmentAnalyticExportCreateCall

Submit a data export job to be processed in the background. If the request is successful, the API returns a 201 status, a URI that can be used to retrieve the status of the export job, and the state value of “enqueued”.

OrganizationEnvironmentAnalyticExportGetCall

Gets the details and status of an analytics export job. If the export job is still in progress, its state is set to “running”. After the export job has completed successfully, its state is set to “completed”. If the export job fails, its state is set to failed.

OrganizationEnvironmentAnalyticExportListCall

Lists the details and status of all analytics export jobs belonging to the parent organization and environment.

OrganizationEnvironmentApiDeploymentListCall

Lists all deployments of an API proxy in an environment.

OrganizationEnvironmentApiRevisionDebugsessionCreateCall

Creates a debug session for a deployed API Proxy revision.

OrganizationEnvironmentApiRevisionDebugsessionDataGetCall

Gets the debug data from a transaction.

OrganizationEnvironmentApiRevisionDebugsessionDeleteDataCall

Deletes the data from a debug session. This does not cancel the debug session or prevent further data from being collected if the session is still active in runtime pods.

OrganizationEnvironmentApiRevisionDebugsessionGetCall

Retrieves a debug session.

OrganizationEnvironmentApiRevisionDebugsessionListCall

Lists debug sessions that are currently active in the given API Proxy revision.

OrganizationEnvironmentApiRevisionDeployCall

Deploys a revision of an API proxy. If another revision of the same API proxy revision is currently deployed, set the override parameter to true to have this revision replace the currently deployed revision. You cannot invoke an API proxy until it has been deployed to an environment. After you deploy an API proxy revision, you cannot edit it. To edit the API proxy, you must create and deploy a new revision. For a request path organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments, two permissions are required: * apigee.deployments.create on the resource organizations/{org}/environments/{env} * apigee.proxyrevisions.deploy on the resource organizations/{org}/apis/{api}/revisions/{rev}

OrganizationEnvironmentApiRevisionDeploymentGenerateDeployChangeReportCall

Generates a report for a dry run analysis of a DeployApiProxy request without committing the deployment. In addition to the standard validations performed when adding deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being created. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run DeployApiProxy request. For a request path organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateDeployChangeReport, two permissions are required: * apigee.deployments.create on the resource organizations/{org}/environments/{env} * apigee.proxyrevisions.deploy on the resource organizations/{org}/apis/{api}/revisions/{rev}

OrganizationEnvironmentApiRevisionDeploymentGenerateUndeployChangeReportCall

Generates a report for a dry run analysis of an UndeployApiProxy request without committing the undeploy. In addition to the standard validations performed when removing deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being removed. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run UndeployApiProxy request. For a request path organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateUndeployChangeReport, two permissions are required: * apigee.deployments.delete on the resource organizations/{org}/environments/{env} * apigee.proxyrevisions.undeploy on the resource organizations/{org}/apis/{api}/revisions/{rev}

OrganizationEnvironmentApiRevisionGetDeploymentCall

Gets the deployment of an API proxy revision and actual state reported by runtime pods.

OrganizationEnvironmentApiRevisionUndeployCall

Undeploys an API proxy revision from an environment. For a request path organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments, two permissions are required: * apigee.deployments.delete on the resource organizations/{org}/environments/{env} * apigee.proxyrevisions.undeploy on the resource organizations/{org}/apis/{api}/revisions/{rev}

OrganizationEnvironmentCacheDeleteCall

Deletes a cache.

OrganizationEnvironmentCreateCall

Creates an environment in an organization.

OrganizationEnvironmentDeleteCall

Deletes an environment from an organization.

OrganizationEnvironmentDeploymentListCall

Lists all deployments of API proxies or shared flows in an environment.

OrganizationEnvironmentFlowhookAttachSharedFlowToFlowHookCall

Attaches a shared flow to a flow hook.

OrganizationEnvironmentFlowhookDetachSharedFlowFromFlowHookCall

Detaches a shared flow from a flow hook.

OrganizationEnvironmentFlowhookGetCall

Returns the name of the shared flow attached to the specified flow hook. If there’s no shared flow attached to the flow hook, the API does not return an error; it simply does not return a name in the response.

OrganizationEnvironmentGetCall

Gets environment details.

OrganizationEnvironmentGetDebugmaskCall

Gets the debug mask singleton resource for an environment.

OrganizationEnvironmentGetDeployedConfigCall

Gets the deployed configuration for an environment.

OrganizationEnvironmentGetIamPolicyCall

Gets the IAM policy on an environment. For more information, see Manage users, roles, and permissions using the API. You must have the apigee.environments.getIamPolicy permission to call this API.

OrganizationEnvironmentGetTraceConfigCall

Get distributed trace configuration in an environment.

OrganizationEnvironmentKeystoreAliaseCreateCall

Creates an alias from a key/certificate pair. The structure of the request is controlled by the format query parameter: - keycertfile - Separate PEM-encoded key and certificate files are uploaded. Set Content-Type: multipart/form-data and include the keyFile, certFile, and password (if keys are encrypted) fields in the request body. If uploading to a truststore, omit keyFile. - pkcs12 - A PKCS12 file is uploaded. Set Content-Type: multipart/form-data, provide the file in the file field, and include the password field if the file is encrypted in the request body. - selfsignedcert - A new private key and certificate are generated. Set Content-Type: application/json and include CertificateGenerationSpec in the request body.

OrganizationEnvironmentKeystoreAliaseCsrCall

Generates a PKCS #10 Certificate Signing Request for the private key in an alias.

OrganizationEnvironmentKeystoreAliaseDeleteCall

Deletes an alias.

OrganizationEnvironmentKeystoreAliaseGetCall

Gets an alias.

OrganizationEnvironmentKeystoreAliaseGetCertificateCall

Gets the certificate from an alias in PEM-encoded form.

OrganizationEnvironmentKeystoreAliaseUpdateCall

Updates the certificate in an alias.

OrganizationEnvironmentKeystoreCreateCall

Creates a keystore or truststore. - Keystore: Contains certificates and their associated keys. - Truststore: Contains trusted certificates used to validate a server’s certificate. These certificates are typically self-signed certificates or certificates that are not signed by a trusted CA.

OrganizationEnvironmentKeystoreDeleteCall

Deletes a keystore or truststore.

OrganizationEnvironmentKeystoreGetCall

Gets a keystore or truststore.

OrganizationEnvironmentKeyvaluemapCreateCall

Creates a key value map in an environment.

OrganizationEnvironmentKeyvaluemapDeleteCall

Delete a key value map in an environment.

OrganizationEnvironmentOptimizedStatGetCall

This api is similar to GetStats except that the response is less verbose. In the current scheme, a query parameter _optimized instructs Edge Analytics to change the response but since this behavior is not possible with protocol buffer and since this parameter is predominantly used by Edge UI, we are introducing a separate api.

OrganizationEnvironmentQueryCreateCall

Submit a query to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In addition to the HTTP status 201, the state of “enqueued” means that the request succeeded.

OrganizationEnvironmentQueryGetCall

Get query status If the query is still in progress, the state is set to “running” After the query has completed successfully, state is set to “completed”

OrganizationEnvironmentQueryGetResultCall

After the query is completed, use this API to retrieve the results. If the request succeeds, and there is a non-zero result set, the result is downloaded to the client as a zipped JSON file. The name of the downloaded file will be: OfflineQueryResult-.zip Example: OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip

OrganizationEnvironmentQueryListCall

Return a list of Asynchronous Queries

OrganizationEnvironmentReferenceCreateCall

Creates a Reference in the specified environment.

OrganizationEnvironmentReferenceDeleteCall

Deletes a Reference from an environment. Returns the deleted Reference resource.

OrganizationEnvironmentReferenceGetCall

Gets a Reference resource.

OrganizationEnvironmentReferenceUpdateCall

Updates an existing Reference. Note that this operation has PUT semantics; it will replace the entirety of the existing Reference with the resource in the request body.

OrganizationEnvironmentResourcefileCreateCall

Creates a resource file. Specify the Content-Type as application/octet-stream or multipart/form-data. For more information about resource files, see Resource files.

OrganizationEnvironmentResourcefileDeleteCall

Deletes a resource file. For more information about resource files, see Resource files.

OrganizationEnvironmentResourcefileGetCall

Gets the contents of a resource file. For more information about resource files, see Resource files.

OrganizationEnvironmentResourcefileListCall

Lists all resource files, optionally filtering by type. For more information about resource files, see Resource files.

OrganizationEnvironmentResourcefileListEnvironmentResourceCall

Lists all resource files, optionally filtering by type. For more information about resource files, see Resource files.

OrganizationEnvironmentResourcefileUpdateCall

Updates a resource file. Specify the Content-Type as application/octet-stream or multipart/form-data. For more information about resource files, see Resource files.

OrganizationEnvironmentSetIamPolicyCall

Sets the IAM policy on an environment, if the policy already exists it will be replaced. For more information, see Manage users, roles, and permissions using the API. You must have the apigee.environments.setIamPolicy permission to call this API.

OrganizationEnvironmentSharedflowDeploymentListCall

Lists all deployments of a shared flow in an environment.

OrganizationEnvironmentSharedflowRevisionDeployCall

Deploys a revision of a shared flow. If another revision of the same shared flow is currently deployed, set the override parameter to true to have this revision replace the currently deployed revision. You cannot use a shared flow until it has been deployed to an environment. For a request path organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments, two permissions are required: * apigee.deployments.create on the resource organizations/{org}/environments/{env} * apigee.sharedflowrevisions.deploy on the resource organizations/{org}/sharedflows/{sf}/revisions/{rev}

OrganizationEnvironmentSharedflowRevisionGetDeploymentCall

Gets the deployment of a shared flow revision and actual state reported by runtime pods.

OrganizationEnvironmentSharedflowRevisionUndeployCall

Undeploys a shared flow revision from an environment. For a request path organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments, two permissions are required: * apigee.deployments.delete on the resource organizations/{org}/environments/{env} * apigee.sharedflowrevisions.undeploy on the resource organizations/{org}/sharedflows/{sf}/revisions/{rev}

OrganizationEnvironmentStatGetCall

Retrieve metrics grouped by dimensions. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. The stats api does accept dimensions as path params. The dimensions are optional in which case the metrics are computed on the entire data for the given timerange.

OrganizationEnvironmentSubscribeCall

Creates a subscription for the environment’s Pub/Sub topic. The server will assign a random name for this subscription. The “name” and “push_config” must not be specified.

OrganizationEnvironmentTargetserverCreateCall

Creates a TargetServer in the specified environment.

OrganizationEnvironmentTargetserverDeleteCall

Deletes a TargetServer from an environment. Returns the deleted TargetServer resource.

OrganizationEnvironmentTargetserverGetCall

Gets a TargetServer resource.

OrganizationEnvironmentTargetserverUpdateCall

Updates an existing TargetServer. Note that this operation has PUT semantics; it will replace the entirety of the existing TargetServer with the resource in the request body.

OrganizationEnvironmentTestIamPermissionCall

Tests the permissions of a user on an environment, and returns a subset of permissions that the user has on the environment. If the environment does not exist, an empty permission set is returned (a NOT_FOUND error is not returned).

OrganizationEnvironmentTraceConfigOverrideCreateCall

Creates a trace configuration override. The response contains a system-generated UUID, that can be used to view, update, or delete the configuration override. Use the List API to view the existing trace configuration overrides.

OrganizationEnvironmentTraceConfigOverrideDeleteCall

Deletes a distributed trace configuration override.

OrganizationEnvironmentTraceConfigOverrideGetCall

Gets a trace configuration override.

OrganizationEnvironmentTraceConfigOverrideListCall

Lists all of the distributed trace configuration overrides in an environment.

OrganizationEnvironmentTraceConfigOverridePatchCall

Updates a distributed trace configuration override. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body.

OrganizationEnvironmentUnsubscribeCall

Deletes a subscription for the environment’s Pub/Sub topic.

OrganizationEnvironmentUpdateCall

Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the Get Environment API.

OrganizationEnvironmentUpdateDebugmaskCall

Updates the debug mask singleton resource for an environment.

OrganizationEnvironmentUpdateEnvironmentCall

Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the Get Environment API.

OrganizationEnvironmentUpdateTraceConfigCall

Updates the trace configurations in an environment. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body.

OrganizationGetCall

Gets the profile for an Apigee organization. See Understanding organizations.

OrganizationGetDeployedIngressConfigCall

Gets the deployed ingress configuration for an organization.

OrganizationGetSyncAuthorizationCall

Lists the service accounts with the permissions required to allow the Synchronizer to download environment data from the control plane. An ETag is returned in the response to getSyncAuthorization. Pass that ETag when calling setSyncAuthorization to ensure that you are updating the correct version. If you don’t pass the ETag in the call to setSyncAuthorization, then the existing authorization is overwritten indiscriminately. For more information, see Configure the Synchronizer. Note: Available to Apigee hybrid only.

OrganizationHostQueryCreateCall

Submit a query at host level to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In addition to the HTTP status 201, the state of “enqueued” means that the request succeeded.

OrganizationHostQueryGetCall

Get status of a query submitted at host level. If the query is still in progress, the state is set to “running” After the query has completed successfully, state is set to “completed”

OrganizationHostQueryGetResultCall

After the query is completed, use this API to retrieve the results. If the request succeeds, and there is a non-zero result set, the result is downloaded to the client as a zipped JSON file. The name of the downloaded file will be: OfflineQueryResult-.zip Example: OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip

OrganizationHostQueryGetResultViewCall

A builder for the hostQueries.getResultView method supported by a organization resource. It is not used directly, but through a OrganizationMethods instance.

OrganizationHostQueryListCall

Return a list of Asynchronous Queries at host level.

OrganizationHostStatGetCall

Retrieve metrics grouped by dimensions in host level. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. The stats api does accept dimensions as path params. The dimensions are optional in which case the metrics are computed on the entire data for the given timerange.

OrganizationInstanceAttachmentCreateCall

Creates a new attachment of an environment to an instance. Note: Not supported for Apigee hybrid.

OrganizationInstanceAttachmentDeleteCall

Deletes an attachment. Note: Not supported for Apigee hybrid.

OrganizationInstanceAttachmentGetCall

Gets an attachment. Note: Not supported for Apigee hybrid.

OrganizationInstanceAttachmentListCall

Lists all attachments to an instance. Note: Not supported for Apigee hybrid.

OrganizationInstanceCanaryevaluationCreateCall

Creates a new canary evaluation for an organization.

OrganizationInstanceCanaryevaluationGetCall

Gets a CanaryEvaluation for an organization.

OrganizationInstanceCreateCall

Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. Note: Not supported for Apigee hybrid.

OrganizationInstanceDeleteCall

Deletes an Apigee runtime instance. The instance stops serving requests and the runtime data is deleted. Note: Not supported for Apigee hybrid.

OrganizationInstanceGetCall

Gets the details for an Apigee runtime instance. Note: Not supported for Apigee hybrid.

OrganizationInstanceListCall

Lists all Apigee runtime instances for the organization. Note: Not supported for Apigee hybrid.

OrganizationInstanceNatAddresseActivateCall

Activates the NAT address. The Apigee instance can now use this for Internet egress traffic. Note: Not supported for Apigee hybrid.

OrganizationInstanceNatAddresseCreateCall

Creates a NAT address. The address is created in the RESERVED state and a static external IP address will be provisioned. At this time, the instance will not use this IP address for Internet egress traffic. The address can be activated for use once any required firewall IP whitelisting has been completed. Note: Not supported for Apigee hybrid.

OrganizationInstanceNatAddresseDeleteCall

Deletes the NAT address. Connections that are actively using the address are drained before it is removed. Note: Not supported for Apigee hybrid.

OrganizationInstanceNatAddresseGetCall

Gets the details of a NAT address. Note: Not supported for Apigee hybrid.

OrganizationInstanceNatAddresseListCall

Lists the NAT addresses for an Apigee instance. Note: Not supported for Apigee hybrid.

OrganizationInstanceReportStatuCall

Reports the latest status for a runtime instance.

OrganizationKeyvaluemapCreateCall

Creates a key value map in an organization.

OrganizationKeyvaluemapDeleteCall

Delete a key value map in an organization.

OrganizationListCall

Lists the Apigee organizations and associated GCP projects that you have permission to access. See Understanding organizations.

OrganizationMethods

A builder providing access to all methods supported on organization resources. It is not used directly, but through the Apigee hub.

OrganizationOperationGetCall

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

OrganizationOperationListCall

Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

OrganizationOptimizedHostStatGetCall

This api is similar to GetHostStats except that the response is less verbose.

OrganizationReportCreateCall

Creates a Custom Report for an Organization. A Custom Report provides Apigee Customers to create custom dashboards in addition to the standard dashboards which are provided. The Custom Report in its simplest form contains specifications about metrics, dimensions and filters. It is important to note that the custom report by itself does not provide an executable entity. The Edge UI converts the custom report definition into an analytics query and displays the result in a chart.

OrganizationReportDeleteCall

Deletes an existing custom report definition

OrganizationReportGetCall

Retrieve a custom report definition.

OrganizationReportListCall

Return a list of Custom Reports

OrganizationReportUpdateCall

Update an existing custom report definition

OrganizationSetSyncAuthorizationCall

Sets the permissions required to allow the Synchronizer to download environment data from the control plane. You must call this API to enable proper functioning of hybrid. Pass the ETag when calling setSyncAuthorization to ensure that you are updating the correct version. To get an ETag, call getSyncAuthorization. If you don’t pass the ETag in the call to setSyncAuthorization, then the existing authorization is overwritten indiscriminately. For more information, see Configure the Synchronizer. Note: Available to Apigee hybrid only.

OrganizationSharedflowCreateCall

Uploads a ZIP-formatted shared flow configuration bundle to an organization. If the shared flow already exists, this creates a new revision of it. If the shared flow does not exist, this creates it. Once imported, the shared flow revision must be deployed before it can be accessed at runtime. The size limit of a shared flow bundle is 15 MB.

OrganizationSharedflowDeleteCall

Deletes a shared flow and all it’s revisions. The shared flow must be undeployed before you can delete it.

OrganizationSharedflowDeploymentListCall

Lists all deployments of a shared flow.

OrganizationSharedflowGetCall

Gets a shared flow by name, including a list of its revisions.

OrganizationSharedflowListCall

Lists all shared flows in the organization.

OrganizationSharedflowRevisionDeleteCall

Deletes a shared flow and all associated policies, resources, and revisions. You must undeploy the shared flow before deleting it.

OrganizationSharedflowRevisionDeploymentListCall

Lists all deployments of a shared flow revision.

OrganizationSharedflowRevisionGetCall

Gets a revision of a shared flow. To download the shared flow configuration bundle for the specified revision as a zip file, set the format query parameter to bundle. If you are using curl, specify -o filename.zip to save the output to a file; otherwise, it displays to stdout. Then, develop the shared flow configuration locally and upload the updated sharedFlow configuration revision, as described in updateSharedFlowRevision.

OrganizationSharedflowRevisionUpdateSharedFlowRevisionCall

Updates a shared flow revision. This operation is only allowed on revisions which have never been deployed. After deployment a revision becomes immutable, even if it becomes undeployed. The payload is a ZIP-formatted shared flow. Content type must be either multipart/form-data or application/octet-stream.

OrganizationSiteApicategoryCreateCall

Creates a new category on the portal.

OrganizationSiteApicategoryDeleteCall

Deletes a category from the portal.

OrganizationSiteApicategoryGetCall

Gets a category on the portal.

OrganizationSiteApicategoryListCall

Lists the categories on the portal.

OrganizationSiteApicategoryPatchCall

Updates a category on the portal.

OrganizationUpdateCall

Updates the properties for an Apigee organization. No other fields in the organization profile will be updated.

ProjectMethods

A builder providing access to all methods supported on project resources. It is not used directly, but through the Apigee hub.

ProjectProvisionOrganizationCall

Provisions a new Apigee organization with a functioning runtime. This is the standard way to create trial organizations for a free Apigee trial.

Enums

Scope

Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.