DELETE /api/apis/versions/{APIVersionID}/implementations/{ImplName}

Deletes the specified implementation for the specified API version.

Note: When you delete an implementation, all apps are disconnected from the implementation, and all process configuration, policies, and endpoints are deleted. This action is not reversible.

Authorization Roles/Permissions: Must be logged in. Must have Delete 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

DELETE

URL

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

Sample Request

The example below shows a request to delete the Live implementation for the specified API version.

Sample Request URL

https://{hostname}/api/apis/versions/8acefc82-4307-4f02-975d-fd972cc1f34c.acmepaymentscorp/implementations/live

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.

Request Headers

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

Header	Description
Accept	application/json, 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.
ImplName	Path	string	Required	The name for a specific implementation of an API version.

Response

If successful, this operation returns HTTP status code 200.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Content-Type: application/vnd.soa.v81+json
Date: Wed, 11 Nov 2020 20:06:47 GMT

Sample response body

{
  "Name":"Swagger_Petstore_5_Operations_Gen_v2 (cloning an API that has policies)_Live",
  "ImplementationCode":"Live",
  "Pattern":"com.akana.pattern.proxy",
  "ServiceKey":"uddi:d49168c1-f104-4fbe-be6b-d6de9f13a42f",
  "APIBindings":{
    "APIBinding":[
      {
        "BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0_0",
        "BindingKey":"uddi:9d735b35-88f4-a68e-0bc7-73fdb69cde6e",
        "InterfaceQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0_0",
        "InterfaceKey":"uddi:ba330199-590d-4be9-beec-e916daf85c9a",
        "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_0",
        "InterfaceKey":"uddi:ba330199-590d-4be9-beec-e916daf85c9a",
        "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/api17080live",
        "DeploymentZoneRule":"9d5d-ffd4-4e6a-9334-bd850387eed9default-https",
        "ConnectionProperties":[
          
        ],
        "BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0_0",
        "BindingType":"binding.http",
        "EndpointKey":"uddi:099ee1b5-d05a-4029-b07e-6b3ed32ebb63",
        "EndpointImplementationDetails":{
          "DeploymentZoneEndpoint":{
            "DeploymentZoneID":"1c64704a-03cd-46c4-ba07-3786f8f82a8c.acmepaymentscorp",
            "EndpointKey":"uddi:099ee1b5-d05a-4029-b07e-6b3ed32ebb63",
            "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":"/api17080live",
            "Protocol":"https",
            "Path":"/api17080live",
            "Url":"https://akana-qa-2.aws.akana.roguewave.com:9443/api17080live",
            "BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0_0",
            "BindingType":"binding.http",
            "Public":true
          }
        },
        "ImplementationCode":"Live"
      },
      {
        "Category":"Production",
        "Uri":"http://10.250.24.9:7905/api17080live",
        "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":"public"
          }
        ],
        "BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0_0",
        "BindingType":"binding.http",
        "EndpointKey":"uddi:f9bd764f-8f09-4176-8997-792494dcb41d",
        "EndpointImplementationDetails":{
          "DeploymentZoneEndpoint":{
            "DeploymentZoneID":"1c64704a-03cd-46c4-ba07-3786f8f82a8c.acmepaymentscorp",
            "EndpointKey":"uddi:f9bd764f-8f09-4176-8997-792494dcb41d",
            "ListenerName":"default-http0",
            "ContainerKey":"9d5d-ffd4-4e6a-9334-bd850387eed9",
            "GatewayHostName":"10.250.24.9",
            "GatewayHostPath":"/",
            "EndpointHostName":"10.250.24.9",
            "EndpointPath":"/api17080live",
            "Protocol":"http",
            "Path":"/api17080live",
            "Url":"http://10.250.24.9:7905/api17080live",
            "BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0_0",
            "BindingType":"binding.http",
            "Public":true
          }
        },
        "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:099ee1b5-d05a-4029-b07e-6b3ed32ebb63",
            "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":"/api17080live",
            "Protocol":"https",
            "Path":"/api17080live",
            "Url":"https://akana-qa-2.aws.akana.roguewave.com:9443/api17080live",
            "BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0_0",
            "BindingType":"binding.http",
            "Public":true
          },
          {
            "DeploymentZoneID":"1c64704a-03cd-46c4-ba07-3786f8f82a8c.acmepaymentscorp",
            "EndpointKey":"uddi:f9bd764f-8f09-4176-8997-792494dcb41d",
            "ListenerName":"default-http0",
            "ContainerKey":"9d5d-ffd4-4e6a-9334-bd850387eed9",
            "GatewayHostName":"10.250.24.9",
            "GatewayHostPath":"/",
            "EndpointHostName":"10.250.24.9",
            "EndpointPath":"/api17080live",
            "Protocol":"http",
            "Path":"/api17080live",
            "Url":"http://10.250.24.9:7905/api17080live",
            "BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0_0",
            "BindingType":"binding.http",
            "Public":true
          }
        ]
      }
    ]
  },
  "Operations":{
    "Operation":[
      {
        "Name":"addPet",
        "OperationKey":"9559150b-1261-4361-9554-4a0c1e75c945",
        "InterfaceQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0_0",
        "WsdlOperationName":"addPet"
      },
      {
        "Name":"deletePet",
        "OperationKey":"7d2363fe-fc49-41c5-b623-239361be9027",
        "InterfaceQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0_0",
        "WsdlOperationName":"deletePet"
      },
      {
        "Name":"findPetsByStatus",
        "OperationKey":"225abcb4-c389-4a76-b135-6772175330e4",
        "InterfaceQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0_0",
        "WsdlOperationName":"findPetsByStatus"
      },
      {
        "Name":"findPetsByTags",
        "OperationKey":"f294228d-eabd-47cb-bf51-222c6a8b0ba0",
        "InterfaceQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0_0",
        "WsdlOperationName":"findPetsByTags"
      },
      {
        "Name":"getPetById",
        "OperationKey":"11a68c60-ef28-479f-b9a0-887b9a364c02",
        "InterfaceQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0_0",
        "WsdlOperationName":"getPetById"
      }
    ]
  },
  "AnonymousAccessAllowed":true,
  "EndpointAccessAutoApproved":true,
  "ProxyImplementationDetails":{
    "ProxiedService":{
      "ServiceKey":"uddi:ff0f29c7-8462-4688-8964-d356abe02f17",
      "ServiceName":"Swagger_Petstore_5_Operations_Gen_v2 (cloning an API that has policies)_Live_Target",
      "OrganizationKey":"uddi:8c3807c7-2b1c-4846-bbce-9901f591bad0",
      "Endpoints":{
        "Endpoint":[
          {
            "Uri":"HTTPS://api577172live.gateway.akana.com:80/",
            "ConnectionProperties":[
              
            ],
            "BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0_0",
            "BindingType":"binding.http",
            "EndpointKey":"uddi:78a79d17-f69a-45d1-887f-09050bdebdb8"
          },
          {
            "Uri":"HTTP://api577172live.gateway.akana.com:80/",
            "ConnectionProperties":[
              
            ],
            "BindingQName":"{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_Binding_0_0",
            "BindingType":"binding.http",
            "EndpointKey":"uddi:147e1903-ae1e-493e-b26d-aed468ca6033"
          }
        ]
      }
    }
  }
}

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.
404	The resource could not be found. For example, you might get this if the implementation had already been deleted.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.