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 logged in. 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
URL
https://{hostname}/api/apis/versions/{APIVersionID}
Sample Request
The example below shows a request to delete a specific API version.
Sample Request URL
https://{hostname}/api/apis/versions/e3be3da9-e4d7-4998-85c4-fca3aed651c9.acmepaymentscorp
Sample request headers
DELETE /api/apis/versions/e3be3da9-e4d7-4998-85c4-fca3aed651c9.acmepaymentscorp HTTP/1.1 X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...
Sample request body
None.
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 (*/*) |
| 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. |
Response
If successful, this operation returns HTTP status code 200. There is no response body.
Sample Response
The sample response below shows that the specified API version was deleted.
Sample response headers
HTTP/1.1 200 OK Date: Thu, 06 Jun 2019 20:20:07 GMT
Sample response body
None.
Response Headers
For general information on response header values, refer to HTTP Response Headers.
| Header | Description |
|---|---|
| Content-Type | text/plain |
Response Body
None.
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.
