DELETE /api/alerts/{AlertID}

Deletes the specified alert.

Authorization Roles/Permissions: Must be logged in. API Admin or Business Admin for the API the alert relates to.

This topic includes the following sections:

HTTP Method

DELETE

https://{hostname}/api/alerts/{AlertID}

The example below shows a request to delete the specified alert.

Sample Request URL

https://{hostname}/api/alerts/alert10819.acmepaymentscorp

Sample request headers

X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

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

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

Parameter	Parm Type	Data Type	Required	Description
AlertID	Path	string	Required	The unique ID for a specific alert.

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

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Content-Length: 0
Expires: Wed, 13 May 2015 15:05:32 GMT

Sample response body

Not applicable.

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

None.

None.

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.