Apigee terminology

Stay organized with collections Save and categorize content based on your preferences.

This page explains some basic Apigee terminology. For additional terms, see the Glossary.

Term Definition
Google Cloud projects

Google Cloud projects enable you to create and use Google Cloud services, including managing APIs, enabling billing, adding and removing collaborators, and managing permissions for Google Cloud resources.

You need to create a Google Cloud project before you can create and provision an Apigee organization.

Provisioning Provisioning is the process for installing and configuring Apigee.
Organization

An Apigee organization is a container for everything related to Apigee in your Google Cloud project, including API proxies, services, and the resources needed to support them. You create your organization during provisioning.

Environment

An Apigee environment is an isolated software environment, within an organization, where you deploy API proxies. An environment can scale to meet the demands of the proxies deployed there. You can create multiple environments in an organization.

Environment group

An environment group is a group of Apigee environments with one or more hostnames. The hostname is part of the URL used to call API proxies deployed to any environment in the environment group.

API proxy

An API proxy is an interface between incoming requests and backend services. The proxy executes policies to process all incoming requests and outgoing responses from the backend.

Deploy

You deploy an API proxy to an environment to make it accessible to clients on the internet, either publicly or privately, depending on your network configuration.

Runtime instance

A runtime instance is a deployment of the Apigee software. You create an instance during provisioning, and can later add more instances.

Instances correspond to Google Cloud regions, and there can only be one runtime instance per Cloud region.

Policy

A policy is a processing step that is executed by an API proxy. Apigee provides many pre-defined policies that perform various API tasks, such as transforming message formats or enforcing access control.

Proxy endpoint

A proxy endpoint defines the way your API proxy interacts with client applications. You configure the proxy endpoint with a basepath that is part of the URL that your API proxy responds to. The URL has the form https://hostname/basepath/pathsuffixes. See Create an API Proxy.

Target endpoint

A target endpoint defines the way your API proxy interacts with your backend services. You configure the target endpoint to forward requests to the appropriate backend service, and to define security settings, HTTP or HTTPS protocols, and other connection settings. See Changing the target endpoint.