Setting the URL of the portal

Apigee provides you with Apigee Developer Services portal (or simply, the portal) that you can use to build and launch your own customized website to provide all of these services to your development community. Edge customers can create their own developer portal, either in the cloud or on-premises. See What is a developer portal? for more information.

The New Edge UI displays the DevPortal button on the Publish > Portals (or Publish > Developers) page that, when clicked, opens the portal associated with an organization. By default, that button opens the following URL:

http://live-orgname.devportal.apigee.com

Where orgname is the name of the organization.

You can configure the developer portal URL at the organization level using organization properties, or configure a global fallback URL template in the New Edge UI.

Set the portal URL for an organization

You can set the portal URL to a different URL for a specific organization, or disable the button completely, by setting the following properties on the organization:

features.devportalDisabled: Set to false (default) to enable the button and to true to disable it.
features.devportalUrl: Set to the URL of the developer portal for the organization.

You set these properties separately for each organization. To set these properties, first use the following API call to determine the current property settings on the organization:

curl -H "Content-Type:application/json" -u adminEmail:pword -X GET \
  http://ms_IP:8080/v1/organizations/orgname

This call returns an object describing the organization in the form:

{
  "createdAt" : 1428676711119,
  "createdBy" : "me@my.com",
  "displayName" : "orgname",
  "environments" : [ "prod" ],
  "lastModifiedAt" : 1428692717222,
  "lastModifiedBy" : "me@my.com",
  "name" : "orgname",
  "properties" : {
    "property" : [ {
      "name" : "foo",
      "value" : "bar"
    } ]
  },
  "type" : "paid"
}

Note any existing properties in the properties area of the object. When you set properties on the organization, the value in properties overwrites any current properties. Therefore, if you want to set features.devportalDisabled or features.devportalUrl in the organization, make sure you copy any existing properties when you set them.

Use the following PUT call to set properties on the organization:

curl -H "Content-Type:application/json" -u adminEmail:pword -X PUT \
  http://ms_IP:8080/v1/organizations/orgname \
  -d '{
    "displayName" : "orgname",
    "name" : "orgname",
    "properties" : {
      "property" : [
        {
          "name" : "foo",
          "value" : "bar"
        },
        {
          "name": "features.devportalUrl",
          "value": "http://dev-orgname.devportal.apigee.com/"
        },
        {
          "name": "features.devportalDisabled",
          "value": "false"
        }
      ]
    }
  }'

In the PUT call, you only have to specify displayName, name, and properties. Note that this call includes the foo property that was originally set on the organization.

Set a global fallback portal URL template in the New Edge UI

If features.devportalUrl is not set on an organization, the New Edge UI uses the global fallback template defined by conf_uebe_dev_portal_template (which defaults to http://live-{org}.devportal.apigee.com, where {org} is replaced with the organization name).

To change the global fallback URL template in the New Edge UI:

Open /opt/apigee/customer/application/management-ui.properties in an editor. If the file does not exist, create it:
```
vi /opt/apigee/customer/application/management-ui.properties
```
Set conf_uebe_dev_portal_template using {org} as the placeholder for the organization name:
```
conf_uebe_dev_portal_template="https://portal.mycompany.com/{org}"
```

Save your changes and make sure the file is owned by the apigee user:

chown apigee:apigee /opt/apigee/customer/application/management-ui.properties

Restart the New Edge UI:

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart