AquaLogic Interaction Development Kit (IDK) 6.0.0 |

# IGenericRequest.GetRemoteAPIEndpoint Method

Returns the remote API endpoint from the portal request.

Uri GetRemoteAPIEndpoint();

#### Return Value

The remote API endpoint or null if the portlet is run as a job.

#### Remarks

The remote API endpoint can be used to access the portal's remote SOAP API. To instantiate an `IRemoteSession` object, use `IPortletContext.GetRemotePortalSession()`. Note: The remote API endpoint is new functionality in portal version 5.0; this method throws `ProtocolNotSupportedException` when used with any prior version of the portal.

#### Exceptions

Exception Type | Condition
--- | ---
NotGatewayedException | The request is not gatewayed.
ProtocolNotSupportedException | Used with a version of the portal earlier than 5.0.

#### See Also

IGenericRequest Interface | Plumtree.Remote.Portlet Namespace