GET /api/alerts/{AlertID}

Returns information about the specified alert.

Authorization Roles/Permissions: Must have visibility of the specified alert.

This topic includes the following sections:

HTTP Method

GET

URL

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

Sample Request

The example below shows a request for information about the specified alert.

Sample Request URL

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

Sample request headers

Accept: application/json

Sample request body

Not applicable.

Request Headers

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

Header	Description
Accept	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json

Request Parameters

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

Response

If successful, this operation returns HTTP status code 200, with information about the specified alert.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Expires: Tue, 12 May 2015 19:42:32 GMT

Sample response body: application/json

{
  "AlertID" : "alert11639.acmepaymentscorp",
  "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",
  "UserName" : "JaneMead",
  "Created" : "2015-05-13T00:11:15Z",
  "Comments" : 0,
  "Tag" : [ "outage", "July" ],
  "Published" : true,
  "DescriptionMediaType" : "text/markdown",
  "BoardItemArtifacts" : {
    "BoardItemArtifact" : [ ]
  }
}

Response Headers

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

Header	Description
Content-Type	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json

Response Body

Name	Type	Description
Alert	Alert	Contains information about an alert.

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.

Related Topics