DELETE /content/{path}
Deletes platform content associated with an API (a specific file).
Authorization Roles/Permissions: Must be logged in. API Admin.
This topic includes the following sections:
HTTP Method
DELETE
URL
https://{hostname}/content/{path}
Sample Request
The example below shows a request to delete the index file from the API documentation for the specified API version.
Sample Request URL
https://api.acmepaymentscorp.com/content/api/api19427.acmepaymentscorp/documents/index.htm
Sample request headers
DELETE /content/api/api19427.acmepaymentscorp/documents/index.htm HTTP/1.1
Host: {hostname}
Accept: */*
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 | Not applicable; there is no response. |
| 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 |
|---|---|---|---|---|
| path | path | Required | The complete path to the content resource being deleted. The first page of the path is the host and then the /content/part of the URL; for example, https://api.acmepaymentscorp.com/content. The rest of the URL is the path to the resource, from /api onwards; for example, /api/api19427.acmepaymentscorp/documents/index.htm. |
Response
If successful, this operation returns HTTP status code 200. There is no response content.
Sample Response
The sample response below shows successful completion of this operation.
Sample response headers
HTTP/1.1 200 OK Content-Length: 0 Date: Mon, 24 Jun 2013 18:18:59 GMT
Sample response body
None.
Response Headers
For general information on response header values, refer to HTTP Response Headers.
| Header | Description |
|---|---|
| Content-Type | Not applicable. |
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. |
| 404 | The resource could not be found. For example, you might get this if the content resource had already been deleted. |
| 500 | An error occurred processing the call. |
More information about Akana API Platform API error messages.
