OctoXLabs

https://docs.octoxlabs.com/
Admin
OctoXLabs is a comprehensive cybersecurity asset management (CAASM) platform that discovers,...
Tokens:83,922
Snippets:1,806
Trust Score:6.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### Run OctoXLabs Setup Script

Source: https://docs.octoxlabs.com/setting-up-octoxlabs/installing-octoxlabs

Execute the OctoXLabs setup script after installation to begin configuration.

```bash
sudo octox-ctl -x setup
```

--------------------------------

### Dynamic Documentation Query Example

Source: https://docs.octoxlabs.com/adapters/adapters/manageengine-mdm

This example shows how to query the documentation dynamically using an HTTP GET request with the 'ask' query parameter. This is useful for retrieving specific information not explicitly present on the page.

```http
GET https://docs.octoxlabs.com/adapters/adapters/manageengine-mdm.md?ask=<question>
```

--------------------------------

### Query Documentation Example

Source: https://docs.octoxlabs.com/action-center/create-request/jira-notification

To get additional information not directly present on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.octoxlabs.com/action-center/create-request/jira-notification.md?ask=<question>
```

--------------------------------

### Start OctoXLabs Platform

Source: https://docs.octoxlabs.com/setting-up-octoxlabs/add-ssl-certificate-to-octoxlabs

After successfully adding the SSL certificate, use this command to restart the OctoXLabs platform and apply the new SSL configuration.

```bash
octox-ctl -x up
```

--------------------------------

### Cornerstone Connection Test Example

Source: https://docs.octoxlabs.com/adapters/adapters/cornerstone

This example demonstrates how to perform a connection test to ensure a valid connection to the Cornerstone host. The discovery operation's details will be visible on the Assets page upon finalization.

```bash
GET https://docs.octoxlabs.com/adapters/adapters/cornerstone.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.octoxlabs.com/adapters/adapters/wp-engine

To get additional information not directly present on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.octoxlabs.com/adapters/adapters/wp-engine.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.octoxlabs.com/adapters/adapters/bitsight-security-ratings

To get information not explicitly on this page, make an HTTP GET request to the current URL with the 'ask' query parameter. The question should be specific and self-contained.

```HTTP
GET https://docs.octoxlabs.com/adapters/adapters/bitsight-security-ratings.md?ask=<question>
```

--------------------------------

### BigFix Example Query

Source: https://docs.octoxlabs.com/adapters/adapters/bigfix-formally-ibm-bigfix

This example demonstrates how to query BigFix for computer information including names, IDs, last report times, operating systems, IP addresses, and agent versions. It filters results for computers matching a specific name.

```relevance
(names of it, ids of it, last report time of it, operating systems of it, ip addresses of it, agent versions of it) of bes computers whose (name of it = "name_of_the_hosts_will_be_here")
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.octoxlabs.com/adapters/adapters/falcon-crowdstrike-spotlight

To get additional information not directly present on the page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.octoxlabs.com/adapters/adapters/falcon-crowdstrike-spotlight.md?ask=<question>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.octoxlabs.com/adapters/adapters/eset-inspect

Perform an HTTP GET request to the documentation URL with the 'ask' query parameter to dynamically query for information. Use this when the answer is not explicitly present or for clarification.

```http
GET https://docs.octoxlabs.com/adapters/adapters/eset-inspect.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.octoxlabs.com/adapters/adapters/admin-by-request

To get information not explicitly present on the page, make an HTTP GET request to the page URL with an 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.octoxlabs.com/adapters/adapters/admin-by-request.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.octoxlabs.com/adapters/adapters/checkpoint-harmony-mobile

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query the documentation. The question should be specific, self-contained, and written in natural language. The response will contain a direct answer and relevant excerpts.

```HTTP
GET https://docs.octoxlabs.com/adapters/adapters/checkpoint-harmony-mobile.md?ask=<question>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.octoxlabs.com/action-center/create-request/service-desk-notification

To get additional information not explicitly present on the page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.octoxlabs.com/action-center/create-request/service-desk-notification.md?ask=<question>
```

--------------------------------

### Query CyberX Documentation via HTTP GET

Source: https://docs.octoxlabs.com/adapters/adapters/cyberx

Use this method to dynamically query the documentation. Perform an HTTP GET request on the current page URL with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.octoxlabs.com/adapters/adapters/cyberx.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET Request

Source: https://docs.octoxlabs.com/adapters/adapters/freeipa

To get additional information not directly present on the page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.octoxlabs.com/adapters/adapters/freeipa.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.octoxlabs.com/adapters/adapters/bitdefender

To get additional information not directly present on the page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.octoxlabs.com/adapters/adapters/bitdefender.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.octoxlabs.com/adapters/adapters/envoy

Use this method to ask questions about the documentation. The response includes direct answers and relevant excerpts.

```http
GET https://docs.octoxlabs.com/adapters/adapters/envoy.md?ask=<question>
```

--------------------------------

### Query Documentation with HTTP GET

Source: https://docs.octoxlabs.com/adapters/adapters/asgard-asset-management

To get information not explicitly present on the page, perform an HTTP GET request to the page URL with the 'ask' query parameter. This is useful for clarifications or retrieving related documentation sections.

```http
GET https://docs.octoxlabs.com/adapters/adapters/asgard-asset-management.md?ask=<question>
```

--------------------------------

### Query Zenoss Documentation Dynamically

Source: https://docs.octoxlabs.com/adapters/adapters/zenoss

Perform an HTTP GET request to the current page URL with the 'ask' query parameter to dynamically query the documentation. Use this when the answer is not explicitly present, for clarification, or to retrieve related sections.

```http
GET https://docs.octoxlabs.com/adapters/adapters/zenoss.md?ask=<question>
```
Tokens:
Raw