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 have permission to modify the API; an API Admin or Business Admin.

This topic includes the following sections:

HTTP Method

PUT

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 to update the information for the specified API version implementation. In this example there is only one endpoint.

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

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"
  } ]
}

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
Content-Type

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

application/json or 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.

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 proxied API service. Sometimes also called the ServiceKey.
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.

Back to top

Response

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

Back to top

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"
  } ]
}

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 send malformed XML in your request, or if there is a typo in the URL.
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.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics