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

Modifies information about one or more physical service endpoints for a specific API version, implementation, service.

Notes:

Authorization Roles/Permissions: Must be logged in. Must have permission to modify the API; an API Admin or Business Admin.

This topic includes the following sections:

HTTP Method

PUT

URL

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

Sample Request

The example below shows a request to update the information for the specified API version implementation. In this example there is only one endpoint.

Sample Request URL 

https://{hostname}/api/apis/versions/f10624ed-9a23-4cb9-90d4-595d4a7c64f9.acmepaymentscorp/implementations/
Live/services/uddi:d148f207-3bfe-11e7-8c53-f1aac8715c11/endpoints

Sample request headers 

PUT /api/apis/versions/f10624ed-9a23-4cb9-90d4-595d4a7c64f9.acmepaymentscorp/
implementations/Live/services/uddi:d148f207-3bfe-11e7-8c53-f1aac8715c11/endpoints HTTP/1.1
Host: api.acmepaymentscorp.com
Accept: application/vnd.soa.v81+json
Content-Type: application/vnd.soa.v81+json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

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

{
  "Endpoint" : [ {
    "Uri" : "http://petstore.swagger.io/v2",
    "ConnectionProperties" : [ {
      "Name" : "http.version",
      "Value" : "unspecified"
    }, {
      "Name" : "http.chunked.encoding",
      "Value" : "true"
    } ],
    "BindingQName" : "{swagger_petstore.json}Swagger_Petstore_Binding_0",
    "BindingType" : "binding.http",
    "EndpointKey" : "uddi:d24ccd21-3bfe-11e7-8c53-f1aac8715c11"
  }, {
    "Uri" : "http://www.live.acmepaymentscorp.com/api",
    "ConnectionProperties" : [ {
      "Name" : "http.chunked.encoding",
      "Value" : "true"
    }, {
      "Name" : "http.version",
      "Value" : "unspecified"
    } ],
    "BindingQName" : "{swagger_petstore.json}Swagger_Petstore_Binding_0",
    "BindingType" : "binding.http",
    "EndpointKey" : "uddi:a2e9629e-3c00-11e7-8c53-f1aac8715c11"
  } ]
}

Request Headers

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

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

Any one of the following media types is valid for the request Content-Type:

application/json or application/vnd.soa.v81+json
Cookie AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
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.

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.
Endpoints Body Endpoints Required 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.

Response

If successful, this operation returns HTTP status code 200, with the updated information.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json 

HTTP/1.1 200 OK
Date: Thu, 18 May 2017 19:53:22 GMT
Content-Type: application/vnd.soa.v81+json

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

{
  "Endpoint" : [ {
    "Uri" : "http://petstore.swagger.io/v2",
    "ConnectionProperties" : [ {
      "Name" : "http.version",
      "Value" : "unspecified"
    }, {
      "Name" : "http.chunked.encoding",
      "Value" : "true"
    } ],
    "BindingQName" : "{swagger_petstore.json}Swagger_Petstore_Binding_0",
    "BindingType" : "binding.http",
    "EndpointKey" : "uddi:d24ccd21-3bfe-11e7-8c53-f1aac8715c11"
  }, {
    "Uri" : "http://www.live.acmepaymentscorp.com/api",
    "ConnectionProperties" : [ {
      "Name" : "http.chunked.encoding",
      "Value" : "true"
    }, {
      "Name" : "http.version",
      "Value" : "unspecified"
    } ],
    "BindingQName" : "{swagger_petstore.json}Swagger_Petstore_Binding_0",
    "BindingType" : "binding.http",
    "EndpointKey" : "uddi:a2e9629e-3c00-11e7-8c53-f1aac8715c11"
  } ]
}

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

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.

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 there is a typo in the URL.

You would also get this response if you use the ServiceID for a virtual service rather than for a physical service. See notes at top of page.
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.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.