Skip to content

Commit 576b8b8

Browse files
committed
Add documentation about using Atlant with cURL
1 parent 1696c5c commit 576b8b8

File tree

2 files changed

+740
-8
lines changed

2 files changed

+740
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,27 @@
1-
# F-Secure Atlant API Examples
1+
# WithSecure Atlant API Examples
22

3-
This repository contains examples for interacting with F-Secure Atlant API.
4-
F-Secure Atlant is a platform for building applications that are able to scan
3+
This repository contains examples for interacting with WithSecure Atlant API.
4+
WithSecure Atlant is a platform for building applications that are able to scan
55
and detect malicious files.
66

77
Atlant provides a REST API for scanning files and managing the product
88
configuration. Applications and services can use the API resources to analyze
99
content using always up-to-date heuristics and statistical techniques.
1010

11+
## Getting Started with Atlant Using cURL
12+
13+
[This guide](curl/README.md) explains how to get started with Atlant using cURL.
14+
It explains how to install and configure Atlant and how to do common scanning
15+
tasks using command-line `curl` utility.
16+
1117
## Python Examples
1218

1319
Python examples are available in `python` directory. The directory contains a
1420
Python package that provides a number of utilities that demonstrate how the
15-
F-Secure Atlant APIs can be used to configure the product and scan files. The
21+
WithSecure Atlant APIs can be used to configure the product and scan files. The
1622
included example utilities are:
1723

18-
- `atlant-token`: Tool for fetching access tokens from F-Secure Atlant's
24+
- `atlant-token`: Tool for fetching access tokens from WithSecure Atlant's
1925
internal authorization server
2026
- `atlant-get`: Tool for getting setting values using configuration API
2127
- `atlant-set`: Tool for changing setting values using configuration API
@@ -24,7 +30,7 @@ included example utilities are:
2430
- `atlant-icap`: Tool for using the ICAP interface
2531
- `atlant-dirscan`: Tool for scanning directories for harmful content
2632

27-
### Running the Python Examples
33+
### Installation
2834

2935
On a typical Linux system, the simplest way to try out the example utilities is
3036
to install them in a [virtual environment](https://docs.python.org/3/library/venv.html).
@@ -93,13 +99,13 @@ java -jar build/libs/scanner-all.jar AUTH-URL SCAN-URL CLIENT-ID CLIENT-SECRET F
9399
```
94100

95101
Here `AUTH-URL` is Atlant authorization server address and `SCAN-URL` is a
96-
scanning server address. See F-Secure Atlant user guide for information on how
102+
scanning server address. See WithSecure Atlant user guide for information on how
97103
to setup Atlant.
98104

99105
## Go Examples
100106

101107
In `go/scanner`, there is an example Go command line client capable of scanning
102-
files using F-Secure Atlant file scanning API. The client can be built with:
108+
files using WithSecure Atlant file scanning API. The client can be built with:
103109

104110
``` shell
105111
cd go/scanner

0 commit comments

Comments
 (0)