The virtual service—the endpoint that you'll use if your API is hosted on the Akana API Platform. API users send messages to the virtual endpoint, and the platform applies policies, monitors traffic etc. and relays messages to the physical service endpoint. For example: http://api.acmepaymentscorp.com/api10410live.

Before starting, you'll need:

A valid UserID and password for portal access.

API Admin rights to the API you want to modify.

Operations to run to modify an endpoint for a virtual service

The key operation to run for modifying a virtual service endpoint is: PUT /api/apis/versions/{APIVersionID}/implementations/{ImplCode}/deployments. Other operations in the example below will help you to get authenticated and then to discover any other IDs or information you'll need to successfully run the operation, such as path parameters and request body. If you already have that information you can skip those operations.

Modify the endpoint

Use the response from the previous operation in the request body, and modify the endpoint (EndpointPath value). For example, you might change the context path from /api10411live to /api12345live. Do not change the hostname since it is hosted on the developer portal. Make sure you change it in all three places:

EndpointPath

Path

Url

Review the response. You'll see that the new endpoint appears in the response, in theEndpointPath, Path, and Url fields for the deployment zone, and the URI field for the endpoint.