Endpoints Object
Includes information about the set of Endpoint objects containing the URL hosting the API, and the category of each. The TargetAPI can have endpoints for Live or Sandbox implementations and can also have more than one of each.
If two or more endpoints are defined for a particular category, the system will load-balance across all endpoints for that category.
This object is used by the following operations:
- PUT /api/apis/versions/{ApiVersionID}/implementations/{ImplCode}/services/{ServiceID}/endpoints (in request and response)
- GET /api/apis/versions/{ApiVersionID}/implementations/{ImplCode}/services/{ServiceID}/endpoints (in response)
- Operations that reference the APIVersion object
- Operations that reference the TargetAPI object
- Operations that reference the APIImplementation object
The properties included in the Endpoints object are listed below.
| Property | Type | Required | Description |
|---|---|---|---|
| Endpoint | Endpoint[ ] | Optional | Information about one or more endpoints for the API. |