DELETE /api/apis/versions/{APIVersionID}

Deletes the specified API version. If there is only one version, this operation also deletes the API.

Authorization Roles/Permissions: Must be a user with delete permission for the API; an API Admin or Business Admin.

This topic includes the following sections:

HTTP Method

DELETE

Back to top

URL

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

Back to top

Sample Request

The example below shows a request to delete a specific API version.

Request URL

https://{hostname}/api/apis/versions/apiversion18973.acmepaymentscorp

Sample request headers

DELETE /api/apis/versions/apiversion18973.acmepaymentscorp HTTP/1.1
Accept: text/plain
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

None.

Back to top

Request Headers

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

Header Description
Accept Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
Content-Type Any format (*/*)
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.

Back to top

Response

If successful, this operation returns HTTP status code 200. There is no response body.

Back to top

Sample Response

The sample response below shows that the specified API version was deleted.

Sample response headers

HTTP/1.1 200 OK
Date: Wed, 30 Jan 2013 20:36:28 GMT

Sample response body

None.

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type text/plain

Back to top

Response Body

None.

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.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics