# Get Assessment
Source: https://aegisterspa.mintlify.app/api-reference/assessments/get-api-v1-assessments

get /api/v1/assessments/{id}
Retrieves assessment by id



# Get Assessments list
Source: https://aegisterspa.mintlify.app/api-reference/assessments/get-api-v1-assessments-list

get /api/v1/assessments
Retrieves all assessments



# Delete Aegister Threat Blocker configuration
Source: https://aegisterspa.mintlify.app/api-reference/atb/delete-api-v1-atb

delete /api/v1/atb/{id}
Soft delete an Threat Blocker configuration from the Web Application.

You can delete only Threat Blocker configurations for organizations you can manage.



# Get Aegister Threat Blocker configuration
Source: https://aegisterspa.mintlify.app/api-reference/atb/get-api-v1-atb

get /api/v1/atb/{id}
Get an Threat Blocker configuration from the Web Application.

You can retrieve only Threat Blocker configurations for organizations you can manage.



# Get Aegister Threat Blocker configuration list
Source: https://aegisterspa.mintlify.app/api-reference/atb/get-api-v1-atb-list

get /api/v1/atb
Retrieves Threat Blocker list configured in the Web Application.

The list contains only Threat Blocker for organizations you can manage.



# Get Aegister Threat Blocker traffic logs
Source: https://aegisterspa.mintlify.app/api-reference/atb/get-api-v1-atb-traffic

get /api/v1/atb/{id}/traffic
Retrieve Threat Blocker traffic logs from the Web Application.

You can retrieve only Threat Blocker traffic logs for organizations you can manage.



# Create Aegister Threat Blocker configuration
Source: https://aegisterspa.mintlify.app/api-reference/atb/post-api-v1-atb

post /api/v1/atb
Create a new Threat Blocker configuration in the Web Application.

You can create only Threat Blocker configurations for organizations you can manage.



# Create Aegister Threat Blocker traffic log
Source: https://aegisterspa.mintlify.app/api-reference/atb/post-api-v1-atb-traffic

post /api/v1/atb/{id}/traffic
Create Threat Blocker traffic logs in the Web Application.

You can create only Threat Blocker traffic logs for organizations you can manage.



# Edit Aegister Threat Blocker configuration
Source: https://aegisterspa.mintlify.app/api-reference/atb/put-api-v1-atb

put /api/v1/atb/{id}
Edit an Threat Blocker configuration in the Web Application.

You can edit only Threat Blocker configurations for organizations you can manage.



# Authentication
Source: https://aegisterspa.mintlify.app/api-reference/authentication

Authentication methods supported by our API.

## Authentication Methods

Our API supports two methods for authentication using the `X-Aegister-Token`. You can choose either method based on your preference or use case.

### 1. Header-Based Authentication

In this method, you include the `X-Aegister-Token` in the headers of your HTTP request. This is typically preferred as it keeps the token out of the URL, enhancing security.

**Example Request:**

```http theme={null}
GET /api/v1/resource HTTP/1.1
Host: app.aegister.com
X-Aegister-Token: your_token_here
```

**Curl Example:**

```bash theme={null}
curl -H "X-Aegister-Token: your_token_here" https://app.aegister.com/api/v1/resource
```

### 2. Query Parameter Authentication

Alternatively, you can include the `X-Aegister-Token` as a query parameter in the URL. This method is useful in scenarios where setting request headers is not feasible.

**Example Request:**

```http theme={null}
GET /api/v1/resource?X-Aegister-Token=your_token_here HTTP/1.1
Host: app.aegister.com
```

**Curl Example:**

```bash theme={null}
curl https://app.aegister.com/api/v1/resource?X-Aegister-Token=your_token_here
```


# Delete Cloud Defender configuration
Source: https://aegisterspa.mintlify.app/api-reference/cloud-defender/delete-api-v1-cloud-defender

delete /api/v1/cloud-defender/{id}
Soft delete a Cloud Defender configuration from the Web Application.

You can delete only a Cloud Defender configuration for an organizations you can manage.



# Get Cloud Defender configuration
Source: https://aegisterspa.mintlify.app/api-reference/cloud-defender/get-api-v1-cloud-defender

get /api/v1/cloud-defender/{id}
Get a Cloud Defender configuration from the Web Application.

You can retrieve only a Cloud Defender configuration for an organization you can manage.



# Get Cloud Defender configuration list
Source: https://aegisterspa.mintlify.app/api-reference/cloud-defender/get-api-v1-cloud-defender-list

get /api/v1/cloud-defender
Retrieves Cloud Defender list configured in the Web Application.

The list contains only Cloud Defenders for organizations you can manage.



# Create Cloud Defender configuration
Source: https://aegisterspa.mintlify.app/api-reference/cloud-defender/post-api-v1-cloud-defender

post /api/v1/cloud-defender
Create a new Cloud Defender configuration in the Web Application.

You can create only Cloud Defender configurations for organizations you can manage.



# Edit Cloud Defender configuration
Source: https://aegisterspa.mintlify.app/api-reference/cloud-defender/put-api-v1-cloud-defender

put /api/v1/cloud-defender/{id}
Edit a Cloud Defender configuration in the Web Application.

You can edit only a Cloud Defender configuration for an organization you can manage.



# Delete Security Framework
Source: https://aegisterspa.mintlify.app/api-reference/cyber-assurance/delete-api-v1-cyber-assurance-security-frameworks

delete /api/v1/cyber-assurance/security-frameworks/{id}



# Get Security Framework
Source: https://aegisterspa.mintlify.app/api-reference/cyber-assurance/get-api-v1-cyber-assurance-security-frameworks

get /api/v1/cyber-assurance/security-frameworks/{id}



# Get Security Framework list
Source: https://aegisterspa.mintlify.app/api-reference/cyber-assurance/get-api-v1-cyber-assurance-security-frameworks-list

get /api/v1/cyber-assurance/security-frameworks



# Create Security Framework
Source: https://aegisterspa.mintlify.app/api-reference/cyber-assurance/post-api-v1-cyber-assurance-security-frameworks

post /api/v1/cyber-assurance/security-frameworks



# Edit Security Framework
Source: https://aegisterspa.mintlify.app/api-reference/cyber-assurance/put-api-v1-cyber-assurance-security-frameworks

put /api/v1/cyber-assurance/security-frameworks/{id}



# Get Document
Source: https://aegisterspa.mintlify.app/api-reference/documents/get-api-v1-documents

get /api/v1/documents/{file}
Retrieve Document.

This API serves documents for Security Framework self evaluations.



# Delete Log Analysis
Source: https://aegisterspa.mintlify.app/api-reference/log-analysis/delete-api-v1-log-analysis

delete /api/v1/log-analysis/{id}
Deletes a log-analysis



# Get Log Analysis
Source: https://aegisterspa.mintlify.app/api-reference/log-analysis/get-api-v1-log-analysis

get /api/v1/log-analysis/{id}
Retrieves a log-analysis



# Get Log Analysis list
Source: https://aegisterspa.mintlify.app/api-reference/log-analysis/get-api-v1-log-analysis-list

get /api/v1/log-analysis
Retrieves all log-analysis



# Create Log Analysis
Source: https://aegisterspa.mintlify.app/api-reference/log-analysis/post-api-v1-log-analysis

post /api/v1/log-analysis
Create a new analysis with enhanced validation



# Get Notifications list
Source: https://aegisterspa.mintlify.app/api-reference/notifications/get-api-v1-notifications

get /api/v1/notifications
Retrieve authenticated user's Notifications.



# Edit Notification
Source: https://aegisterspa.mintlify.app/api-reference/notifications/put-api-v1-notifications

put /api/v1/notifications/{id}
Edit current authenticated user's Notification.

This endpoint doesn't actually edits Notification content, just sets it to read.



# Delete Organization
Source: https://aegisterspa.mintlify.app/api-reference/organizations/delete-api-v1-organizations

delete /api/v1/organizations/{id}
Soft delete an Organization.

The authenticated user can delete only an Organization is part of and has Owner priviledges.



# Delete Organization associated Security Framework
Source: https://aegisterspa.mintlify.app/api-reference/organizations/delete-api-v1-organizations-security-frameworks

delete /api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}
Soft delete a Cyber Assurance Association.



# Delete Organization user
Source: https://aegisterspa.mintlify.app/api-reference/organizations/delete-api-v1-organizations-users

delete /api/v1/organizations/{organizationid}/users/{userid}
Soft delete an Organization's user.

The authenticated user can remove the user from the organization if is part of the organization and has Owner priviledges.



# Get Organization
Source: https://aegisterspa.mintlify.app/api-reference/organizations/get-api-v1-organizations

get /api/v1/organizations/{id}
Retrieve the Organization.

The authenticated user can retrieve only an organization is part of.



# Get Organization list
Source: https://aegisterspa.mintlify.app/api-reference/organizations/get-api-v1-organizations-list

get /api/v1/organizations
Retrieve Organization list.

The list contains only Organizations the current authenticated user is part of.



# Get Organization associated Security Framework
Source: https://aegisterspa.mintlify.app/api-reference/organizations/get-api-v1-organizations-security-frameworks

get /api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}
Retrieve Cyber Assurance Association



# Get Organization associated Security Framework list
Source: https://aegisterspa.mintlify.app/api-reference/organizations/get-api-v1-organizations-security-frameworks-list

get /api/v1/organizations/{organizationid}/security-frameworks
Retrieve Cyber Assurance Associations list



# Get Organization user list
Source: https://aegisterspa.mintlify.app/api-reference/organizations/get-api-v1-organizations-users

get /api/v1/organizations/{organizationid}/users
Retrieve Organization's user list.

The authenticated user can retrieve the user list if is part of the organization and has at least Security Officer priviledges.



# Create Organization
Source: https://aegisterspa.mintlify.app/api-reference/organizations/post-api-v1-organizations

post /api/v1/organizations
Create a new Organization.

The current authenticated user becomes the Organization Owner.



# Create Organization associated Security Framework
Source: https://aegisterspa.mintlify.app/api-reference/organizations/post-api-v1-organizations-security-frameworks

post /api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}
Create Cyber Assurance Association.



# Create Organization's associated Security Framework Document
Source: https://aegisterspa.mintlify.app/api-reference/organizations/post-api-v1-organizations-security-frameworks-documents

post /api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}/documents/{controlid}
Create a Cyber Assurance Association document attached to self evaluation.



# Create Organization user
Source: https://aegisterspa.mintlify.app/api-reference/organizations/post-api-v1-organizations-users

post /api/v1/organizations/{organizationid}/users/{userid}
Create Organization's user.

The authenticated user can add the user to the organization if is part of the organization and has Owner priviledges.

After the user has been added to the organization, an invitation email will be sent.



# Edit Organization
Source: https://aegisterspa.mintlify.app/api-reference/organizations/put-api-v1-organizations

put /api/v1/organizations/{id}
Edit an Organization.

The authenticated user can edit only and organization is part of and has at least Security Officer priviledges.



# Edit Organization associated Security Framework
Source: https://aegisterspa.mintlify.app/api-reference/organizations/put-api-v1-organizations-security-frameworks

put /api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}
Edit Cyber Assurance Association.



# Edit Organization user
Source: https://aegisterspa.mintlify.app/api-reference/organizations/put-api-v1-organizations-users

put /api/v1/organizations/{organizationid}/users/{userid}
Create Organization's user.

The authenticated user can edit the user in the organization if is part of the organization and has Owner priviledges.



# Get Threat Intelligence Domain check
Source: https://aegisterspa.mintlify.app/api-reference/perimeter-protection/get-api-v1-perimeter-protection-threat-intelligence-domain

get /api/v1/perimeter-protection/threat-intelligence/domain/{domain}
Retrieves Threat Intelligence Domain check.

Provided by <a href="https://onefirewall.com/?tag=aegister" taget="_blank">OneFirewall</a>



# Get Threat Intelligence Domain list
Source: https://aegisterspa.mintlify.app/api-reference/perimeter-protection/get-api-v1-perimeter-protection-threat-intelligence-domain-list

get /api/v1/perimeter-protection/threat-intelligence/domain/list
Retrieve Threat Intelligence Domain list.

Provided by <a href="https://onefirewall.com/?tag=aegister" taget="_blank">OneFirewall</a>



# Get Threat Intelligence File check
Source: https://aegisterspa.mintlify.app/api-reference/perimeter-protection/get-api-v1-perimeter-protection-threat-intelligence-file

get /api/v1/perimeter-protection/threat-intelligence/file/{file}
Retrieves Threat Intelligence File digest check.

Provided by <a href="https://onefirewall.com/?tag=aegister" taget="_blank">OneFirewall</a>



# Get Threat Intelligence IPv4 check
Source: https://aegisterspa.mintlify.app/api-reference/perimeter-protection/get-api-v1-perimeter-protection-threat-intelligence-ip

get /api/v1/perimeter-protection/threat-intelligence/ip/{ip}
Retrieves Threat Intelligence IPv4 check.

Provided by <a href="https://onefirewall.com/?tag=aegister" taget="_blank">OneFirewall</a>



# Get Threat Intelligence IPv4 list
Source: https://aegisterspa.mintlify.app/api-reference/perimeter-protection/get-api-v1-perimeter-protection-threat-intelligence-ip-list

get /api/v1/perimeter-protection/threat-intelligence/ip/list
Retrieve Threat Intelligence IPv4 list.

Provided by <a href="https://onefirewall.com/?tag=aegister" taget="_blank">OneFirewall</a>



# Get Threat Intelligence URL check
Source: https://aegisterspa.mintlify.app/api-reference/perimeter-protection/get-api-v1-perimeter-protection-threat-intelligence-url

get /api/v1/perimeter-protection/threat-intelligence/url/{url}
Retrieve Threat Intelligence URL check.

Provided by <a href="https://onefirewall.com/?tag=aegister" taget="_blank">OneFirewall</a>



# Get Search results
Source: https://aegisterspa.mintlify.app/api-reference/search/get-api-v1-search

get /api/v1/search
Retrieve items based on keyword filter.



# Token
Source: https://aegisterspa.mintlify.app/api-reference/token

Steps to create a new authentication token for accessing the API.

## How to Create a Token

Follow these steps to create a new token for authentication:

1. **Access your Profile**\
   Click on your profile icon located at the top right corner of the page or navigate directly [here](https://app.aegister.com/settings/profile/).

2. **Create a New Token**\
   Click on the *+ New* button in the API Tokens section.
   <img alt="Step 2" />

3. **Input Token Name**\
   Enter a name for your token in the input field and click on the "Generate" button.
   <img alt="Step 3" />

4. **Copy the Token**\
   Copy the generated token as it will not be available again after this step.
   <img alt="Step 4" />

Make sure to store the token securely, as it will be required for authenticating your API requests.


# Delete VPN Profile
Source: https://aegisterspa.mintlify.app/api-reference/vpn/delete-api-v1-vpn

delete /api/v1/vpn/{id}
Soft delete a VPN profile.

You can delete only VPN profiles you have created.



# Get VPN Profile
Source: https://aegisterspa.mintlify.app/api-reference/vpn/get-api-v1-vpn

get /api/v1/vpn/{id}
Retrieves VPN Profile by id.

You can get only VPN profiles you have created.



# Get VPN Profile list
Source: https://aegisterspa.mintlify.app/api-reference/vpn/get-api-v1-vpn-list

get /api/v1/vpn
Retrieves all VPN profiles assigned to the user



# Create VPN Profile
Source: https://aegisterspa.mintlify.app/api-reference/vpn/post-api-v1-vpn

post /api/v1/vpn
Insert new VPN profile.



# FAQs
Source: https://aegisterspa.mintlify.app/faq

Below are the most frequently asked questions on Aegister app usage.

## Frequently Asked Questions

### Where can I find the statistics of all my organizations?

In the **Dashboard** section, you can view your organization's statistics collected in specific charts.\
If you have more than one associated organization, simply press the **"Change Organization"** button to select the agency whose statistics you want to view.

### How can I manually evaluate a Security Framework?

To evaluate a Security Framework, access the **"Associations"** page under the **"Cyber Assurance"** heading in the left menu.\
On this page, by clicking the **"Evaluate"** button, you can fill out a form to indicate the specific risk of your Security Framework.

### How do I create a Security Framework?

To create a Security Framework, navigate to **"Security Frameworks"** in the left-hand menu under **"Cyber Assurance"**.\
Once in the correct section, click on the **"New"** button and fill in the required fields.

### How can I control threats about URLs, files, and IPs?

To check for threats related to **URLs, files, and IPs**, go to the **"Threat Intelligence"** section in the left menu under **"Perimeter Protection"**.\
Here, you can perform a detailed analysis to recognize potential anomalies and threats.

### How can I check the status of my Web app?

To check the status of your Web app, go to the **"Cloud Defender"** section under **"Perimeter Protection"** and click on the **arrow icon** to view the detailed status.

### How often are the Cloud Defender data updated?

Cloud Defender data are updated **every 5 minutes**.

### How do I create an Access Token?

To create an Access Token, access your **profile** in the **top right corner**. From there, click on the **"New"** button to enter the name of the new token.

### Where can I find the API documentation?

To consult the API documentation, visit:\
[API Documentation](https://aegisterspa.mintlify.app/)


# About Us
Source: https://aegisterspa.mintlify.app/introduction



Aegister S.p.A. is a cybersecurity company focusing on *democratizing* cybersecurity for small and medium-sized enterprises (SMEs).\
We aim to make cyber risk protection accessible and foster business networks for real-time risk sharing.\
Aegister S.p.A. emphasizes innovation, leveraging advanced tools and artificial intelligence, and is a spin-off from the University of Salerno, providing us access to specialized academic knowledge and technologies.

For more details, visit [About Us](https://aegister.com/en/company/).


# Services
Source: https://aegisterspa.mintlify.app/services

This page provides an overview of the various IT services offered by Aegister, focusing on enhancing cybersecurity through a range of solutions and tools.

<img alt="Services" />

**vCISO Services**\
Aegister offers virtual Chief Information Security Officer (vCISO) services to manage cybersecurity strategies and mitigate risks effectively. This service is designed to help businesses implement and maintain robust cybersecurity measures without the need for a full-time in-house CISO.

**Threat Blocker**\
Aegister provides a hardware device known as Threat Blocker for perimeter security. This device integrates threat intelligence and IP reputation algorithms to enhance network security by blocking potential threats at the perimeter.

**Add-Ons**\
Aegister also offers a range of additional services, including:

* Data Protection Officer (DPO) services
* Workforce training on cybersecurity practices
* Fractional vCISO for part-time security leadership
* Forensic investigation to analyze and respond to security breaches
* Security council meetings for regular updates and strategy sessions
* Custom reporting tailored to specific business needs

Aegister's platform leverages artificial intelligence to enhance security measures, providing comprehensive and adaptable solutions to meet various business requirements.

For more information, visit [Services](https://aegister.com/en/it-services/index.html)