API Documentation
Endpoints
- Aegister Threat Blocker
- Cloud Defender
- Cyber Assurance
- Documents
- Notifications
- Organizations
- Perimeter Protection
- Search
- Assessments
- Log Analysis
- VPN
Get Security Framework
Retrieve a Cyber Assurance Security Framework
curl --request GET \
--url https://app.aegister.com/api/v1/cyber-assurance/security-frameworks/{id} \
--header 'X-Aegister-Token: <api-key>'
{
"error": 0,
"messages": [],
"data": {
"id": 3,
"title": "Lorem Ipsum dolor sit amet",
"security_frameworks": [
{
"id": "C1",
"type": "control",
"title": "Control 1",
"weight": 0.2,
"details": {},
"evidences": [
{
"files": [
"/api/v1/documents/organizations/1/security-frameworks/1/documents/C1/xxxxxxxxxxx.jpg"
],
"details": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.",
"datetime": "2023-11-07T05:31:56Z",
"completed": 0,
"residual_risk": 0.2,
"submitted_by": {
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_email": "jsmith@example.com"
}
}
],
"frequency": "0 0 1 * *",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.",
"evidence_type": "self"
}
]
}
}
Authorizations
Path Parameters
Response
Any value different from 0 indicates an error.
More details can be found in messages
.
0 <= x <= 0
0
If error
is 1
, contains zero or more details on the error.
[]
Security Framework unique identifier.
3
Security Framework title.
"Lorem Ipsum dolor sit amet"
Contains all security frameworks
Identifier for the security framework
"C1"
Specify the type of the security framework
control
Security framework title
"Control 1"
The weight of the security framework.
All security frameworks in this array must add up to 1.0
.
0 <= x <= 1
Must be a multiple of 0.1
0.2
Other extra specification about the security framework.
{}
This will contain the history of the security framework execution.
This array is limited to max 200
elements.
Attached files for an evidence.
More information about the control execution.
"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at."
Reports if evidence execution run correctly.
0
, 1
Indicates if the answer shows some issues that need to be addressed.
If residual risk is 1.0
needs urgent acting, if is 0.0
is safe.
0 <= x <= 1
Must be a multiple of 0.1
0.2
This object is set when the security framework evidence_type
has self
value.
The security framework execution frequency.
It is specified using UNIX cron format.
"0 0 1 * *"
Detailed security framework description.
"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at."
Describes wheater the security framework is run automatically according to the frequency, or needs the user to act on the security framework.
self
, automated
curl --request GET \
--url https://app.aegister.com/api/v1/cyber-assurance/security-frameworks/{id} \
--header 'X-Aegister-Token: <api-key>'
{
"error": 0,
"messages": [],
"data": {
"id": 3,
"title": "Lorem Ipsum dolor sit amet",
"security_frameworks": [
{
"id": "C1",
"type": "control",
"title": "Control 1",
"weight": 0.2,
"details": {},
"evidences": [
{
"files": [
"/api/v1/documents/organizations/1/security-frameworks/1/documents/C1/xxxxxxxxxxx.jpg"
],
"details": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.",
"datetime": "2023-11-07T05:31:56Z",
"completed": 0,
"residual_risk": 0.2,
"submitted_by": {
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_email": "jsmith@example.com"
}
}
],
"frequency": "0 0 1 * *",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.",
"evidence_type": "self"
}
]
}
}