Working with environment groups

Apigee in Cloud console

To create a new environment group in Apigee in Cloud console:

1. Open Apigee UI in Cloud console in a browser.
2. Select Management > Environments in the left navigation pane.
3. In the Environments pane, select Environment Groups.
4. Click + Create Environment Group.
5. 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.

   • Hostames: 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.
6. Click Create.

Classic Apigee

To create a new environment group in the classic Apigee UI:

1. In the Apigee UI, select Admin > Environments > Groups.
2. Click +Environment Group:

   

   The Add an Environment Group dialog displays.

3. Enter a name for your new environment group:

   

   The name can contain only lower case letters, numbers, and hyphens. In addition, it must start with a letter, be at least two characters long, and cannot end with a hyphen. Valid names include my-env-group and prod2.

4. Click Add.

   Apigee creates a new environment group. This is usually a very quick operation.

   On a successful operation, Apigee confirms that the group has been created with a banner that looks like the following:

   

   Apigee also assigns a default host name to the new group.

5. (Optional) Assign additional host names to the new group by clicking create for that group.

   Apigee displays the Environment group details pane:

   

6. Add host names to the Hostnames field. Each host name must be on a separate line.

7. Click Save when you're done.

   You can add and remove host names to this list at any time using the same procedure.

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 in Cloud console

To add an environment to an environment group in the Apigee in Cloud console:

1. Create the environment, as described in Creating environments.
2. In the Apigee UI in Cloud console, select Management > Environments in the left navigation pane.
3. In the Environments pane, select Environment Groups.
4. In the row for the environment group, click the three-dot menu under 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.

Classic Apigee

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

1. Create the environment, as described in Creating environments.
2. In the Apigee UI, select Admin > Environments > Groups.
3. Look under Unassigned to see a list of environments that are not part of an environment group:

   

   Note which environments are unassigned as you want to assign them.

4. Click create next to the environment group to which you want to add environments.

   The Environment Group Details pane displays:

   

5. To add a new environment to this group, click + in the Environments list.

   The Add environment pane displays:

   

6. Select the environment you want to add to the group and click Add.

   Apigee adds the environment to the group.

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 in Cloud console

To remove an environment from an environment group in the Apigee in Cloud console:

1. In the Apigee UI in Cloud console, select Management > Environments in the left navigation pane.
2. In the Environments pane, select Environment Groups.
3. In the row for the environment group, click the three-dot menu under 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.

Classic Apigee

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

1. In the Apigee UI, select Admin > Environments > Overview.
2. Select the environment you want to remove.
3. In the Groups pane, move the cursor to the end of the row for the group from which you want to remove the environment and click .

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 in Cloud console

To delete an environment group in the Apigee in Cloud console:

1. In the Apigee UI in Cloud console, select Management > Environments in the left navigation pane.
2. In the Environments pane, select Environment Groups.
3. In the row for the environment group, click the three-dot menu under Actions and select Delete.

Classic Apigee

To delete an environment group in the classic Apigee UI:

1. In the Apigee UI, select Admin > Environments > Groups.
2. Move the cursor to the pane for the group you want to delete.
3. Click the icon.

Apigee API

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

Apigee in Cloud console

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

1. In the Apigee UI in Cloud console, select Management > Environments in the left navigation pane.
2. In the Environments pane, select Environment Groups.
3. In the row for the environment group, click the three-dot menu under 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.

Classic Apigee

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

1. In the Apigee UI, select Admin > Environments > Groups.

2. Hover over the group's card and select create.

   The Environment group details pane displays:

   

3. In the Hostnames field, enter your new hosts.
4. Click Save to add the new hosts to the group.

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?hostnames=updateMask"
  -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.