Working with environment groups

Apigee UI

To create a new environment group in the Apigee UI:

1. In the Google Cloud console, go to the Apigee > Management > Environments page.

   Go to Environments

2. In the Environments pane, select Environment Groups.
3. Click + Create Environment Group.
4. Enter the following:
   • Environment group name: A name for the environment group. The name must start and end with an alphanumeric character. It can have up to 63 characters consisting of alphanumeric characters and hyphens. The name must be different from any existing environment group name in your organization.

   • Hostnames: A list of host names that can be used to call proxies. Each host name must be on a separate line.

     You also have the option to click Configure Google Load Balancer with these domains. This opens the Load balancing page in the Cloud console, where you can configure load balancing for the host names.

   • Environments: An optional list of environments to include in the environment group.
5. Click Create.

Apigee API

To create a new environment group using the Apigee API, send a POST request to the Create environment groups API. Before calling the API, be sure that you have a valid token, as described in Obtaining an OAuth 2.0 access token.

The following example curl command shows the syntax to create a new group:

curl -i $TOKEN -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/envgroups?name=new-group-name

When specifying the new group's name, you must use only lower case letters, numbers, and hyphens (a-z, A-Z, and -). You cannot use upper case letters or any special characters other than hyphens. You must also start the name with a lower case letter.

If you don't specify any additional parameters, this command creates a new group with no host names assigned to it.

You can also assign host names when you create the group by specifying them as an array in the body of the request.

The following example creates a new group my-group and assigns three new host names to the new group:

curl -i $TOKEN -X POST \
  https://apigee.googleapis.com/v1/organizations/org_name/envgroups?name=my-group \
  -d '{ \
    "hostnames": ["server1.mycompany.com", "server2.mycompany.com", "10.1.142.8"] \
  }'

You can later change the host names in the list by sending a PATCH request to the Patch environment groups API.

Apigee UI

To add an environment to an environment group in the Apigee UI:

1. Create the environment, as described in Creating environments.

2. In the Google Cloud console, go to the Apigee > Management > Environments page.

   Go to Environments

3. In the Environments pane, select Environment Groups.
4. In the environment group row, click more_vert Actions, and select Edit.
5. In the Edit Environment Group pane, under Environments (Optional), select the environment you want to add to the environment group.
6. Click Update.

Apigee API

To add a new environment to an environment group using the Apigee API, send a POST request to the Environment group attachment API, as the following example shows:

curl -H "Authorization: Bearer $TOKEN" -X POST
  "https://apigee.googleapis.com/v1/organizations/my-org/envgroups/test-group/attachments"
  -d '{
    "name": "my-attachment",
    "environment": "test"
  }'

Where:

• $TOKEN is set to your OAuth 2.0 access token, as described in Obtaining an OAuth 2.0 access token.
• The body of the request contains the name of the attachment as well as the name of the new environment.

The body of the request contains an instance of an EnvironmentGroupAttachment resource, which is a simple wrapper around a single environment.

If successful, the response contains details about the new attachment, including the timestamp at which it was created; for example:

{
  "name": "my-attachment",
  "environment": "test"
  "createdAt": "42"
}

Apigee UI

To remove an environment from an environment group in the Apigee UI:

1. In the Google Cloud console, go to the Apigee > Management > Environments page.

   Go to Environments

2. In the Environments pane, select Environment Groups.
3. In the environment group row, click more_vert Actions, and select Edit.
4. In the Edit Environment Group pane, under Environments (Optional), deselect the environment you want to remove from the environment group.
5. Click Update.

Apigee API

To remove an environment from an environment group using the Apigee API, use the delete method in the EnvironmentGroupAttachment resource to delete the attachment corresponding to the environment.

Apigee UI

To delete an environment group in the Apigee UI:

1. In the Google Cloud console, go to the Apigee > Management > Environments page.

   Go to Environments

2. In the Environments pane, select Environment Groups.
3. In the environment group row, click more_vert Actions, and select Edit.

Apigee API

To delete an environment group using the Apigee API, use the delete method in the EnvironmentGroup resource.

Apigee UI

To add a host name to an environment group in the Apigee UI:

1. In the Google Cloud console, go to the Apigee > Management > Environments page.

   Go to Environments

2. In the Environments pane, select Environment Groups.
3. In the environment group row, click more_vert Actions, and select Edit.
4. In the Edit Environment Group pane, under Hostnames, enter the host name name you want to add to the environment group.
5. Click Update.

Apigee API

To add host names to an environment group using the Apigee API, send a PATCH request to the Patch environment groups API. Be sure to set the updateMask parameter to hostnames and specify the entire list of host names that you want: the value of that field in your request replaces the existing list.

The following example sets the host names for the test environment:

curl -H "Authorization: Bearer $TOKEN" -X PATCH
  "https://apigee.googleapis.com/v1/organizations/my-org/envgroups/test-group?updateMask=hostnames"
  -d '{
    "name": "my-hostnames",
    "hostnames": [
      "test-1.example.com",
      "test-2.example.com",
      "test-3.example.com"
    ]
  }'

Where:

• $TOKEN is set to your OAuth 2.0 access token, as described in Obtaining an OAuth 2.0 access token.
• The payload of the request specifies a name for the array of hostname attachments, plus the array of names themselves.

If the request was successful, the response contains an Operation resource.