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.

New in API Platform Version: 8.1

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

This topic includes the following sections:

HTTP Method

DELETE

Back to top

URL

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

Back to top

Sample Request

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

Request URL

https://{hostname}/api/apis/versions/a0a676f7-b243-486d-8599-951834ed2318.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.

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.
ImplName Path string Required The name for a specific implementation of an API version.

Back to top

Response

If successful, this operation returns HTTP status code 200.

Back to top

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: Fri, 18 Mar 2016 01:52:24 GMT

Sample response body

{
  "Name" : "Swagger_Slim_v1_Live_Virtual",
  "ImplementationCode" : "Live",
  "Description" : "Swagger Slim Version",
  "Pattern" : "com.akana.pattern.proxy",
  "ServiceKey" : "uddi:49dfe97e-eca8-11e5-9c5f-c2617724f57b",
  "APIBindings" : {
    "APIBinding" : [ {
      "BindingQName" : "{Swagger_Slim.json}Swagger_Slim_Binding_0",
      "BindingKey" : "uddi:e19d3b62-9014-2176-dd9a-98c0c65e6f7f",
      "InterfaceQName" : "{Swagger_Slim.json}Swagger_Slim_PortType_0",
      "InterfaceKey" : "uddi:371853c7-3707-aa09-4293-4a3989d508ff",
      "BindingType" : "binding.http",
      "BindingOperations" : {
        "BindingOperation" : [ {
          "OperationName" : "addPet",
          "WsdlOperationName" : "addPet",
          "HttpOperation" : {
            "Method" : "POST",
            "Path" : "/pet",
            "InputContentType" : "application/json,application/xml",
            "OutputContentType" : "application/xml,application/json",
            "FaultContentType" : "",
            "Input" : [ {
              "Name" : "body",
              "Type" : "entity"
            } ]
          }
        }, {
          "OperationName" : "getPetById",
          "WsdlOperationName" : "getPetById",
          "HttpOperation" : {
            "Method" : "GET",
            "Path" : "/pet/{petId}",
            "InputContentType" : "application/json",
            "OutputContentType" : "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" : "petId",
              "Type" : "path"
            }, {
              "Name" : "api_key",
              "Type" : "header"
            } ]
          }
        } ]
      }
    } ]
  },
  "APIInterfaces" : {
    "APIInterface" : [ {
      "InterfaceQName" : "{Swagger_Slim.json}Swagger_Slim_PortType_0",
      "InterfaceKey" : "uddi:371853c7-3707-aa09-4293-4a3989d508ff",
      "InterfaceOperations" : {
        "InterfaceOperation" : [ {
          "OperationName" : "addPet",
          "WsdlOperationName" : "addPet"
        }, {
          "OperationName" : "getPetById",
          "WsdlOperationName" : "getPetById"
        }, {
          "OperationName" : "deletePet",
          "WsdlOperationName" : "deletePet"
        } ]
      }
    } ]
  },
  "Endpoints" : {
    "Endpoint" : [ ]
  },
  "APIImplementationDeployments" : {
  },
  "Operations" : {
    "Operation" : [ {
      "Name" : "addPet",
      "OperationKey" : "4a397b32-eca8-11e5-9c5f-c2617724f57b",
      "InterfaceQName" : "{Swagger_Slim.json}Swagger_Slim_PortType_0",
      "WsdlOperationName" : "addPet"
    }, {
      "Name" : "deletePet",
      "OperationKey" : "4a3f95b8-eca8-11e5-9c5f-c2617724f57b",
      "InterfaceQName" : "{Swagger_Slim.json}Swagger_Slim_PortType_0",
      "WsdlOperationName" : "deletePet"
    }, {
      "Name" : "getPetById",
      "OperationKey" : "4a3c6165-eca8-11e5-9c5f-c2617724f57b",
      "InterfaceQName" : "{Swagger_Slim.json}Swagger_Slim_PortType_0",
      "WsdlOperationName" : "getPetById"
    } ]
  }
}

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

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

Back to top

Related Topics