Endpoint Object
Includes information about an endpoint for an API (Sandbox or Production).
This object is used by the following operations:
- Operations that reference the Endpoints object
The properties included in the Endpoint object are listed below.
| Property | Type | Required | Description |
|---|---|---|---|
| Category | string | Required | Describes the environment for the API version endpoint: Sandbox or Production. |
| Uri | anyURI | Required | The full URL of the endpoint, including the CNAME and path. The value for this parameter is the same as the ProductionEndpoint or SandboxEndpoint defined for the APIVersion object. |
| CName | string | Optional |
Used for a proxy API: the CNAME that the API will be called on. The value must match the hostname in the Host header (or X-Forwarded-Host header) of the request message. Typically you would register a CNAME in your DNS for your API and then map it to the URL; for example, api.acmepaymentscorp.com. |
| DeploymentZoneRule | string | Optional |
Used for a proxy API: the rule that is used to determine the deployment zone, such as a geographical area or a specific data center, that the endpoint will be proxied in. Note: To get a list of deployment zones, use the GET /api/deploymentzones operation. |
| ConnectionProperties | ConnectionProperty[ ] | Optional | For Target API only: One or more sets of additional connection properties for the API version, such as HTTP version or chunking, expressed as name/value pairs. |
| BindingQName | BindingQName | Optional | The QName for the API binding. |
| BindingType | string | Optional | The API binding type; for example, binding.http. For valid values, see API Binding Types. |
| EndpointKey | string | Optional | Unique key for the endpoint. |
| EndpointImplementationDetails | EndpointImplementationDetails | Optional | Contains information about an implementation for an API endpoint. |
| ImplementationCode | string | Optional | Code name for the API implementation. |