NodeZero

https://docs.horizon3.ai/
Admin
NodeZero is an autonomous penetration testing platform by Horizon3.ai that helps users identify,...
Tokens:549,607
Snippets:6,304
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### ServiceNow Setup Script Output

Source: https://docs.horizon3.ai/portal/settings/integrations/servicenow-vr?q=

Example of the console output generated during the initial execution of the NodeZero setup script.

```text
[NZ setup] NodeZero setup script v2.1.0 — starting
[NZ setup] Resolved scopes: VR=..., SecCmn=..., role sn_vul.vulnerability_admin=...
[NZ setup] --- Role ---
[NZ setup] CREATED role sn_vul.nodezero_integration (...)
[NZ setup] CREATED role inheritance: sn_vul.nodezero_integration contains sn_vul.vulnerability_admin
[NZ setup] --- Integration Definition ---
[NZ setup] CREATED integration definition (...)
[NZ setup] --- Integration Instance ---
[NZ setup] CREATED integration instance (...)
[NZ setup] --- ACLs ---
[NZ setup] SKIPPED ACL sn_vul_third_party_entry/create — already matches (...)
[NZ setup] CREATED role grant on ACL sn_vul_third_party_entry/create
... (5 pre-existing OOTB ACLs: SKIPPED ACL + CREATED role grant)
[NZ setup] CREATED ACL sn_vul_vulnerable_item.vulnerability/create (...)
[NZ setup] CREATED role grant on ACL sn_vul_vulnerable_item.vulnerability/create
[NZ setup] --- Severity Mapping ---
[NZ setup] CREATED severity map 1→1 (...)
...
[NZ setup] --- Business Rules ---
[NZ setup] CREATED BR: run CI match immediately (...)
[NZ setup] CREATED BR: DI→VI CI cascade (on DI) (...)
[NZ setup] CREATED BR: DI→VI CI cascade (on VI) (...)
[NZ setup] =====================================================
[NZ setup] NodeZero setup complete.
[NZ setup] Created: 19
[NZ setup] Updated: 0
[NZ setup] Skipped: 5
[NZ setup] Errors:  0
[NZ setup] =====================================================
```

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

### Execute NodeZero Ubuntu Setup Script

Source: https://docs.horizon3.ai/downloads/linux_upgrade

Download and run the setup script on a host with sudo permissions. The script will automatically reboot the system upon completion.

```bash
curl -o linux-build.sh https://downloads.horizon3ai.com/utilities/linux-build.sh
bash linux-build.sh
sudo rm -f linux-build.sh
```

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

### REST API Request Pattern

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Example of multiple HTTP GET requests required to fetch nested data in a traditional REST API.

```bash
# Fetch a list of pentests
GET /v1/pentests

# Fetch details for one pentest
GET /v1/pentests/abc-123

# Fetch weaknesses for that pentest
GET /v1/pentests/abc-123/weaknesses

# Fetch affected host for a weakness
GET /v1/pentests/abc-123/weaknesses/weakness-1/affected_host
```

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

### Execution Examples for install_agent

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Command-line examples for executing the mutation using Python, cURL, and the h3-cli tool.

```bash
python h3_gql.py ./install_agent.graphql '{
    "name": "runner-production",
    "is_kubernetes": false
}'
```

```bash
./h3_gql.sh ./install_agent.graphql '{
    "name": "runner-production",
    "is_kubernetes": false
}'
```

```bash
h3 gql ./install_agent.graphql '{
    "name": "runner-production",
    "is_kubernetes": false
}'
```

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

### AnnotationStatus Example

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Example of an AnnotationStatus value.

```graphql
"FIXED"
```

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

### Example Response for install_agent

Source: https://docs.horizon3.ai/api/graphql?h=schedule

A sample JSON response returned by the install_agent mutation.

```json
{
  "data": {
    "install_agent": {
      "command": "docker run -d --name runner-production --restart unless-stopped -v /var/run/docker.sock:/var/run/docker.sock -e H3_API_KEY=h3_api_sk_abcdef123456789 -e H3_AGENT_NAME=runner-production horizon3ai/h3-cli:latest agent start",
      "kubernetes_install_command": null,
      "agent": {
        "uuid": "1234abcd-1234-abcd-1234-abcd1234abcd",
        "name": "runner-production",
        "created_at": "2024-01-15T10:30:00Z",
        "is_kubernetes": false,
        "kubernetes_namespace": null
      }
    }
  }
}
```

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

### AuthzRole Example

Source: https://docs.horizon3.ai/api/graphql?h=schedule

An example value for an authorization role.

```text
"USER"
```

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

### Execution Examples

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Command-line examples for executing the query using Python, cURL, and h3-cli helpers.

```bash
python h3_gql.py ./external_domain_xops_csv_presigned_url.graphql '{
    "op_series_uuid": "1234abcd-1234-abcd-1234-abcd1234abcd"
}'
```

```bash
./h3_gql.sh ./external_domain_xops_csv_presigned_url.graphql '{
    "op_series_uuid": "1234abcd-1234-abcd-1234-abcd1234abcd"
}'
```

```bash
h3 gql ./external_domain_xops_csv_presigned_url.graphql '{
    "op_series_uuid": "1234abcd-1234-abcd-1234-abcd1234abcd"
}'
```

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

### InventoryExportType Example

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Example value for the InventoryExportType enum.

```json
"DOMAINS"
```

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

### ScannerFileVendor Example

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Example value for the ScannerFileVendor enum.

```text
"Qualys"
```

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

### Execution Examples for perspectives_up_next

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Command-line examples for executing the query using Python, shell scripts, and the h3-cli tool.

```bash
python h3_gql.py ./perspectives_up_next.graphql '{
    "count": 3
}'
```

```bash
./h3_gql.sh ./perspectives_up_next.graphql '{
    "count": 3
}'
```

```bash
h3 gql ./perspectives_up_next.graphql '{
    "count": 3
}'
```

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

### ScannerFileFormat Example

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Example value for the ScannerFileFormat enum.

```text
"CSV"
```

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

### Execution Examples for credentials_page

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Demonstrates how to execute the query using Python, cURL, and the h3-cli tool.

```bash
python h3_gql.py ./credentials_page.graphql '{
    "input": {
        "op_id": "1234abcd-1234-abcd-1234-abcd1234abcd"
    },
    "page_input": {
        "page_size": 10
    }
}'
```

```bash
./h3_gql.sh ./credentials_page.graphql '{
    "input": {
        "op_id": "1234abcd-1234-abcd-1234-abcd1234abcd"
    },
    "page_input": {
        "page_size": 10
    }
}'
```

```bash
h3 gql ./credentials_page.graphql '{
    "input": {
        "op_id": "1234abcd-1234-abcd-1234-abcd1234abcd"
    },
    "page_input": {
        "page_size": 10
    }
}'
```

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

### Execution Examples

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Examples showing how to execute the query using Python, cURL, and the h3-cli tool.

```bash
python h3_gql.py ./asset_groups_page.graphql '{
    "page_input": {
        "page_size": 10
    }
}'
```

```bash
./h3_gql.sh ./asset_groups_page.graphql '{
    "page_input": {
        "page_size": 10
    }
}'
```

```bash
h3 gql ./asset_groups_page.graphql '{
    "page_input": {
        "page_size": 10
    }
}'
```

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

### ScannerCategory Example

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Example value for the ScannerCategory enumeration.

```text
"CONFIRMED_EXPLOITABLE"
```

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

### ExcludedReason Example

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Example value for the ExcludedReason enumeration.

```json
"Unreachable"
```

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

### ExternalDomainXop Execution Examples

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Examples for executing the query using Python, cURL, and h3-cli.

```bash
python h3_gql.py ./external_domain_xop.graphql '{
    "uuid": "1234abcd-1234-abcd-1234-abcd1234abcd"
}'
```

```bash
./h3_gql.sh ./external_domain_xop.graphql '{
    "uuid": "1234abcd-1234-abcd-1234-abcd1234abcd"
}'
```

```bash
h3 gql ./external_domain_xop.graphql '{
    "uuid": "1234abcd-1234-abcd-1234-abcd1234abcd"
}'
```

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

### GitAccountSource Example

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Example value for the GitAccountSource enum.

```text
"GitLab"
```

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

### Execution Examples for create_op_template

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Demonstrates how to execute the mutation using Python, cURL, and the h3-cli tool.

```bash
python h3_gql.py ./create_op_template.graphql '{
    "op_template_name": "Weekly Internal Pentest",
    "schedule_op_form": {
        "op_name": "Weekly Internal Pentest",
        "op_type": "NodeZero",
        "op_param_max_scope": "10.0.0.0/8",
        "maximum_run_time": 480
    }
}'
```

```bash
./h3_gql.sh ./create_op_template.graphql '{
    "op_template_name": "Weekly Internal Pentest",
    "schedule_op_form": {
        "op_name": "Weekly Internal Pentest",
        "op_type": "NodeZero",
        "op_param_max_scope": "10.0.0.0/8",
        "maximum_run_time": 480
    }
}'
```

```bash
h3 gql ./create_op_template.graphql '{
    "op_template_name": "Weekly Internal Pentest",
    "schedule_op_form": {
        "op_name": "Weekly Internal Pentest",
        "op_type": "NodeZero",
        "op_param_max_scope": "10.0.0.0/8",
        "maximum_run_time": 480
    }
}'
```

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

### ActiveDirPasswordCSV Format Example

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Example identifier for the ActiveDirPasswordCSV format.

```text
ActiveDirPasswordCSV
```

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

### Execution Examples

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Examples showing how to execute the create_op mutation using Python, cURL, and the h3-cli.

```python
python h3_gql.py ./create_op.graphql '{
    "schedule_op_form": {
        "op_name": "Weekly Internal Pentest",
        "op_type": "NodeZero",
        "op_param_max_scope": "10.0.0.0/8",
        "maximum_run_time": 480
    }
}'
```

```bash
./h3_gql.sh ./create_op.graphql '{
    "schedule_op_form": {
        "op_name": "Weekly Internal Pentest",
        "op_type": "NodeZero",
        "op_param_max_scope": "10.0.0.0/8",
        "maximum_run_time": 480
    }
}'
```

```bash
h3 gql ./create_op.graphql '{
    "schedule_op_form": {
        "op_name": "Weekly Internal Pentest",
        "op_type": "NodeZero",
        "op_param_max_scope": "10.0.0.0/8",
        "maximum_run_time": 480
    }
}'
```

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

### ActionLogCSV Format Example

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Example identifier for the ActionLogCSV format.

```text
ActionLogCSV
```

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

### Execute install_agent via Python

Source: https://docs.horizon3.ai/api/graphql?q=

Example command to execute the mutation using the h3_gql.py helper script.

```bash
python h3_gql.py ./install_agent.graphql '{
    "name": "runner-production",
    "is_kubernetes": false
}'
```

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

### DiffStatus Value Example

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Example of a DiffStatus enum value.

```graphql
"ADDED"
```

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

### Execution Examples for bulk_authorize_ips

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Command-line examples for executing the mutation using Python, cURL, and h3-cli helpers.

```bash
python h3_gql.py ./bulk_authorize_ips.graphql '{
    "op_series_uuid": "1234abcd-1234-abcd-1234-abcd1234abcd",
    "page_input": null
}'
```

```bash
./h3_gql.sh ./bulk_authorize_ips.graphql '{
    "op_series_uuid": "1234abcd-1234-abcd-1234-abcd1234abcd",
    "page_input": null
}'
```

```bash
h3 gql ./bulk_authorize_ips.graphql '{
    "op_series_uuid": "1234abcd-1234-abcd-1234-abcd1234abcd",
    "page_input": null
}'
```

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

### SortOrder Enum Example

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Example value for the SortOrder enum.

```graphql
"ASC"
```

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

### Execution Examples for in_scope_host_tab_xops_csv_presigned_url

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Command-line examples for executing the GraphQL query using Python, cURL, and the h3-cli tool.

```bash
python h3_gql.py ./in_scope_host_tab_xops_csv_presigned_url.graphql '{
    "op_series_uuid": "1234abcd-1234-abcd-1234-abcd1234abcd"
}'
```

```bash
./h3_gql.sh ./in_scope_host_tab_xops_csv_presigned_url.graphql '{
    "op_series_uuid": "1234abcd-1234-abcd-1234-abcd1234abcd"
}'
```

```bash
h3 gql ./in_scope_host_tab_xops_csv_presigned_url.graphql '{
    "op_series_uuid": "1234abcd-1234-abcd-1234-abcd1234abcd"
}'
```

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

### Execution Examples for update_op_templates

Source: https://docs.horizon3.ai/api/graphql?q=

Examples showing how to execute the mutation using Python, cURL, and the h3-cli tool.

```python
python h3_gql.py ./update_op_templates.graphql '{
    "input": [
        {
            "uuid": "1234abcd-1234-abcd-1234-abcd1234abcd",
            "op_template_name": "Updated Internal Assessment",
            "schedule_op_form": {
                "op_name": "Weekly Internal Scan - Updated",
                "op_param_max_scope": "10.0.0.0/8,172.16.0.0/12"
            }
        },
        {
            "uuid": "5678abcd-5678-abcd-5678-abcd5678abcd",
            "op_template_name": "Updated External Test",
            "schedule_op_form": {
                "op_name": "Monthly External Test - Revised"
            }
        }
    ]
}'
```

```bash
./h3_gql.sh ./update_op_templates.graphql '{
    "input": [
        {
            "uuid": "1234abcd-1234-abcd-1234-abcd1234abcd",
            "op_template_name": "Updated Internal Assessment",
            "schedule_op_form": {
                "op_name": "Weekly Internal Scan - Updated",
                "op_param_max_scope": "10.0.0.0/8,172.16.0.0/12"
            }
        },
        {
            "uuid": "5678abcd-5678-abcd-5678-abcd5678abcd",
            "op_template_name": "Updated External Test",
            "schedule_op_form": {
                "op_name": "Monthly External Test - Revised"
            }
        }
    ]
}'
```

```bash
h3 gql ./update_op_templates.graphql '{
    "input": [
        {
            "uuid": "1234abcd-1234-abcd-1234-abcd1234abcd",
            "op_template_name": "Updated Internal Assessment",
            "schedule_op_form": {
                "op_name": "Weekly Internal Scan - Updated",
                "op_param_max_scope": "10.0.0.0/8,172.16.0.0/12"
            }
        },
        {
            "uuid": "5678abcd-5678-abcd-5678-abcd5678abcd",
            "op_template_name": "Updated External Test",
            "schedule_op_form": {
                "op_name": "Monthly External Test - Revised"
            }
        }
    ]
}'
```

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

### InventoryDomain Example Response

Source: https://docs.horizon3.ai/api/graphql?q=

Example JSON response for the InventoryDomain type.

```json
{
  "uuid": "bbbb2222-cccc-3333-dddd-eeee4444ffff",
  "domain": "app.example.com",
  "domain_type": "subdomain",
  "authorization_status": "authorized",
  "ownership_status": "owned"
}
```

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

### InventoryCidrsPage Example Response

Source: https://docs.horizon3.ai/api/graphql?q=

Example JSON response for the InventoryCidrsPage type.

```json
{
  "inventory_cidrs": [
    {
      "uuid": "dddd4444-eeee-5555-ffff-aaaa6666bbbb",
      "cidr": "192.168.1.0/24",
      "asn": "AS15169"
    }
  ],
  "page_info": {
    "total_count": 1
  }
}
```

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

### Execution Examples for Action Logs CSV Presigned URL

Source: https://docs.horizon3.ai/api/graphql?q=

Command-line examples for executing the query using Python, cURL, and the h3-cli tool.

```bash
python h3_gql.py ./action_logs_csv_presigned_url.graphql '{
    "input": {
        "op_id": "1234abcd-1234-abcd-1234-abcd1234abcd"
    }
}'
```

```bash
./h3_gql.sh ./action_logs_csv_presigned_url.graphql '{
    "input": {
        "op_id": "1234abcd-1234-abcd-1234-abcd1234abcd"
    }
}'
```

```bash
h3 gql ./action_logs_csv_presigned_url.graphql '{
    "input": {
        "op_id": "1234abcd-1234-abcd-1234-abcd1234abcd"
    }
}'
```

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

### Apply Annotations Execution Examples

Source: https://docs.horizon3.ai/api/graphql?q=

Examples showing how to execute the mutation using Python, cURL, and the h3-cli tool.

```bash
python h3_gql.py ./apply_annotations_to_rapid_response_assets.graphql '{
    "input": {
        "assets": {
            "rapid_response_uuid": "1234abcd-1234-abcd-1234-abcd1234abcd",
            "rapid_response_asset_uuids": [
                "aaaa1111-bbbb-2222-cccc-dddd3333eeee",
                "bbbb2222-cccc-3333-dddd-eeee4444ffff"
            ]
        },
        "status": "FIXED",
        "text": "Patched in maintenance window"
    }
}'
```

```bash
./h3_gql.sh ./apply_annotations_to_rapid_response_assets.graphql '{
    "input": {
        "assets": {
            "rapid_response_uuid": "1234abcd-1234-abcd-1234-abcd1234abcd",
            "rapid_response_asset_uuids": [
                "aaaa1111-bbbb-2222-cccc-dddd3333eeee",
                "bbbb2222-cccc-3333-dddd-eeee4444ffff"
            ]
        },
        "status": "FIXED",
        "text": "Patched in maintenance window"
    }
}'
```

```bash
h3 gql ./apply_annotations_to_rapid_response_assets.graphql '{
    "input": {
        "assets": {
            "rapid_response_uuid": "1234abcd-1234-abcd-1234-abcd1234abcd",
            "rapid_response_asset_uuids": [
                "aaaa1111-bbbb-2222-cccc-dddd3333eeee",
                "bbbb2222-cccc-3333-dddd-eeee4444ffff"
            ]
        },
        "status": "FIXED",
        "text": "Patched in maintenance window"
    }
}'
```

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

### InventoryCidrDeleteOutput Example Response

Source: https://docs.horizon3.ai/api/graphql?q=

Example JSON response for the InventoryCidrDeleteOutput type.

```json
{
  "deleted_count": 1,
  "deleted_inventory_cidrs": ["dddd4444-eeee-5555-ffff-aaaa6666bbbb"]
}
```

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

### DataStore Response Example

Source: https://docs.horizon3.ai/api/graphql

Example JSON response for the data_store query.

```json
{
  "data": {
    "data_store": {
      "uuid": "1234abcd-1234-abcd-1234-abcd1234abcd",
      "data_store_type": "FileShare",
      "created_at": "2024-03-15T14:23:45Z",
      "name": "ADMIN$",
      "title": "File Share ADMIN$ on 192.168.1.100 Port 445",
      "ip": "192.168.1.100",
      "port": 445,
      "host_name": "DC01.contoso.local",
      "service_type": "SMB",
      "address": "192.168.1.100",
      "data_resources_count": 1847,
      "data_resources_label": "FILES",
      "sensitive_resources_count": 23,
      "is_authenticated": true,
      "permissions_list": ["read", "list"],
      "score": 7.8,
      "severity": "HIGH",
      "op_id": "1234abcd-1234-abcd-1234-abcd1234abcd",
      "portal_url": "https://portal.yourorg.com/data-stores/1234abcd-1234-abcd-1234-abcd1234abcd"
    }
  }
}
```

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

### Execution Examples for agents_facets

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Command-line examples for executing the query using Python, cURL, and h3-cli.

```bash
python h3_gql.py ./agents_facets.graphql '{
    "include_sub_clients": false
}'
```

```bash
./h3_gql.sh ./agents_facets.graphql '{
    "include_sub_clients": false
}'
```

```bash
h3 gql ./agents_facets.graphql '{
    "include_sub_clients": false
}'
```

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

### Run NodeZero ServiceNow VR Setup Script

Source: https://docs.horizon3.ai/portal/settings/integrations/servicenow-vr?q=

Executes the idempotent setup script in the ServiceNow Background Scripts console to configure integration components. Ensure the scope is set to Global before running.

```javascript
/**
* NodeZero ServiceNow VR Integration — setup script (v2.1.0)
*
* Run from: System Definition → Scripts - Background (scope: Global).
* Idempotent — safe to re-run. Prints a summary at the end.
*
* Creates: dedicated `sn_vul.nodezero_integration` role (inherits
* `sn_vul.vulnerability_admin`), integration definition + instance,
* 6 ACLs + role grants (minimal validated set),
* 5 severity map rows, 3 business rules
* (CI match trigger via CILookupUtil + DI→VI cascades).
*
* Does NOT create: service account (credentials) or CI Lookup Rules
* (customer-designed against their CMDB). See Customer Setup Guide.
*
* Kept ES5-compatible (no template literals / arrow functions / let-const)
* so it runs on older SNOW Background Script engines without ES2021 mode.
*/
(function () {
    var VERSION = '2.1.0';
    var INTEGRATION_NAME = 'NodeZero';
    var INTEGRATION_ID = 'com.horizon3.nodezero';           // stable programmatic key for the integration definition
    var ROLE_NAME_BASE = 'sn_vul.vulnerability_admin';      // OOTB role we inherit from
    var ROLE_NAME_NZ = 'sn_vul.nodezero_integration';       // dedicated role granted to the integration service account

    var stats = { created: 0, skipped: 0, updated: 0, errors: 0 };
    var log = function (m) { gs.print('[NZ setup] ' + m); };
    var warn = function (m) { gs.warn('[NZ setup] ' + m); stats.errors++; };

    log('NodeZero setup script v' + VERSION + ' — starting');

    // ------------------------------------------------------------------ helpers

    function lookupSysId(table, field, value) {
        var gr = new GlideRecord(table);
        gr.addQuery(field, value);
        gr.setLimit(1);
        gr.query();
        return gr.next() ? gr.getUniqueValue() : null;
    }

    // lookup: string (addEncodedQuery) OR object {field: value} (addQuery per key).
    // Use object form when any value contains '^' (SNOW's AND separator).
    function upsert(table, lookup, fields, label) {
        try {
            var gr = new GlideRecord(table);
            if (typeof lookup === 'string') gr.addEncodedQuery(lookup);
            else for (var lk in lookup) gr.addQuery(lk, lookup[lk]);
            gr.setLimit(1);
            gr.query();
            if (gr.next()) {
                var changed = false;
                for (var k in fields) {
                    var cur = String(gr.getValue(k) || '');
                    var des = fields[k] === true ? '1'
                            : fields[k] === false ? '0'
                            : String(fields[k]);
                    if (cur !== des) { gr.setValue(k, fields[k]); changed = true; }
                }
                if (changed) {
                    gr.update(); stats.updated++;
                    log('UPDATED ' + label + ' (' + gr.sys_id + ')');
                } else {
                    stats.skipped++;
                    log('SKIPPED ' + label + ' — already matches (' + gr.sys_id + ')');
                }
                return gr.getUniqueValue();
            }
            var ins = new GlideRecord(table);
            ins.initialize();
            for (var f in fields) ins.setValue(f, fields[f]);
            var sysId = ins.insert();
            if (sysId) { stats.created++; log('CREATED ' + label + ' (' + sysId + ')'); return sysId; }
            warn('Insert returned no sys_id for ' + label); return null;
        } catch (e) { warn('Error on ' + label + ': ' + e); return null; }
    }
```

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

### DataStoresCount Response Example

Source: https://docs.horizon3.ai/api/graphql

Example JSON response for the data_stores_count query.

```json
{
  "data": {
    "data_stores_count": 23
  }
}
```

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

### Execution Examples for add_domains_to_asset_group

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Command-line examples for executing the mutation using Python, cURL, and h3-cli helpers.

```bash
python h3_gql.py ./add_domains_to_asset_group.graphql '{
    "asset_group_uuid": "1234abcd-1234-abcd-1234-abcd1234abcd",
    "domains": [
        "newdomain.acme.com",
        "extra.acme.io"
    ]
}'
```

```bash
./h3_gql.sh ./add_domains_to_asset_group.graphql '{
    "asset_group_uuid": "1234abcd-1234-abcd-1234-abcd1234abcd",
    "domains": [
        "newdomain.acme.com",
        "extra.acme.io"
    ]
}'
```

```bash
h3 gql ./add_domains_to_asset_group.graphql '{
    "asset_group_uuid": "1234abcd-1234-abcd-1234-abcd1234abcd",
    "domains": [
        "newdomain.acme.com",
        "extra.acme.io"
    ]
}'
```

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

### HostTabXopsCount Response Example

Source: https://docs.horizon3.ai/api/graphql

Example JSON response for the host_tab_xops_count query.

```json
{
  "data": {
    "host_tab_xops_count": 42
  }
}
```

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

### Execution Examples

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Command-line examples for executing the GraphQL query using Python, cURL, and h3-cli helpers.

```bash
python h3_gql.py ./operators_page.graphql '{
    "page_input": {
        "page_num": 1,
        "page_size": 10
    },
    "include_sub_clients": false
}'
```

```bash
./h3_gql.sh ./operators_page.graphql '{
    "page_input": {
        "page_num": 1,
        "page_size": 10
    },
    "include_sub_clients": false
}'
```

```bash
h3 gql ./operators_page.graphql '{
    "page_input": {
        "page_num": 1,
        "page_size": 10
    },
    "include_sub_clients": false
}'
```

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

### OpTemplate Response Example

Source: https://docs.horizon3.ai/api/graphql

Example JSON response for the op_template query.

```json
{
  "data": {
    "op_template": {
      "uuid": "1234abcd-1234-abcd-1234-abcd1234abcd",
      "op_template_name": "Weekly Internal Pentest",
      "name": "Weekly Internal Pentest",
      "op_type": "NodeZero",
      "user_account_uuid": "a1b2c3d4-a1b2-c3d4-a1b2-c3d4a1b2c3d4",
      "client_account_uuid": "b2c3d4e5-b2c3-d4e5-b2c3-d4e5b2c3d4e5",
      "row_created_at": "2024-01-15T10:30:00.000000",
      "row_updated_at": "2024-01-20T14:45:00.000000",
      "schedule_op_form": {
        "op_name": "Weekly Internal Pentest",
        "op_type": "NodeZero",
        "op_param_max_scope": "10.0.0.0/8",
        "maximum_run_time": 480
      }
    }
  }
}
```

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

### CreateOperatorOutput Example Response

Source: https://docs.horizon3.ai/api/graphql?q=

Example JSON response for a CreateOperatorOutput query.

```json
{
  "command": "helm install nodezero-operator-prod horizon3/nodezero-operator --namespace nodezero --create-namespace --set apiKey=h3_api_sk_xyz789 --set operatorName=nodezero-operator-prod",
  "operator": {
    "uuid": "3456cdef-3456-cdef-3456-cdef3456cdef",
    "name": "nodezero-operator-prod",
    "version": "2.1.0",
    "chart_version": "1.5.2",
    "is_registered": true
  }
}
```

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

### Install and configure h3-cli

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Set the API key and download URL to install the CLI, then add it to your system path.

```bash
H3_API_KEY="<your-api-key-here>"
H3_DOWNLOAD_URL="https://downloads.horizon3ai.com/utilities/cli/easy_install.sh"

curl $H3_DOWNLOAD_URL | bash -s "$H3_API_KEY"

export H3_CLI_HOME="`pwd`/h3-cli"
export PATH="$H3_CLI_HOME/bin:$PATH"

# Commands
h3 help
h3 whoami
h3 pentests
```

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

### AgentsPage Example Response

Source: https://docs.horizon3.ai/api/graphql?q=

Example JSON response for an AgentsPage query.

```json
{
  "agents": [
    {
      "uuid": "1234abcd-1234-abcd-1234-abcd1234abcd",
      "name": "runner-production",
      "user_account_name": "admin@example.com",
      "created_at": "2024-01-15T10:30:00Z",
      "is_kubernetes": false
    },
    {
      "uuid": "2345bcde-2345-bcde-2345-bcde2345bcde",
      "name": "runner-staging",
      "user_account_name": "devops@example.com",
      "created_at": "2024-01-14T09:15:00Z",
      "is_kubernetes": true
    }
  ],
  "page_info": {
    "page_num": 1,
    "page_size": 10
  }
}
```

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

### Execution Examples for create_scheduled_action

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Demonstrates how to execute the mutation using Python, cURL, and the h3-cli tool.

```python
python h3_gql.py ./create_scheduled_action.graphql '{
    "input": {
        "schedule_name": "Weekly Infrastructure Scan",
        "action": "run-pentest",
        "cron_expression": "0 2 * * MON",
        "op_template_uuid": "9999aaaa-9999-aaaa-9999-aaaa9999aaaa"
    }
}'
```

```bash
./h3_gql.sh ./create_scheduled_action.graphql '{
    "input": {
        "schedule_name": "Weekly Infrastructure Scan",
        "action": "run-pentest",
        "cron_expression": "0 2 * * MON",
        "op_template_uuid": "9999aaaa-9999-aaaa-9999-aaaa9999aaaa"
    }
}'
```

```bash
h3 gql ./create_scheduled_action.graphql '{
    "input": {
        "schedule_name": "Weekly Infrastructure Scan",
        "action": "run-pentest",
        "cron_expression": "0 2 * * MON",
        "op_template_uuid": "9999aaaa-9999-aaaa-9999-aaaa9999aaaa"
    }
}'
```

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

### Credential Response Example

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Example JSON response for the credential query.

```json
{
  "data": {
    "credential": {
      "uuid": "abcd1234-abcd-1234-abcd-1234abcd1234",
      "created_at": "2024-01-15T09:15:33Z",
      "cred_type": "STANDARD",
      "user_name": "jsmith",
      "ip": "10.0.1.25",
      "product": "Windows",
      "cleartext": "P***d",
      "hash": null,
      "has_proof": true,
      "is_validated": true,
      "role": "LOCAL_ADMIN",
      "role_name": "Local Admin",
      "score": 7.5,
      "severity": "HIGH",
      "weaknesses_count": 3,
      "attack_paths_count": 5,
      "display_name": "jsmith@10.0.1.25",
      "portal_url": "https://portal.yourorg.com/credentials/abcd1234-abcd-1234-abcd-1234abcd1234"
    }
  }
}
```

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

### Authorize IPs Execution Examples

Source: https://docs.horizon3.ai/api/graphql?h=schedule

Execution examples using Python, cURL, and h3-cli helpers.

```bash
python h3_gql.py ./authorize_ips.graphql '{
    "host_tab_xop_uuids": [
        "1234abcd-1234-abcd-1234-abcd1234abcd/203.0.113.10",
        "1234abcd-1234-abcd-1234-abcd1234abcd/198.51.100.5"
    ]
}'
```

```bash
./h3_gql.sh ./authorize_ips.graphql '{
    "host_tab_xop_uuids": [
        "1234abcd-1234-abcd-1234-abcd1234abcd/203.0.113.10",
        "1234abcd-1234-abcd-1234-abcd1234abcd/198.51.100.5"
    ]
}'
```

```bash
h3 gql ./authorize_ips.graphql '{
    "host_tab_xop_uuids": [
        "1234abcd-1234-abcd-1234-abcd1234abcd/203.0.113.10",
        "1234abcd-1234-abcd-1234-abcd1234abcd/198.51.100.5"
    ]
}'
```
Tokens:
Raw