High Level Design

APIs

Platform

OneFirewall Documentation

API Reference

Dashboard

Support

Introduction

Welcome to the documentation portal of OneFirewall Alliance

OneFirewall Coins

Proof of Value

Virtual Private Server

Authorization

OpenAPI 3.0

Checkpoint Secure XL

Secure VPN

You can call the API `/api/v1/ips` in order to receive an array of the latest IPv4 feeds collected at the OneFirewall Data lake.

Latest IPv4

This API is similar with the `IP addresses [FLAT]` however have some advantages and disadvantages in respect:

##### Advantages

1. Real time calculation of the OneFirewall Crime Score
2. Equipped with the new (v3.2) Scoring algorithm
3. Can be integrated into directly Fortigate, Checkpoint, etc..

##### Disadvantages

1. Use pagination (therefore you have to call multiple times the IP if the list is bigger than 10000)
2. Is relatively 6x slower than `IP addresses [FLAT]`

Live IPv4

You can call the API `/api/v1/ips/<IPv4>` in order to receive information for the IPv4 feeds in request if is presented at the OneFirewall Data lake. This API is useful when you want to verify if OneFirewall have an information for the actor in request.

One IPv4

If you need a simple list (example CSV) to retrieve all the IPv4 feeds based on their score, you can use the below API

Pre-compiled IPv4

Post information about threat intelligence in relation to a IPv4

Report IPv4

Domains by Score

Retrieve the latest malicious domains recorded

Domains by TS

This API is used to change / overwrite the decision based on score, in other words setting manually a IoC in whitelist or blacklist.

Overwrite Decision

Enable users to report domains suspected of serving malware, viruses, or trojans.

Report Domain

Retrieve metadata for over a million known malicious domains.

Scan Domain

URLs by Score

Retrieve the latest malicious url recorded

URLs by TS

Enable users to report url suspected of serving malware, viruses, or trojans.

Report URL

Retrieve metadata for over a million known malicious feeds.

Scan URL

Files by Score

Files by TS

Report Digest

Files

STIX2 (Structured Threat Information eXpression version 2) is a standardized language for representing cyber threat intelligence (CTI) that enables the sharing of threat intelligence across organizations and security tools. It is important to Threat Intel because it allows security professionals to more easily and effectively analyze and respond to cyber threats, improving their overall threat intelligence capabilities.
At OneFirewall, our mission is to deliver a trustworthy and effective cybersecurity platform that safeguards against cyber attacks. To accomplish this goal, we leverage STIX2 structured information to proactively identify and block malicious actors. We also empower our users with access to this critical threat intelligence data, enabling them to enhance their own cybersecurity defenses.

STIX2.0

Use this method to get an array of active VPN for your organization

Get all

Create

Get Information and Installation instruction of a given VPN License ID

Get VPN ID

Delete VPN ID

OneFirewall revertive each file flagged as malware and associates it with a specific file type (when possible), or more precisely, a MIME type. Currently, OneFirewall only accepts file types from a predetermined list provided by this API.

File types

The \`/version\` API endpoint is primarily used to verify the operational status of the API service. When accessed, it responds with basic information indicating the current version of the API, along with a confirmation that the service is active and available. This endpoint typically does not require authentication and serves as a straightforward health check to ensure that the API is up and running correctly.

Health Check

You can call the API `/api/v1/info/<IPv4>` in order to receive GeoIP information for the IPv4. This API is useful when you want to verify public data in regards to the GeoIP of any IPv4

IP Metadata

To retrieve a list of well-known Content Delivery Network (CDN) providers along with their respective edge IP addresses, you can utilize the `/api/v1/info/cdn/list` endpoint. The data provided by this API is generally static, yet the R&D team at OneFirewall periodically updates it. It’s worth noting that CDN providers frequently acquire new IP addresses, making it impossible to guarantee that the following list is exhaustive at any given moment.

List of CDNs

You can call the API `/api/v1/info/domain/<domani_name>` in order to receive an array IPs resolved for the Domain name.

API Documentation

IPv4 Feeds

Domain Feeds

URL Feeds

Security Binary

STIX2 Feeds

Secure VPN

Tools/Utils

Introduction

High Level Design

APIs

IPv4 Feeds

Domain Feeds

URL Feeds

File Feeds

STIX v2.0

Tools and Utils

API Documentation

IPv4 Feeds

Domain Feeds

URL Feeds

Security Binary

STIX2 Feeds

Secure VPN

Tools/Utils

​High Level Design

​APIs

IPv4 Feeds

Domain Feeds

URL Feeds

File Feeds

STIX v2.0

Tools and Utils

High Level Design

APIs