DELETE /api/apis/{APIID}

Deletes the specified API, including all API versions.

Note: This functionality is not available in the user interface. To protect the user against accidentally deleting the API rather than an API version, the UI only allows deletion of an API version. Deleting the last version deletes the API. Only by using the platform API can you delete an API and all versions in one operation.

Authorization Roles/Permissions: API Admin or Business Admin.

This topic includes the following sections:

HTTP Method

DELETE

Back to top

URL

https://{hostname}/api/apis/{APIID}

Back to top

Sample Request

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

Request URL

https://{hostname}/api/apis/8bebe599-3b97-45bc-a6a7-73542af275a7.acmepaymentscorp

Sample request headers

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
APIID Path string Required The unique ID for a specific API.

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 API was deleted.

Sample response headers

HTTP/1.1 200 OK
Date: Thu, 03 Jul 2014 16:13:06 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