Skip to content

Commit

Permalink
[documentation] First work on new version doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Samuel Hassine committed Dec 5, 2019
1 parent 4f2d4c6 commit 76a22e6
Show file tree
Hide file tree
Showing 5 changed files with 94 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
id: version-2.1.0-guide
title: User's guide
sidebar_label: User's guide
original_id: guide
---

The Python lib
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
id: version-2.1.0-overview
title: OpenCTI Python client
sidebar_label: Overview
original_id: overview
---

The `pycti` library is designed to help OpenCTI users and developers to programatically interact with the GraphQL API. It has been architectured to be easy to use and easy to maintain. The Python library requires Python >= 3. Let's get started.

## Installation

```bash
$ pip install pycti
```

## Getting started

### Initialization

The main class contains all what you need to interact with the platform, you just have to initialize it:

```python
# coding: utf-8

from pycti import OpenCTIApiClient

# OpenCTI initialization
opencti_api_client = OpenCTIApiClient(api_url, api_token, log_level, ssl_verify)
```

| Argument | Type | Description |
| ------------------------ | ------------------ | --------------------------------------------------------------------|
| api_url (*required*) | String | The URL of the OpenCTI instance |
| api_token (*required*) | String | The OpenCTI token |
| log_level (*optional*) | String | Log level, could be 'debug', 'info', 'warning' or 'error' |
| ssl_verify (*optional*) | Boolean | Enable or disable the SSL certificate verification |
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
id: version-2.1.0-reference
title: API reference
sidebar_label: API reference
original_id: reference
---

The Python lib
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"version-2.1.0-docs": {
"Getting Started": [
"version-2.1.0-getting-started/introduction",
"version-2.1.0-getting-started/architecture",
"version-2.1.0-getting-started/requirements"
],
"Installation": [
"version-2.1.0-installation/docker",
"version-2.1.0-installation/manual",
"version-2.1.0-installation/connectors",
"version-2.1.0-development/installation"
],
"Usage": [
"version-2.1.0-usage/overview",
"version-2.1.0-usage/model",
"version-2.1.0-usage/knowledge-create",
"version-2.1.0-usage/reports-create",
"version-2.1.0-usage/report-knowledge"
],
"Reference": [
"version-2.1.0-reference/relations",
"version-2.1.0-reference/inferences"
],
"Development": [
"version-2.1.0-development/connectors"
],
"Client libraries": [
"version-2.1.0-python",
{
"type": "subcategory",
"label": "Python",
"ids": [
"version-2.1.0-clients/python/overview",
"version-2.1.0-clients/python/guide",
"version-2.1.0-clients/python/reference"
]
}
]
}
}
1 change: 1 addition & 0 deletions opencti-documentation/website/versions.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[
"2.1.0",
"2.0.0",
"1.1.2",
"1.1.1",
Expand Down

0 comments on commit 76a22e6

Please sign in to comment.