GET /api/apis/versions/{ApiVersionID}/implementations/{ImplCode}/services/{ServiceID}/endpoints

Returns information about one or more endpoints (physical service or virtual service) for a specific API version, implementation, service.

Notes:

For more information, see Example: Modifying an API Endpoint.

Authorization Roles/Permissions: Must be logged in. Must be a user with Read authorization to view information about the API.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apis/versions/{ApiVersionID}/implementations/{ImplCode}/services/{ServiceID}/endpoints

Back to top

Sample Request

The example below shows a request for the service endpoints for a specific API version implementation.

Request URL

https://{hostname}/api/apis/versions/apis/versions/46bf4ba-3812-4233-beb6-2801a3ea7c3d.acmepaymentscorp/implementations/Live/services/{ServiceID}/endpoints

Sample request headers

Accept: application/vnd.soa.v81+json
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept application/json, application/vnd.soa.v81+json
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
APIVersionID Path string Required The unique ID for a specific API version.
ImplCode Path string Required A code for a specific implementation. Valid values: Live or Sandbox.
ServiceID Path string Required The unique ID for a specific service; either a proxied API service or a physical service. Sometimes also called the ServiceKey. If you're not sure how to find this value, run the GET /api/apis/versions/{APIVersionID}/implementations/{ImplCode} operation. For an explanation of where the physical and virtual service keys occur in the response, see Get the Service ID for the physical service.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the specified endpoint.

Back to top

Sample Response #1: Physical Service

The sample response below shows successful completion of this operation when the ServiceID of the physical service is used. Both examples are for the same API version.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/vnd.soa.v81+json
Date: Thu, 16 Aug 2018 20:23:25 GMT

Sample response body: application/vnd.soa.v81+json

{
  "Endpoint":[
    {
      "Uri":"http://www.example.com",
      "ConnectionProperties":[
        {
          "Name":"http.chunked.encoding",
          "Value":"true"
        },
        {
          "Name":"http.version",
          "Value":"unspecified"
        }
      ],
      "BindingQName":"{Example_API_v1}Example_API_Binding_0",
      "BindingType":"binding.http",
      "EndpointKey":"uddi:49e5e372-a16d-11e8-a68b-b00208de673a"
    }
  ]
}

Sample Response #2: Virtual Service

The sample response below shows successful completion of this operation when the ServiceID of the virtual service is used. Both examples are for the same API version.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/vnd.soa.v81+json
Date: Thu, 16 Aug 2018 20:25:46 GMT

Sample response body: application/vnd.soa.v81+json

{
  "Endpoint":[
    {
      "Uri":"http://platformtenant.akana.com:7905/api88887live",
      "ConnectionProperties":[
        {
          "Name":"gateway_hostname",
          "Value":"platformtenant.akana.com"
        },
        {
          "Name":"visibility",
          "Value":"public"
        },
        {
          "Name":"virtualHost",
          "Value":"platformtenant.akana.com"
        }
      ],
      "BindingQName":"{Example_API_v1}Example_API_Binding_0",
      "BindingType":"binding.http",
      "EndpointKey":"uddi:94b1862f-a183-11e8-a68b-b00208de673a"
    }
  ]
}

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type application/json, application/vnd.soa.v81+json

Back to top

Response Body

Name Type Description
Endpoints Endpoints 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.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
400 Bad request: Returned if the client sends invalid parameters or body content. For example, you might get this response if you left one of the placeholder values in your URL, instead of using a valid value.
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
404 The resource could not be found. For example, you might get this if you include an invalid APIVersionID.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics