This returns the details of a single NHS cyber alert
This returns the details of a single NHS cyber alert
Endpoint
GET
https://digital.nhs.uk/restapi/CyberAlert/single
Authorisation and Authentication
No authentication or authorisation is required for this API endpoint
Parameters
Name | Parameter Type | Mandatory/ Optional | Path | Description |
---|---|---|---|---|
?threatid=xxxxxx |
String | Mandatory |
|
To return a single cyber alert, you must specify a threat ID, normally formatted AA-1111 |
?_limited=true |
String | Optional |
|
To return only the basic details of the alert, you can use the limited modifier |
Sample Response
The full return gives all the information included in the alert
Full return
JSON
The limited return gives only a subset of the information about the cyber alert
Limited return
JSON
Status and error codes
HTTP Code | Meaning | Description | Diagnostics |
---|---|---|---|
N/A |
{"error":"The URL is not correct. Use \/single?threatid=<threatid>"} |
This means that no ThreatID has been specified |
Add a threatID parameter |
N/A |
{"error":"The threatid=Cxx is not found"} |
This means that you have specified a non-existent threatID |
Specify a valid threatID |
Last edited: 27 February 2020 8:24 am