Scanopy

https://scanopy.net/docs
Admin
Network discovery and visualization tool that automatically discovers hosts, services, and network...
Tokens:51,546
Snippets:595
Trust Score:5.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### List All Credentials Response Example

Source: https://scanopy.net/docs/api/credentials/get_all_credentials

This is an example of a successful response when listing credentials. It includes credential details, organization information, and pagination metadata.

```json
{
  "data": [
    {
      "credential_type": {
        "community": {
          "mode": "Inline",
          "value": "string"
        },
        "type": "SnmpV2c"
      },
      "name": "string",
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "tags": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "target_ips": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "api_version": 1,
    "pagination": {
      "has_more": true,
      "limit": 50,
      "offset": 0,
      "total_count": 142
    },
    "server_version": "0.16.1"
  },
  "success": true,
  "error": "string"
}
```

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

### Start Named Daemons After Initial Configuration

Source: https://scanopy.net/docs/guides/multiple-daemons

Once a daemon is initially configured with its specific bind address and port, subsequent starts only require the `--name` argument to load its namespaced configuration.

```bash
sudo scanopy-daemon --name eth0
sudo scanopy-daemon --name eth1
```

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

### Install and Configure Windows Service with NSSM

Source: https://scanopy.net/docs/setting-up-daemons/managing-daemons

Use NSSM to install the Scanopy daemon as a Windows service, configure its standard output and error logs, and then start the service. Includes commands for stopping and removing the service.

```powershell
nssm install ScanopyDaemon "C:\Path\To\scanopy-daemon.exe"
```

```powershell
nssm set ScanopyDaemon AppStdout "C:\ProgramData\scanopy\daemon.log"
nssm set ScanopyDaemon AppStderr "C:\ProgramData\scanopy\daemon.log"
nssm set ScanopyDaemon AppRotateFiles 1
```

```powershell
nssm start ScanopyDaemon
```

```powershell
Get-Service ScanopyDaemon
```

```powershell
nssm stop ScanopyDaemon
nssm remove ScanopyDaemon confirm
```

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

### Example Callback URL for Authentik

Source: https://scanopy.net/docs/guides/oidc

An example of a configured callback URL for the 'authentik' provider slug.

```text
http://scanopy.local:60072/api/auth/oidc/authentik/callback
```

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

### Enable and Start systemd Daemon Instances

Source: https://scanopy.net/docs/guides/multiple-daemons

Enable and start individual Scanopy daemon instances managed by systemd, using the interface name as the instance identifier.

```bash
sudo systemctl enable --now scanopy-daemon@eth0
sudo systemctl enable --now scanopy-daemon@eth1
```

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

### Complete docker-compose.yml Example with MACVLAN

Source: https://scanopy.net/docs/guides/macvlan-setup

This is a full example of a docker-compose.yml file configured for the Scanopy daemon using MACVLAN networking. It includes service definitions, environment variables, volumes, and network configuration.

```yaml
services:
  daemon:
    image: ghcr.io/scanopy/scanopy/daemon:latest
    container_name: scanopy-daemon
    restart: unless-stopped
    cap_add:
      - NET_RAW
    networks:
      scanopy_net:
        ipv4_address: 192.168.1.225
    environment:
      - SCANOPY_SERVER_URL=https://your-server.example.com
      - SCANOPY_NETWORK_ID=your-network-id
      - SCANOPY_DAEMON_API_KEY=your-api-key
    volumes:
      - daemon-config:/root/.config/daemon

networks:
  scanopy_net:
    driver: macvlan
    driver_opts:
      parent: eth0  # Your interface from step 1
    ipam:
      config:
        - subnet: 192.168.1.0/24
          gateway: 192.168.1.1

volumes:
  daemon-config:
```

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

### Install and Manage Linux systemd Service

Source: https://scanopy.net/docs/setting-up-daemons/managing-daemons

Use these commands to download the systemd service file, reload systemd, enable and start the Scanopy daemon service, and check its status.

```bash
sudo curl -o /etc/systemd/system/scanopy-daemon.service \
  https://raw.githubusercontent.com/scanopy/scanopy/main/scanopy-daemon.service
sudo systemctl daemon-reload
sudo systemctl enable scanopy-daemon
sudo systemctl start scanopy-daemon
```

```bash
sudo systemctl status scanopy-daemon
```

```bash
journalctl -u scanopy-daemon -f
```

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

### Example Pagination Query

Source: https://scanopy.net/docs/api

Demonstrates how to use query parameters to paginate through list endpoints, specifying the number of results and the offset.

```http
GET /api/v1/hosts?limit=10&offset=20
```

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

### Install systemd Template Unit

Source: https://scanopy.net/docs/guides/multiple-daemons

Download and install the systemd template unit for running multiple Scanopy daemon instances on Linux.

```bash
sudo curl -o /etc/systemd/system/scanopy-daemon@.service \
  https://raw.githubusercontent.com/scanopy/scanopy/main/scanopy-daemon%40.service
sudo systemctl daemon-reload
```

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

### Example Daemon API Key Response

Source: https://scanopy.net/docs/api/daemon-api-keys/list_daemon_api_keys

This is an example of a successful response when listing daemon API keys. It includes details about each key and pagination metadata.

```json
{
  "data": [
    {
      "created_at": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "key": "string",
      "last_used": "2019-08-24T14:15:22Z",
      "name": "string",
      "network_id": "d6797cf4-42b9-4cad-8591-9dd91c3f0fc3",
      "tags": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "updated_at": "2019-08-24T14:15:22Z",
      "expires_at": "2019-08-24T14:15:22Z",
      "is_enabled": true
    }
  ],
  "meta": {
    "api_version": 1,
    "pagination": {
      "has_more": true,
      "limit": 50,
      "offset": 0,
      "total_count": 142
    },
    "server_version": "0.16.1"
  },
  "success": true,
  "error": "string"
}
```

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

### Example Workloads Hierarchy

Source: https://scanopy.net/docs/using-scanopy/topology/workloads

Illustrates a typical nested structure of compute resources, from bare-metal hosts down to individual containers.

```text
bare-metal-host
  └── Proxmox
        ├── vm-web-server
        │     └── Docker
        │           ├── nginx
        │           ├── app
        │           └── postgres
        └── vm-monitoring
              └── Docker
                    ├── grafana
                    └── prometheus
```

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

### List All Bindings (Java)

Source: https://scanopy.net/docs/api/bindings/list_bindings

This Java example uses the Apache HttpClient library to fetch bindings. It demonstrates setting the Authorization header and handling the response. Replace 'YOUR_API_KEY' with your actual Bearer token.

```java
import org.apache.http.HttpEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

import java.io.IOException;

public class ListBindings {

    public static void main(String[] args) {
        String url = "https://loading/api/v1/bindings";
        String apiKey = "YOUR_API_KEY"; // Replace with your actual API key

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpGet request = new HttpGet(url);
            request.addHeader("Authorization", "Bearer " + apiKey);
            request.addHeader("Content-Type", "application/json");

            try (CloseableHttpResponse response = httpClient.execute(request)) {
                HttpEntity entity = response.getEntity();
                if (entity != null) {
                    String result = EntityUtils.toString(entity);
                    System.out.println(result);
                }
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}
```

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

### List All Bindings (C#)

Source: https://scanopy.net/docs/api/bindings/list_bindings

This C# example uses HttpClient to list bindings. It shows how to set the Authorization header. Remember to replace 'YOUR_API_KEY' with your actual Bearer token.

```csharp
using System;
using System.Net.Http;
using System.Threading.Tasks;

public class ListBindings
{
    public static async Task Main(string[] args)
    {
        var url = "https://loading/api/v1/bindings";
        var apiKey = "YOUR_API_KEY"; // Replace with your actual API key

        using (var httpClient = new HttpClient())
        {
            httpClient.DefaultRequestHeaders.Add("Authorization", "Bearer " + apiKey);
            httpClient.DefaultRequestHeaders.Add("Content-Type", "application/json");

            try
            {
                HttpResponseMessage response = await httpClient.GetAsync(url);
                response.EnsureSuccessStatusCode(); // Throw an exception if the status code is not successful

                string responseBody = await response.Content.ReadAsStringAsync();
                Console.WriteLine(responseBody);
            }
            catch (HttpRequestException e)
            {
                Console.WriteLine($"Error fetching bindings: {e.Message}");
            }
        }
    }
}
```

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

### List All Bindings (JavaScript)

Source: https://scanopy.net/docs/api/bindings/list_bindings

This JavaScript example demonstrates how to fetch a list of bindings using the Fetch API. It includes setting the Authorization header. Replace 'YOUR_API_KEY' with your actual Bearer token.

```javascript
const url = "https://loading/api/v1/bindings";
const headers = {
  "Authorization": "Bearer YOUR_API_KEY",
  "Content-Type": "application/json"
};

fetch(url, {
  method: "GET",
  headers: headers
})
.then(response => {
  if (!response.ok) {
    throw new Error(`HTTP error! status: ${response.status}`);
  }
  return response.json();
})
.then(data => {
  console.log(data);
})
.catch(error => {
  console.error("Error fetching bindings:", error);
});
```

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

### Stop and Start systemd Daemon Instances for Upgrade

Source: https://scanopy.net/docs/guides/multiple-daemons

Stop and start individual Scanopy daemon instances managed by systemd when upgrading the application.

```bash
# systemd template instances
sudo systemctl stop scanopy-daemon@eth0
sudo systemctl stop scanopy-daemon@eth1

# replace the binary (use the install command from the app)

sudo systemctl start scanopy-daemon@eth0
sudo systemctl start scanopy-daemon@eth1
```

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

### Credential Summary at Session Start

Source: https://scanopy.net/docs/setting-up-daemons/troubleshooting-scans/credentials

Daemon logs a summary of configured credentials at the beginning of each discovery session. Look for INFO on all fields for successful loading, ERROR on file fields indicating unreadable files, and WARN on the credential header for any issues.

```log
INFO  Credentials:
INFO    For Docker proxy connection on 192.168.4.126
INFO      Port            2376
INFO      SSL cert        successfully read from /path/to/client-cert.pem
INFO      SSL key         successfully read from /path/to/client-key.pem
INFO      SSL chain       successfully read from /path/to/ca.pem
WARN    For Docker proxy connection on 192.168.4.127
INFO      Port            2376
ERROR     SSL cert        failed to read from /non-existent.pem
ERROR     SSL key         failed to read from /non-existent.pem
ERROR     SSL chain       failed to read from /non-existent.pem
INFO    For SNMP queries on all scanned hosts
INFO      Community       ******** (10 chars)
INFO      Version         V2c
```

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

### Verify Scanopy Installation

Source: https://scanopy.net/docs/self-hosted-server/server-installation

Checks the status of the running Scanopy services.

```bash
docker compose ps
```

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

### List All Bindings (cURL)

Source: https://scanopy.net/docs/api/bindings/list_bindings

Use this cURL command to make a GET request to the API endpoint for listing all bindings. Ensure you include the Authorization header with your API key.

```bash
curl -X GET "https://loading/api/v1/bindings"
```

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

### Deploy Docker Compose Stack

Source: https://scanopy.net/docs/guides/macvlan-setup

Use this command to build and start the services defined in your docker-compose.yml file in detached mode.

```bash
docker compose up -d
```

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

### Request Path Dependency Example

Source: https://scanopy.net/docs/using-scanopy/dependencies

Illustrates a linear request flow through multiple services. Use this for request routing, data pipelines, and backup chains.

```text
Internet → Reverse Proxy → App Server → Database
```

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

### Backup Scanopy PostgreSQL Database (Docker)

Source: https://scanopy.net/docs/self-hosted-server/troubleshooting

Commands to backup and restore the Scanopy PostgreSQL database when using a Docker setup.

```bash
# Backup
docker exec scanopy-db pg_dump -U postgres scanopy > scanopy_backup.sql

# Restore
docker exec -i scanopy-db psql -U postgres scanopy < scanopy_backup.sql
```

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

### Configure macOS launchd Agent for Scanopy Daemon

Source: https://scanopy.net/docs/setting-up-daemons/managing-daemons

Create a launch agent plist file to define the Scanopy daemon service, then load and start it using launchctl. This ensures the daemon runs automatically.

```bash
cat > ~/Library/LaunchAgents/com.scanopy.daemon.plist <<EOF
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>Label</key>
    <string>com.scanopy.daemon</string>
    <key>ProgramArguments</key>
    <array>
        <string>/usr/local/bin/scanopy-daemon</string>
    </array>
    <key>RunAtLoad</key>
    <true/>
    <key>KeepAlive</key>
    <true/>
    <key>StandardOutPath</key>
    <string>/tmp/scanopy-daemon.stdout.log</string>
    <key>StandardErrorPath</key>
    <string>/tmp/scanopy-daemon.stderr.log</string>
</dict>
</plist>
EOF
```

```bash
launchctl load ~/Library/LaunchAgents/com.scanopy.daemon.plist
```

```bash
launchctl list | grep scanopy
```

```bash
launchctl unload ~/Library/LaunchAgents/com.scanopy.daemon.plist
```

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

### Example Tag Schemes

Source: https://scanopy.net/docs/using-scanopy/organization

Illustrates common tag schemes for environment classification, ownership, and compliance. Tags are organization-level labels for categorizing and filtering entities.

```text
production + critical    → Core infrastructure
production + standard    → Supporting services
staging + low-priority   → Test environments
```

```text
platform-team     → Infrastructure, databases, networking
frontend-team     → Web servers, CDN, static assets
data-team         → Analytics, ETL, data warehouses
```

```text
pci-scope         → Systems handling payment data
hipaa             → Healthcare data systems
gdpr              → EU user data processing
internal-only     → No external exposure allowed
```

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

### Docker Compose Example with OIDC Environment Variable

Source: https://scanopy.net/docs/guides/oidc

Integrate OIDC configuration directly into your `docker-compose.yml` file using the `SCANOPY_OIDC_PROVIDERS` environment variable. This is useful for containerized environments.

```yaml
services:
  scanopy-server:
    image: ghcr.io/scanopy/scanopy/server:latest
    environment:
      SCANOPY_PUBLIC_URL: https://scanopy.example.com
      SCANOPY_OIDC_PROVIDERS: >-
        [{name="Authentik",slug="authentik",issuer_url="https://auth.example.com/application/o/scanopy",client_id="your-client-id",client_secret="your-client-secret"}]
```

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

### Successful Bulk Credential Creation Response

Source: https://scanopy.net/docs/api/credentials/bulk_create_credentials

This is an example of a successful response (HTTP 200) when creating credentials in bulk. It includes metadata, a success flag, and the data for the created credentials, including their IDs and timestamps.

```json
{
  "meta": {
    "api_version": 1,
    "server_version": "0.16.1"
  },
  "success": true,
  "data": [
    {
      "credential_type": {
        "community": {
          "mode": "Inline",
          "value": "string"
        },
        "type": "SnmpV2c"
      },
      "name": "string",
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "tags": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "target_ips": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "error": "string"
}
```

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

### Hub and Spoke Dependency Example

Source: https://scanopy.net/docs/using-scanopy/dependencies

Depicts a central service connected to multiple dependent services. Use this when several services connect to a shared resource like a database, DNS server, or message queue.

```text
      Web App ─┐
      Workers ──→ Database
      Admin ───┘
```

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

### Configure Server via Command-Line Flags

Source: https://scanopy.net/docs/reference/server-configuration

Configure server port and database connection using command-line arguments for binary builds.

```bash
./scanopy-server --port 60072 --database-url postgresql://...
```

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

### Get Binding by ID using cURL

Source: https://scanopy.net/docs/api/bindings/get_binding_by_id

Use this cURL command to make a GET request to retrieve a specific binding by its ID. Ensure you replace `{id}` with the actual binding ID.

```bash
curl -X GET "https://scanopy.net/api/v1/bindings/497f6eca-6276-4993-bfeb-53cbbbba6f08"
```

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

### List All Bindings (Python)

Source: https://scanopy.net/docs/api/bindings/list_bindings

This Python script shows how to list bindings using the 'requests' library. It includes setting the Authorization header. Ensure you replace 'YOUR_API_KEY' with your actual Bearer token.

```python
import requests

url = "https://loading/api/v1/bindings"
headers = {
    "Authorization": "Bearer YOUR_API_KEY", # Replace with your actual API key
    "Content-Type": "application/json"
}

try:
    response = requests.get(url, headers=headers)
    response.raise_for_status()  # Raise an exception for bad status codes
    data = response.json()
    print(data)
except requests.exceptions.RequestException as e:
    print(f"Error fetching bindings: {e}")
```

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

### Get Credential by ID

Source: https://scanopy.net/docs/api/credentials/get_credential_by_id

Fetches a specific credential by its ID. Requires an API key for authorization.

```APIDOC
## GET /api/v1/credentials/{id}

### Description
Retrieves a specific credential using its unique identifier.

### Method
GET

### Endpoint
https://scanopy.net/api/v1/credentials/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Credential ID. Format: uuid

#### Request Headers
- **Authorization** (string) - Required - User API key (Bearer scp_u_...). Example: Bearer scp_u_...

### Response
#### Success Response (200)
- **meta** (object)
  - **api_version** (integer)
  - **server_version** (string)
- **success** (boolean)
- **data** (object)
  - **credential_type** (object)
    - **community** (object)
      - **mode** (string)
      - **value** (string)
    - **type** (string)
  - **name** (string)
  - **organization_id** (string)
  - **tags** (array of strings)
  - **target_ips** (array of strings)
  - **created_at** (string)
  - **id** (string)
  - **updated_at** (string)
- **error** (string)

### Request Example
```curl
curl -X GET "https://scanopy.net/api/v1/credentials/497f6eca-6276-4993-bfeb-53cbbbba6f08"
```

### Response Example
```json
{
  "meta": {
    "api_version": 1,
    "server_version": "0.16.1"
  },
  "success": true,
  "data": {
    "credential_type": {
      "community": {
        "mode": "Inline",
        "value": "string"
      },
      "type": "SnmpV2c"
    },
    "name": "string",
    "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
    "tags": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "target_ips": [
      "string"
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "error": "string"
}
```
```

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

### Get Binding by ID

Source: https://scanopy.net/docs/api/bindings/get_binding_by_id

Fetches a binding by its ID. Requires an Authorization header with a user API key.

```APIDOC
## GET /api/v1/bindings/{id}

### Description
Retrieves a specific binding using its unique identifier.

### Method
GET

### Endpoint
/api/v1/bindings/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Binding ID (Format: uuid)

#### Request Headers
- **Authorization** (string) - Required - User API key (Bearer scp_u_...)

### Response
#### Success Response (200)
- **meta** (object) - API metadata.
  - **api_version** (integer) - The API version.
  - **server_version** (string) - The server version.
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - The binding details.
  - **created_at** (string) - Timestamp of creation.
  - **id** (string) - The unique identifier of the binding.
  - **ip_address_id** (string) - The ID of the associated IP address.
  - **network_id** (string) - The ID of the associated network.
  - **port_id** (string) - The ID of the associated port.
  - **service_id** (string) - The ID of the associated service.
  - **type** (string) - The type of the binding.
  - **updated_at** (string) - Timestamp of the last update.
- **error** (string) - Error message if the request failed.

#### Response Example (200 OK)
```json
{
  "meta": {
    "api_version": 1,
    "server_version": "0.16.1"
  },
  "success": true,
  "data": {
    "created_at": "2026-04-22T15:57:37.855455Z",
    "id": "b4e6036e-f983-4b84-b97e-5e509b114bd0",
    "ip_address_id": "550e8400-e29b-41d4-a716-446655440005",
    "network_id": "550e8400-e29b-41d4-a716-446655440002",
    "port_id": "550e8400-e29b-41d4-a716-446655440006",
    "service_id": "550e8400-e29b-41d4-a716-446655440007",
    "type": "Port",
    "updated_at": "2026-04-22T15:57:37.855455Z"
  },
  "error": "string"
}
```

#### Error Response Example
```json
{
  "meta": {
    "api_version": 1,
    "server_version": "0.16.1"
  },
  "success": true,
  "code": "string",
  "error": "string",
  "params": {
    "property1": null,
    "property2": null
  }
}
```
```

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

### List All Bindings (Go)

Source: https://scanopy.net/docs/api/bindings/list_bindings

This Go program shows how to retrieve a list of bindings from the Scanopy API. It includes setting the Authorization header and handling the JSON response. Remember to replace 'YOUR_API_KEY' with your actual token.

```go
package main

import (
	"encoding/json"
	"fmt"
	"io/ioutil"
	"net/http"
	"os"
)

func main() {
	url := "https://loading/api/v1/bindings"
	apiKey := "YOUR_API_KEY" // Replace with your actual API key

	client := &http.Client{}
	req, err := http.NewRequest("GET", url, nil)
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error creating request: %v\n", err)
		return
	}

	req.Header.Add("Authorization", "Bearer "+apiKey)
	req.Header.Add("Content-Type", "application/json")

	resp, err := client.Do(req)
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error sending request: %v\n", err)
		return
	}

	defer resp.Body.Close()

	body, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error reading response body: %v\n", err)
		return
	}

	if resp.StatusCode != http.StatusOK {
		fmt.Fprintf(os.Stderr, "API request failed with status code: %d, body: %s\n", resp.StatusCode, string(body))
		return
	}

	// You can unmarshal the JSON body into a Go struct here
	// For simplicity, we'll just print the raw JSON
	fmt.Println(string(body))
}
```

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

### Successful Rotation Response

Source: https://scanopy.net/docs/api/daemon-api-keys/rotate_key_handler

This is an example of a successful response when rotating a Daemon API Key. It includes metadata and the new key.

```json
{
  "meta": {
    "api_version": 1,
    "server_version": "0.16.1"
  },
  "success": true,
  "data": "string",
  "error": "string"
}
```

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

### Run daemon with command-line arguments

Source: https://scanopy.net/docs/reference/daemon-configuration

Use command-line arguments to configure the daemon. This method has the highest priority.

```bash
scanopy-daemon --server-url http://192.168.1.100:60072 --api-key YOUR_KEY
```

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

### Successful Binding Response

Source: https://scanopy.net/docs/api/bindings/get_binding_by_id

This is an example of a successful JSON response when retrieving a binding by its ID. It includes metadata and the details of the binding.

```json
{
  "meta": {
    "api_version": 1,
    "server_version": "0.16.1"
  },
  "success": true,
  "data": {
    "created_at": "2026-04-22T15:57:37.855455Z",
    "id": "b4e6036e-f983-4b84-b97e-5e509b114bd0",
    "ip_address_id": "550e8400-e29b-41d4-a716-446655440005",
    "network_id": "550e8400-e29b-41d4-a716-446655440002",
    "port_id": "550e8400-e29b-41d4-a716-446655440006",
    "service_id": "550e8400-e29b-41d4-a716-446655440007",
    "type": "Port",
    "updated_at": "2026-04-22T15:57:37.855455Z"
  },
  "error": "string"
}
```

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

### List Existing Daemon Configurations

Source: https://scanopy.net/docs/guides/multiple-daemons

List the configuration directories for Scanopy daemon instances on Linux, macOS, and Windows.

```bash
# Linux
ls ~/.config/scanopy/daemon/
```

```bash
# macOS
ls ~/Library/Application\ Support/com.scanopy.daemon/
```

```cmd
# Windows
dir %APPDATA%\scanopy\daemon\
```

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

### Successful Credential Retrieval Response

Source: https://scanopy.net/docs/api/credentials/get_credential_by_id

This is an example of a successful response when retrieving a credential by its ID. It includes metadata and the detailed data of the credential.

```json
{
  "meta": {
    "api_version": 1,
    "server_version": "0.16.1"
  },
  "success": true,
  "data": {
    "credential_type": {
      "community": {
        "mode": "Inline",
        "value": "string"
      },
      "type": "SnmpV2c"
    },
    "name": "string",
    "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
    "tags": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "target_ips": [
      "string"
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "error": "string"
}
```

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

### Configure Bind Address and Port via Environment Variables or Config File

Source: https://scanopy.net/docs/guides/multiple-daemons

The `--bind-address` and `--daemon-port` settings can be configured using environment variables (`SCANOPY_BIND_ADDRESS`, `SCANOPY_DAEMON_PORT`) or within the `config.json` file.

```bash
# Environment variables
SCANOPY_BIND_ADDRESS=192.168.1.10
SCANOPY_DAEMON_PORT=60073

# config.json
{ "bind_address": "192.168.1.10", "daemon_port": 60073 }
```

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

### Get Daemon API Key by ID

Source: https://scanopy.net/docs/api/daemon-api-keys/get_daemon_api_key_by_id

Fetches a Daemon API Key using its ID. Requires an 'Authorization' header with a 'user_api_key'.

```APIDOC
## GET /api/v1/auth/daemon/{id}

### Description
Retrieves a specific Daemon API Key by its unique identifier.

### Method
GET

### Endpoint
/api/v1/auth/daemon/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Daemon API Key ID (Format: uuid)

#### Headers
- **Authorization** (string) - Required - User API key (Bearer scp_u_...)

### Response
#### Success Response (200)
- **meta** (object)
  - **api_version** (integer)
  - **server_version** (string)
- **success** (boolean)
- **data** (object)
  - **key** (string)
  - **last_used** (string)
  - **name** (string)
  - **network_id** (string)
  - **tags** (array of strings)
  - **expires_at** (string)
  - **is_enabled** (boolean)
  - **created_at** (string)
  - **id** (string)
  - **updated_at** (string)
- **error** (string)

#### Response Example (200)
```json
{
  "meta": {
    "api_version": 1,
    "server_version": "0.16.1"
  },
  "success": true,
  "data": {
    "key": "string",
    "last_used": "2019-08-24T14:15:22Z",
    "name": "string",
    "network_id": "d6797cf4-42b9-4cad-8591-9dd91c3f0fc3",
    "tags": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "expires_at": "2019-08-24T14:15:22Z",
    "is_enabled": true,
    "created_at": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "error": "string"
}
```

#### Error Response Example
```json
{
  "meta": {
    "api_version": 1,
    "server_version": "0.16.1"
  },
  "success": true,
  "code": "string",
  "error": "string",
  "params": {
    "property1": null,
    "property2": null
  }
}
```
```

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

### Diagnose Integrated Daemon Initialization Issues

Source: https://scanopy.net/docs/self-hosted-server/troubleshooting

Use these Docker commands to check daemon logs and connectivity to the Scanopy server for troubleshooting initialization problems.

```bash
# Check daemon logs
docker logs scanopy-daemon

# Check if daemon can reach server
docker exec scanopy-daemon curl http://scanopy-server:60072/api/health
```

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

### Change Port Mapping in docker-compose.yml

Source: https://scanopy.net/docs/self-hosted-server/troubleshooting

Modify the port mapping in your docker-compose.yml file to resolve 'address already in use' errors when starting the Scanopy server.

```yaml
ports:
  - '8080:60072' # Change 60072 to any available port
```

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

### Download Docker Compose File

Source: https://scanopy.net/docs/self-hosted-server/server-installation

Fetches the default docker-compose.yml file from the official GitHub repository.

```bash
curl -O https://raw.githubusercontent.com/scanopy/scanopy/refs/heads/main/docker-compose.yml
```

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

### Get Credential by ID using cURL

Source: https://scanopy.net/docs/api/credentials/get_credential_by_id

Demonstrates how to retrieve a credential by its ID using a cURL command. Ensure you include the correct authorization header.

```bash
curl -X GET "https://scanopy.net/api/v1/credentials/497f6eca-6276-4993-bfeb-53cbbbba6f08"
```

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

### Configure Server via Environment Variables

Source: https://scanopy.net/docs/reference/server-configuration

Set server port and database connection details using environment variables in docker-compose.

```yaml
environment:
  - SCANOPY_SERVER_PORT=60072
  - DATABASE_URL=postgresql://postgres:password@db:5432/scanopy
```

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

### List All Credentials (cURL)

Source: https://scanopy.net/docs/api/credentials/get_all_credentials

Use this cURL command to fetch all credentials from your organization. You can append query parameters to filter the results.

```bash
curl -X GET "https://loading/api/v1/credentials"
```

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

### Example Error Message: Unexpected issuer URI

Source: https://scanopy.net/docs/guides/oidc

This error indicates a mismatch in the issuer URI between your Scanopy configuration and your OIDC provider. Ensure the trailing slash in the issuer URL is consistent.

```text
Failed to generate auth URL: Validation error: unexpected issuer URI
`https://auth.example.com/app/` (expected `https://auth.example.com/app`)
```

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

### Verify VPN Interface

Source: https://scanopy.net/docs/guides/scanning-vpn-networks

Run this command to check if a VPN interface (e.g., wg0, tailscale0, tun0) is active on the daemon's host.

```bash
ip addr
```

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

### Configure Interfaces via Environment Variable or Config File

Source: https://scanopy.net/docs/guides/multiple-daemons

The `--interfaces` setting can also be configured using the `SCANOPY_INTERFACES` environment variable or within the `config.json` file.

```bash
# Environment variable
SCANOPY_INTERFACES=eth0,eth1

# config.json
{ "interfaces": ["eth0", "eth1"] }
```

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

### Build Custom Scanopy Server Image

Source: https://scanopy.net/docs/reference/server-configuration

Rebuild the Docker image with custom build arguments for the public server hostname and port when the API is on a different domain than the UI.

```bash
docker build \
  --build-arg PUBLIC_SERVER_HOSTNAME=api.example.com \
  --build-arg PUBLIC_SERVER_PORT=8080 \
  -f backend/Dockerfile \
  -t scanopy-server:custom \
  .
```

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

### List All Daemon API Keys

Source: https://scanopy.net/docs/api/daemon-api-keys/list_daemon_api_keys

Use this cURL command to list all daemon API keys. Ensure you include the Authorization header with your API key.

```bash
curl -X GET "https://loading/api/v1/auth/daemon"
```

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

### Enable Npcap for Broadcast ARP (Environment Variable)

Source: https://scanopy.net/docs/setting-up-daemons/troubleshooting-scans/host-discovery

Set the 'SCANOPY_USE_NPCAP_ARP' environment variable to 'true' to enable Npcap for broadcast ARP scanning on Windows. Ensure Npcap is installed with WinPcap API compatibility.

```bash
export SCANOPY_USE_NPCAP_ARP=true
```

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

### Configure Keycloak OIDC Provider

Source: https://scanopy.net/docs/guides/oidc

Integrate Keycloak as an OIDC provider by adding its details to your `oidc.toml`. Remember to copy the client secret from the Keycloak Credentials tab.

```toml
[[oidc_providers]]
name = "Keycloak"
slug = "keycloak"
logo = "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/keycloak.svg"
issuer_url = "https://keycloak.yourdomain.com/realms/your-realm"
client_id = "scanopy"
client_secret = "your-client-secret"
```

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

### Uninstall Linux/macOS Binary Daemon

Source: https://scanopy.net/docs/setting-up-daemons/managing-daemons

Commands to uninstall a Scanopy daemon installed via a binary on Linux or macOS. This includes stopping and disabling the systemd service, removing the service file, the binary, and configuration files.

```bash
# Stop systemd service (if installed)
sudo systemctl stop scanopy-daemon
sudo systemctl disable scanopy-daemon
sudo rm /etc/systemd/system/scanopy-daemon.service

# Remove binary
sudo rm /usr/local/bin/scanopy-daemon

# Remove configuration
rm -rf ~/.config/scanopy/  # Linux
rm -rf ~/Library/Application\ Support/com.scanopy.daemon/  # macOS
```

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

### Configure systemd Service Environment

Source: https://scanopy.net/docs/guides/multiple-daemons

Set environment variables for Scanopy daemon instances using systemd overrides to configure bind address and port for each instance.

```bash
ExecStart=/usr/local/bin/scanopy-daemon --name=%i --interfaces=%i
SyslogIdentifier=scanopy-daemon-%i
```

```ini
[Service]
Environment="SCANOPY_BIND_ADDRESS=192.168.1.10"
Environment="SCANOPY_DAEMON_PORT=60073"
```

```ini
[Service]
Environment="SCANOPY_BIND_ADDRESS=10.0.0.10"
Environment="SCANOPY_DAEMON_PORT=60074"
```

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

### Retrieve a Daemon API Key by ID using cURL

Source: https://scanopy.net/docs/api/daemon-api-keys/get_daemon_api_key_by_id

Use this cURL command to make a GET request to the API endpoint for retrieving a specific Daemon API Key. Replace `{id}` with the actual key ID.

```bash
curl -X GET "https://scanopy.net/api/v1/auth/daemon/497f6eca-6276-4993-bfeb-53cbbbba6f08"
```

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

### Configure Unique Ports and Bind Addresses for Daemons

Source: https://scanopy.net/docs/guides/multiple-daemons

To avoid port conflicts when running multiple daemons on the same host, assign each a unique `--bind-address` and `--daemon-port`. This ensures each instance listens on a distinct IP and port.

```bash
# Daemon on eth0 (192.168.1.10) — uses default port
scanopy-daemon --name eth0 --interfaces eth0 \
  --bind-address 192.168.1.10 --daemon-port 60073

# Daemon on eth1 (10.0.0.10) — different port
scanopy-daemon --name eth1 --interfaces eth1 \
  --bind-address 10.0.0.10 --daemon-port 60074
```

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

### View Scanopy Daemon Logs

Source: https://scanopy.net/docs/setting-up-daemons/troubleshooting-setup

Commands to view Scanopy daemon logs depending on the platform and how it's run. Use '-f' to follow logs in real-time.

```bash
docker logs -f scanopy-daemon
```

```bash
journalctl -u scanopy-daemon -f
```

```bash
tail -f /tmp/scanopy-daemon.stderr.log
```

```powershell
Get-Content "C:\ProgramData\scanopy\daemon.log" -Wait
```

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

### Configure daemon with environment variables

Source: https://scanopy.net/docs/reference/daemon-configuration

Set environment variables to configure the daemon. This method overrides configuration file settings.

```bash
export SCANOPY_SERVER_URL=http://192.168.1.100:60072
export SCANOPY_DAEMON_API_KEY=YOUR_KEY
scanopy-daemon
```
Tokens:
Raw