Edge Management API URL for On Premises

Not applicable

I am trying to use the Management API with an On-Premises installation of Edge and can't find documentation that shows where to make calls.

http://apigee.com/docs/developers-services/content/using-edge-management-api-publish-apis

All example calls assume you're using cloud installation. Suppose my on premises Management UI console is being hosted at www.apigee.myorganization.com, how do I know where I can call the Management API to say create a proxy?

Solved Solved
0 3 2,584
1 ACCEPTED SOLUTION

sgilson
Participant V

The URL of Edge APIs for an on-prem installation are in the form:

<ManagementServer_IP>:8080/v1/<apiURI>

That means they reference port 8080 at the IP address of the Management Server. Often you will create a DNS record for <ManagementServer_IP>:8080 so that you can reference it in the form:

myEdgeAPI.com/v1/<apiURI>

Stephen

View solution in original post

3 REPLIES 3

sgilson
Participant V

The URL of Edge APIs for an on-prem installation are in the form:

<ManagementServer_IP>:8080/v1/<apiURI>

That means they reference port 8080 at the IP address of the Management Server. Often you will create a DNS record for <ManagementServer_IP>:8080 so that you can reference it in the form:

myEdgeAPI.com/v1/<apiURI>

Stephen

I have our Edge deployed on premise, we can access the Edge UI by http://x.y.z.a:9000/login. When i try http://10.8.67.4:9000/v1/users/praveen.kumar@experian.com

I do not get any response. Can you suggest if the ports are correct or am i missing something

Not applicable

For on-prem applications. you need to do following 2 configurations and then you invoke API proxy. it should work.

1) configure target servers in APIs->Environment Configuration->Target Servers as below:

Name: user-proxy-service

Host :<host-uri> // in your case 10.8.67.4

Port : <host port> // in your case 9000

2) update target Endpoints -> default.xml, HTTPTargetConnection attribute

<HTTPTargetConnection>

<Properties/>

<SSLInfo> <Enabled>true</Enabled> </SSLInfo>

<!-- <URL><host URL></URL> --> <LoadBalancer>

<Server name="user-proxy-service"/>

</LoadBalancer>

<Path>/v1/<apiURI></Path>

</HTTPTargetConnection>

//Sushma

,

when connecting to on-prem application you need to configure target server this will make sure the correct target<ManagementServer_IP>:8080/v1/<apiURI> is invoked.

1) you need to configure target server for URL in APIs->Environment Configuration->Target Servers

eg: Name: user-proxy-service

Host :<Uri for 10.8.67.4>

Port : 9000

2) Then update Target Endpoints->default.xml , HTTPTargetConnection attribute

<HTTPTargetConnection> <Properties/> <SSLInfo> <Enabled>true</Enabled> </SSLInfo> <!-- <URL><Uri for 10.8.67.4>/v1/<apiURI></URL> --> <LoadBalancer> <Server name="user-proxy-service"/> </LoadBalancer> <Path>/<apiURI></Path> </HTTPTargetConnection>