POST /api/alerts

Adds an alert on an API.

Note: If you are using markdown, and will be incorporating one or more artifacts in your alert, you must upload the artifacts first. Run the POST /api/boards/items/artifacts operation to upload the first artifact and the POST /api/boards/items/{BoardItemID}/artifacts operation to upload any subsequent artifacts. Use the values from the responses, such as the BoardItemID and the image paths, to construct the payload for adding the 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

POST

Back to top

URL

https://{hostname}/api/alerts

Back to top

Sample Request

The example below shows a request to create an alert.

Request URL

https://{hostname}/api/alerts

Sample request headers

POST http://{hostname}/api/alerts HTTP/1.0
Accept: text/plain, */*; q=0.01
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "APIID":"037a3fad-45ba-4126-aae4-84a9dadae89e.acmepaymentscorp",
  "Title":"Scheduled outage",
  "Description":"There will be a scheduled outage for 1 hour, **Sun 26 July 2015 3am to 4am EST**. Please plan accordingly.",
  "Type":"Manual",
  "Priority":"Critical",
  "Environment":"Production",
  "UserID":"a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp",
  "Tag":[
    "outage",
    "July"
  ],
  "DescriptionMediaType":"text/markdown",
  "BoardItemArtifacts":{
    "BoardItemArtifact":[

    ]
  }
}

Back to top

Request Headers

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

Header Description
Accept text/plain
Content-Type

Any one of the following media types is valid for the request Content-Type:

application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json

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.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
alert Body Alert Required Contains information about an alert.

Back to top

Response

If successful, this operation returns HTTP status code 200, wih the AlertID for the new alert.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

HTTP/1.1 200 OK
Content-Type: text/plain
Expires: Tue, 12 May 2015 19:11:15 GMT

Sample response body: application/json

alert11639.acmepaymentscorp

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

Name Type Description
AlertID string The unique AlertID for the alert that was just created.

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

Back to top

Related Topics