PUT /api/apis/versions/{APIVersionID}/implementations/{ImplCode}/deployments

Modifies an existing deployment of an implementation (virtual service) for a specific API version.

Notes:

To see the format of the model object and current values for your implementation, use the GET /api/apis/versions/{APIVersionID}/implementations/{ImplCode}/deploymentsuggestions operation.
To modify endpoints for the physical service, use the PUT /api/apis/versions/{ApiVersionID}/implementations/{ImplCode}/services/{ServiceID}/endpoints operation.
For a step-by-step exercise, see Example: Modifying an API Endpoint.

Authorization Roles/Permissions: Must be logged in. Must have Modify permission for this API.

This topic includes the following sections:

HTTP Method
URL
Sample Request
Request Headers
Request Parameters

Response
Sample Response
Response Headers
Response Body
Error Codes/Messages

HTTP Method

PUT

URL

https://{hostname}/api/apis/versions/{APIVersionID}/implementations/{ImplName}/deployments

Sample Request

The example below shows a request to modify the specified deployment (one deployment zone has been removed, two are left).

Sample Request URL

https://{hostname}/api/apis/versions/d7c7104f-8341-4da6-a45f-47114b4d3d7d.acmepaymentscorp/implementations/Live/deployments

Sample request headers

PUT /api/apis/versions/c8089c94-ac0d-48b3-ae1a-0ca1c9b7d7b9.acmepaymentscorp/implementations/Live/deployments HTTP/1.1
Host: {hostname}
Accept: application/json
Content-Type: application/json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "DeploymentZonesHostingInfo":[
    {
      "DeploymentZoneEndpoint":[
        {
          "DeploymentZoneID":"1c64704a-03cd-46c4-ba07-3786f8f82a8c.acmepaymentscorp",
          "EndpointKey":"uddi:bb999b1d-1d5e-457d-ae2c-ae3ef3f152a9",
          "ListenerName":"default-https",
          "EndpointHostName":"akana-qa-2.aws.akana.roguewave.com",
          "EndpointPath":"/api16982live",
          "Protocol":"https",
          "Public":false
        },
        {
          "DeploymentZoneID":"1c64704a-03cd-46c4-ba07-3786f8f82a8c.acmepaymentscorp",
          "EndpointKey":"uddi:508db7c5-2b8b-446c-be36-494cf67ec28f",
          "ListenerName":"default-http0",
          "EndpointHostName":"10.250.24.9",
          "EndpointPath":"/api16982live",
          "Protocol":"http",
          "Public":false
        }
      ],
      "DeploymentZoneID":"1c64704a-03cd-46c4-ba07-3786f8f82a8c.acmepaymentscorp"
    }
  ]
}

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.
APIImplementationDeployments	Body	APIImplementationDeployments	Required	Contains information about the deployment zones associated with a specific API version implementation, or that a specific API version implementation is eligible for based on the API version definition and deployment zone definitions.

Response

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

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

HTTP/1.1 200 OK
Date: Wed, 11 Nov 2020 20:50:58 GMT
Content-Type: application/json

Sample response body: application/json

{
  "Name":"Swagger_Petstore_5_Operations_v1_Live",
  "ImplementationCode":"Live",
  "Description":"Swagger_Petstore_5_Operations. Based on http://petstore.swagger.io/v2/swagger.json with deletions in API Designer.",
  "Pattern":"com.akana.pattern.proxy",
  "ServiceKey":"uddi:677f6db5-befe-49ef-9143-76fc26a9e43c",
  "APIBindings":{
    "APIBinding":[
      {
        "BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0",
        "BindingKey":"uddi:6d615e18-8633-144f-f525-a20e8f8b0c89",
        "InterfaceQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0",
        "InterfaceKey":"uddi:03bed5c1-1db4-4cd1-b4d9-70c828cd3c69",
        "BindingType":"binding.http",
        "BindingOperations":{
          "BindingOperation":[
            {
              "OperationName":"addPet",
              "WsdlOperationName":"addPet",
              "HttpOperation":{
                "Method":"POST",
                "Path":"/pet",
                "InputContentType":"application/xml,application/json",
                "OutputContentType":"application/xml,application/json",
                "FaultContentType":"",
                "Input":[
                  {
                    "Name":"body",
                    "Type":"entity"
                  }
                ]
              }
            },
            {
              "OperationName":"findPetsByStatus",
              "WsdlOperationName":"findPetsByStatus",
              "HttpOperation":{
                "Method":"GET",
                "Path":"/pet/findByStatus",
                "InputContentType":"",
                "OutputContentType":"application/xml,application/json",
                "FaultContentType":"",
                "Input":[
                  {
                    "Name":"status",
                    "Type":"query"
                  }
                ]
              }
            },
            {
              "OperationName":"findPetsByTags",
              "WsdlOperationName":"findPetsByTags",
              "HttpOperation":{
                "Method":"GET",
                "Path":"/pet/findByTags",
                "InputContentType":"",
                "OutputContentType":"application/xml,application/json",
                "FaultContentType":"",
                "Input":[
                  {
                    "Name":"tags",
                    "Type":"query"
                  }
                ]
              }
            },
            {
              "OperationName":"getPetById",
              "WsdlOperationName":"getPetById",
              "HttpOperation":{
                "Method":"GET",
                "Path":"/pet/{petId}",
                "InputContentType":"",
                "OutputContentType":"application/xml,application/json",
                "FaultContentType":"",
                "Input":[
                  {
                    "Name":"petId",
                    "Type":"path"
                  }
                ]
              }
            },
            {
              "OperationName":"deletePet",
              "WsdlOperationName":"deletePet",
              "HttpOperation":{
                "Method":"DELETE",
                "Path":"/pet/{petId}",
                "InputContentType":"",
                "OutputContentType":"application/xml,application/json",
                "FaultContentType":"",
                "Input":[
                  {
                    "Name":"api_key",
                    "Type":"header"
                  },
                  {
                    "Name":"petId",
                    "Type":"path"
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  },
  "APIInterfaces":{
    "APIInterface":[
      {
        "InterfaceQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0",
        "InterfaceKey":"uddi:03bed5c1-1db4-4cd1-b4d9-70c828cd3c69",
        "InterfaceOperations":{
          "InterfaceOperation":[
            {
              "OperationName":"addPet",
              "WsdlOperationName":"addPet"
            },
            {
              "OperationName":"findPetsByStatus",
              "WsdlOperationName":"findPetsByStatus"
            },
            {
              "OperationName":"findPetsByTags",
              "WsdlOperationName":"findPetsByTags"
            },
            {
              "OperationName":"getPetById",
              "WsdlOperationName":"getPetById"
            },
            {
              "OperationName":"deletePet",
              "WsdlOperationName":"deletePet"
            }
          ]
        }
      }
    ]
  },
  "Endpoints":{
    "Endpoint":[
      {
        "Category":"Production",
        "Uri":"https://akana-qa-2.aws.akana.roguewave.com:9443/api16982live",
        "CName":"akana-qa-2.aws.akana.roguewave.com",
        "DeploymentZoneRule":"9d5d-ffd4-4e6a-9334-bd850387eed9default-https",
        "ConnectionProperties":[
          {
            "Name":"virtualHost",
            "Value":"akana-qa-2.aws.akana.roguewave.com"
          },
          {
            "Name":"gateway_hostname",
            "Value":"akana-qa-2.aws.akana.roguewave.com"
          },
          {
            "Name":"visibility",
            "Value":"private"
          }
        ],
        "BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0",
        "BindingType":"binding.http",
        "EndpointKey":"uddi:bb999b1d-1d5e-457d-ae2c-ae3ef3f152a9",
        "EndpointImplementationDetails":{
          "DeploymentZoneEndpoint":{
            "DeploymentZoneID":"1c64704a-03cd-46c4-ba07-3786f8f82a8c.acmepaymentscorp",
            "EndpointKey":"uddi:bb999b1d-1d5e-457d-ae2c-ae3ef3f152a9",
            "ListenerName":"default-https",
            "ContainerKey":"9d5d-ffd4-4e6a-9334-bd850387eed9",
            "GatewayHostName":"akana-qa-2.aws.akana.roguewave.com",
            "GatewayHostPath":"/",
            "EndpointHostName":"akana-qa-2.aws.akana.roguewave.com",
            "EndpointPath":"/api16982live",
            "Protocol":"https",
            "Path":"/api16982live",
            "Url":"https://akana-qa-2.aws.akana.roguewave.com:9443/api16982live",
            "BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0",
            "BindingType":"binding.http",
            "Public":false
          }
        },
        "ImplementationCode":"Live"
      },
      {
        "Category":"Production",
        "Uri":"http://10.250.24.9:7905/api16982live",
        "CName":"10.250.24.9",
        "DeploymentZoneRule":"9d5d-ffd4-4e6a-9334-bd850387eed9default-http0",
        "ConnectionProperties":[
          {
            "Name":"virtualHost",
            "Value":"10.250.24.9"
          },
          {
            "Name":"gateway_hostname",
            "Value":"10.250.24.9"
          },
          {
            "Name":"visibility",
            "Value":"private"
          }
        ],
        "BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0",
        "BindingType":"binding.http",
        "EndpointKey":"uddi:508db7c5-2b8b-446c-be36-494cf67ec28f",
        "EndpointImplementationDetails":{
          "DeploymentZoneEndpoint":{
            "DeploymentZoneID":"1c64704a-03cd-46c4-ba07-3786f8f82a8c.acmepaymentscorp",
            "EndpointKey":"uddi:508db7c5-2b8b-446c-be36-494cf67ec28f",
            "ListenerName":"default-http0",
            "ContainerKey":"9d5d-ffd4-4e6a-9334-bd850387eed9",
            "GatewayHostName":"10.250.24.9",
            "GatewayHostPath":"/",
            "EndpointHostName":"10.250.24.9",
            "EndpointPath":"/api16982live",
            "Protocol":"http",
            "Path":"/api16982live",
            "Url":"http://10.250.24.9:7905/api16982live",
            "BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0",
            "BindingType":"binding.http",
            "Public":false
          }
        },
        "ImplementationCode":"Live"
      }
    ]
  },
  "Policies":{
    "Policy":[
      {
        "PolicyKey":"acmepaymentscorp-AtmosphereApplicationSecurityPolicy",
        "Name":"AtmosphereApplicationSecurityPolicy",
        "Description":"",
        "PolicyType":"Operational Policy",
        "PolicySubType":"policy.apisec"
      }
    ]
  },
  "APIImplementationDeployments":{
    "DeploymentZonesHostingInfo":[
      {
        "DeploymentZoneID":"1c64704a-03cd-46c4-ba07-3786f8f82a8c.acmepaymentscorp",
        "DeploymentZoneEndpoint":[
          {
            "DeploymentZoneID":"1c64704a-03cd-46c4-ba07-3786f8f82a8c.acmepaymentscorp",
            "EndpointKey":"uddi:bb999b1d-1d5e-457d-ae2c-ae3ef3f152a9",
            "ListenerName":"default-https",
            "ContainerKey":"9d5d-ffd4-4e6a-9334-bd850387eed9",
            "GatewayHostName":"akana-qa-2.aws.akana.roguewave.com",
            "GatewayHostPath":"/",
            "EndpointHostName":"akana-qa-2.aws.akana.roguewave.com",
            "EndpointPath":"/api16982live",
            "Protocol":"https",
            "Path":"/api16982live",
            "Url":"https://akana-qa-2.aws.akana.roguewave.com:9443/api16982live",
            "BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0",
            "BindingType":"binding.http",
            "Public":false
          },
          {
            "DeploymentZoneID":"1c64704a-03cd-46c4-ba07-3786f8f82a8c.acmepaymentscorp",
            "EndpointKey":"uddi:508db7c5-2b8b-446c-be36-494cf67ec28f",
            "ListenerName":"default-http0",
            "ContainerKey":"9d5d-ffd4-4e6a-9334-bd850387eed9",
            "GatewayHostName":"10.250.24.9",
            "GatewayHostPath":"/",
            "EndpointHostName":"10.250.24.9",
            "EndpointPath":"/api16982live",
            "Protocol":"http",
            "Path":"/api16982live",
            "Url":"http://10.250.24.9:7905/api16982live",
            "BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0",
            "BindingType":"binding.http",
            "Public":false
          }
        ]
      }
    ]
  },
  "Operations":{
    "Operation":[
      {
        "Name":"addPet",
        "OperationKey":"a427df55-57fa-4473-b020-22683e4cafe1",
        "InterfaceQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0",
        "WsdlOperationName":"addPet"
      },
      {
        "Name":"deletePet",
        "OperationKey":"793c0b47-5a58-4d6a-b298-28c6831b9a8e",
        "InterfaceQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0",
        "WsdlOperationName":"deletePet"
      },
      {
        "Name":"findPetsByStatus",
        "OperationKey":"f37bd500-10bb-4e99-a1c1-db530e292ce4",
        "InterfaceQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0",
        "WsdlOperationName":"findPetsByStatus"
      },
      {
        "Name":"findPetsByTags",
        "OperationKey":"47eac814-e379-495a-8746-42698f4bc187",
        "InterfaceQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0",
        "WsdlOperationName":"findPetsByTags"
      },
      {
        "Name":"getPetById",
        "OperationKey":"b3277e80-0e01-410e-b6bb-6bc891f37172",
        "InterfaceQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0",
        "WsdlOperationName":"getPetById"
      }
    ]
  },
  "AnonymousAccessAllowed":true,
  "EndpointAccessAutoApproved":true,
  "ProxyImplementationDetails":{
    "ProxiedService":{
      "ServiceKey":"uddi:c163d2c6-f432-4a16-adc8-7f01d5e56238",
      "ServiceName":"Swagger_Petstore_5_Operations_v1_Live_Target",
      "OrganizationKey":"uddi:8c3807c7-2b1c-4846-bbce-9901f591bad0",
      "Endpoints":{
        "Endpoint":[
          {
            "Uri":"HTTP://api577172live.gateway.akana.com:80/",
            "ConnectionProperties":[
              
            ],
            "BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0",
            "BindingType":"binding.http",
            "EndpointKey":"uddi:51cdbce3-4dc5-42dc-a2d2-e92797e9f5e1"
          },
          {
            "Uri":"HTTPS://api577172live.gateway.akana.com:80/",
            "ConnectionProperties":[
              
            ],
            "BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0",
            "BindingType":"binding.http",
            "EndpointKey":"uddi:9c2d8b6f-0045-42f2-b70e-530e216000cb"
          }
        ]
      }
    }
  }
}

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
APIImplementation	APIImplementation	Contains information about an implementation for a specific API version.

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
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.