Synapse

https://synapse.docs.vertex.link/en/latest/
Admin
Synapse is an open-source platform for collaborative intelligence and threat analysis that provides...
Tokens:1,818,708
Snippets:7,531
Trust Score:7.2
Update:1 year ago
Show doc for...
Tokens:
Raw
### Synapse User Guide - Getting Started

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/storm_ref_model_introspect

A quick start guide for new users to begin using Synapse, including setup and basic operations.

```APIDOC
Synapse User Guide - Getting Started:
  Guides users through the initial steps of setting up and using Synapse.
  Covers installation, configuration, and basic data interaction procedures.
```

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

### Synapse Introduction and Getting Started

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_180_0

Provides an overview of Synapse and guides users through the initial setup and getting started process.

```en
Introduction: https://synapse.docs.vertex.link/en/latest/synapse/intro.html
Getting Started: https://synapse.docs.vertex.link/en/latest/synapse/quickstart.html
```

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

### Synapse Vertex Link Introduction and Getting Started

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_211_0

Provides an overview of Synapse Vertex Link and guides users through the initial setup and getting started process.

```markdown
[Synapse](https://synapse.docs.vertex.link/en/latest/index.html)

Contents:
  * [Introduction](https://synapse.docs.vertex.link/en/latest/synapse/intro.html)
  * [Getting Started](https://synapse.docs.vertex.link/en/latest/synapse/quickstart.html)
```

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

### Synapse Vertex Link Introduction and Getting Started

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_204_0

Provides an overview of Synapse Vertex Link and guides users through the initial setup and getting started process.

```en
Introduction: https://synapse.docs.vertex.link/en/latest/synapse/intro.html
Getting Started: https://synapse.docs.vertex.link/en/latest/synapse/quickstart.html
```

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

### Synapse Vertex Link Introduction and Getting Started

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_203_0

Provides an overview of Synapse Vertex Link and guides users through the initial setup and getting started process.

```en
Introduction: https://synapse.docs.vertex.link/en/latest/synapse/intro.html
Getting Started: https://synapse.docs.vertex.link/en/latest/synapse/quickstart.html
```

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

### Synapse Vertex Link Getting Started

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_197_0

This section guides users through the initial setup and quick start procedures for Synapse Vertex Link.

```APIDOC
Getting Started:
  - Quickstart: Step-by-step instructions to get Synapse Vertex Link up and running quickly.
```

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

### Synapse Vertex Link Introduction and Getting Started

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_188_0

Provides an overview of Synapse Vertex Link and guides users through the initial setup and getting started process.

```en
Introduction: https://synapse.docs.vertex.link/en/latest/synapse/intro.html
Getting Started: https://synapse.docs.vertex.link/en/latest/synapse/quickstart.html
```

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

### Synapse Vertex Link - Introduction and Getting Started

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_186_0

Provides an overview of Synapse Vertex Link and guides users through the initial setup and getting started process.

```en
Introduction: https://synapse.docs.vertex.link/en/latest/synapse/intro.html
Getting Started: https://synapse.docs.vertex.link/en/latest/synapse/quickstart.html
```

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

### Synapse Vertex Link - Introduction and Getting Started

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_187_0

Provides an overview of Synapse Vertex Link and guides users through the initial setup and quick start process.

```en
Introduction: https://synapse.docs.vertex.link/en/latest/synapse/intro.html
Getting Started: https://synapse.docs.vertex.link/en/latest/synapse/quickstart.html
```

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

### Synapse Vertex Link - Introduction and Getting Started

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_191_0

Provides an overview of Synapse Vertex Link and guides users through the initial setup and quick start process.

```en
Introduction: https://synapse.docs.vertex.link/en/latest/synapse/intro.html
Getting Started: https://synapse.docs.vertex.link/en/latest/synapse/quickstart.html
```

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

### Synapse Vertex Link - Introduction and Getting Started

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_179_0

Provides an overview of Synapse Vertex Link and guides users through the initial setup and quick start procedures.

```en
Introduction: https://synapse.docs.vertex.link/en/latest/synapse/intro.html
Getting Started: https://synapse.docs.vertex.link/en/latest/synapse/quickstart.html
```

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

### Synapse Vertex Link Introduction and Getting Started

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_198_0

This section covers the introduction to Synapse Vertex Link and guides users through the initial setup and getting started process.

```APIDOC
Core Documentation:
  - Introduction: An overview of Synapse Vertex Link and its purpose.
  - Getting Started: Step-by-step instructions for setting up and beginning to use Synapse Vertex Link.
```

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

### Synapse Vertex Link - Introduction and Getting Started

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_196_0

Provides an overview of Synapse Vertex Link and guides users through the initial setup and quick start process.

```en
Introduction: https://synapse.docs.vertex.link/en/latest/synapse/intro.html
Getting Started: https://synapse.docs.vertex.link/en/latest/synapse/quickstart.html
```

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

### Synapse Vertex Link - Introduction and Getting Started

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_184_0

Provides an overview of Synapse Vertex Link and guides users through the initial setup and quick start process.

```en
Introduction: https://synapse.docs.vertex.link/en/latest/synapse/intro.html
Getting Started: https://synapse.docs.vertex.link/en/latest/synapse/quickstart.html
```

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

### Synapse Vertex Link - Introduction and Getting Started

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_193_0

Provides an overview of Synapse Vertex Link and guides users through the initial setup and quick start process.

```en
Introduction: https://synapse.docs.vertex.link/en/latest/synapse/intro.html
Getting Started: https://synapse.docs.vertex.link/en/latest/synapse/quickstart.html
```

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

### Synapse DevOps Guide - Adding Users

Source: https://synapse.docs.vertex.link/en/latest/synapse/devopsguide

Steps for adding new users to the Synapse system. This includes information on user creation and initial setup.

```en
This includes information on user creation and initial setup.
```

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

### Synapse Admin and Deployment Guides

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_191_0

Provides links to essential guides for managing and deploying Synapse Vertex Link. The Admin Guide covers operational aspects, while the Deployment Guide details the setup process.

```en
* [Synapse Admin Guide](https://synapse.docs.vertex.link/en/latest/synapse/adminguide.html)
* [Synapse Deployment Guide](https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide.html)
```

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

### Synapse User Guide - Core Sections

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_185_0

Overview of the Synapse user guide, covering introduction, getting started, background information, data and analytical models, views, layers, and tools.

```APIDOC
SynapseUserGuide:
  description: Comprehensive guide to using the Synapse platform.
  sections:
    - title: Introduction
      url: https://synapse.docs.vertex.link/en/latest/synapse/intro.html
    - title: Getting Started
      url: https://synapse.docs.vertex.link/en/latest/synapse/quickstart.html
    - title: User Guide Overview
      url: https://synapse.docs.vertex.link/en/latest/synapse/userguide.html
    - title: Background
      url: https://synapse.docs.vertex.link/en/latest/synapse/userguides/background.html
    - title: Data Model
      url: https://synapse.docs.vertex.link/en/latest/synapse/userguides/data_model.html
    - title: Analytical Model
      url: https://synapse.docs.vertex.link/en/latest/synapse/userguides/analytical_model.html
    - title: Views and Layers
      url: https://synapse.docs.vertex.link/en/latest/synapse/userguides/views_layers.html
    - title: Tools
      url: https://synapse.docs.vertex.link/en/latest/synapse/userguides/index_tools.html
    - title: Storm Reference
      url: https://synapse.docs.vertex.link/en/latest/synapse/userguides/index_storm_ref.html
    - title: Storm Advanced
      url: https://synapse.docs.vertex.link/en/latest/synapse/userguides/index_storm_adv.html

```

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

### Synapse Project Navigation

Source: https://synapse.docs.vertex.link/en/latest/synapse/glossary

Provides links to various sections of the Synapse documentation, including introduction, getting started, user guides, admin guides, deployment, devops, and developer guides. Also includes a glossary of terms.

```markdown
[Synapse](https://synapse.docs.vertex.link/en/latest/index.html)

Contents:
  * [Introduction](https://synapse.docs.vertex.link/en/latest/synapse/intro.html)
  * [Getting Started](https://synapse.docs.vertex.link/en/latest/synapse/quickstart.html)
  * [Synapse User Guide](https://synapse.docs.vertex.link/en/latest/synapse/userguide.html)
  * [Synapse Admin Guide](https://synapse.docs.vertex.link/en/latest/synapse/adminguide.html)
  * [Synapse Deployment Guide](https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide.html)
  * [Synapse Devops Guide](https://synapse.docs.vertex.link/en/latest/synapse/devopsguide.html)
  * [Synapse Developer Guide](https://synapse.docs.vertex.link/en/latest/synapse/devguide.html)
  * [](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html)
    * [](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#a)
      * [Addition, Automatic](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#addition-automatic)
      * [Addition, Dependent](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#addition-dependent)
      * [Advanced Power-Up](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#advanced-power-up)
      * [Admin Tool](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#admin-tool)
      * [Analytical Model](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#analytical-model)
      * [Auth Gate](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#auth-gate)
      * [Autoadd](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#autoadd)
      * [Axon](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#axon)
    * [](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#b)
      * [Base Tag](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#base-tag)
      * [Binary Unique Identifier](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#binary-unique-identifier)
      * [BUID](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#buid)
    * [](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#c)
      * [Callable Function](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#callable-function)
      * [Cell](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#cell)
      * [Column, Embed](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#column-embed)
      * [Column, Path Variable](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#column-path-variable)
      * [Column, Property](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#column-property)
      * [Column, Tag](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#column-tag)
      * [Column, Tag Glob](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#column-tag-glob)
      * [Comparator](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#comparator)
      * [Comparison Operator](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#comparison-operator)
      * [Comparison Operator, Standard](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#comparison-operator-standard)
      * [Comparison Operator, Extended](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#comparison-operator-extended)
      * [Composite Form](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#composite-form)
      * [Console Tool](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#console-tool)
      * [Constant](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#constant)
      * [Constructor](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#constructor)
      * [Cortex](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#cortex)
      * [Cron](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#cron)
      * [Ctor](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#ctor)
    * [](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#d)
      * [Daemon](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#daemon)
      * [Data Emitter Function](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#data-emitter-function)
      * [Data Model](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#data-model)
      * [Data Model Explorer](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#data-model-explorer)
      * [Deconflictable](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#deconflictable)
      * [Depadd](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#depadd)
      * [Derived Property](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#derived-property)
      * [Directed Edge](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html#directed-edge)
```

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

### Synapse Project Documentation Overview

Source: https://synapse.docs.vertex.link/en/latest/synapse/autodocs/synapse.lib

This entry provides a high-level overview of the Synapse project documentation structure. It links to various guides such as Introduction, Getting Started, User Guide, Admin Guide, Deployment Guide, Devops Guide, Developer Guide, Glossary, and Contributor Guide.

```APIDOC
Project: Synapse Vertex Link

Documentation Sections:
- Introduction: https://synapse.docs.vertex.link/en/latest/synapse/intro.html
- Getting Started: https://synapse.docs.vertex.link/en/latest/synapse/quickstart.html
- Synapse User Guide: https://synapse.docs.vertex.link/en/latest/synapse/userguide.html
- Synapse Admin Guide: https://synapse.docs.vertex.link/en/latest/synapse/adminguide.html
- Synapse Deployment Guide: https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide.html
- Synapse Devops Guide: https://synapse.docs.vertex.link/en/latest/synapse/devopsguide.html
- Synapse Developer Guide: https://synapse.docs.vertex.link/en/latest/synapse/devguide.html
- Synapse Glossary: https://synapse.docs.vertex.link/en/latest/synapse/glossary.html
- Synapse Contributors Guide: https://synapse.docs.vertex.link/en/latest/synapse/contributing.html
```

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

### Synapse User Guide - Introduction

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/storm_ref_model_introspect

An introductory overview of Synapse, its purpose, and key features for new users.

```APIDOC
Synapse User Guide - Introduction:
  Provides a high-level overview of the Synapse platform.
  Explains the core concepts and benefits of using Synapse for data management and analysis.
```

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

### pushfile Command Example

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/syn_tools_pushfile

An example demonstrating how to upload a single file, create a file:bytes node in a Cortex, and apply a tag.

```shell
pushfile axon://my.axon.com/store/myaxon cortex://my.cortex.com/mycortex -t sometag myreport.pdf
```

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

### Fix Quickstart Documentation Permissions Issue

Source: https://synapse.docs.vertex.link/en/latest/synapse/changelog

Addresses an issue in the quickstart documentation concerning permissions. This correction ensures the initial setup guide is accurate and helpful for new users.

```markdown
quickstart documentation
```

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

### Synapse Guides

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_173_1

Links to various guides for Synapse, including administration, deployment, DevOps, development, and contributor guidelines.

```markdown
* [Synapse Admin Guide](https://synapse.docs.vertex.link/en/latest/synapse/adminguide.html)
* [Synapse Deployment Guide](https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide.html)
* [Synapse Devops Guide](https://synapse.docs.vertex.link/en/latest/synapse/devopsguide.html)
* [Synapse Developer Guide](https://synapse.docs.vertex.link/en/latest/synapse/devguide.html)
* [Synapse Glossary](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html)
* [Synapse Contributors Guide](https://synapse.docs.vertex.link/en/latest/synapse/contributing.html)
```

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

### Synapse General Guides

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_214_0

Links to essential guides for Synapse, including administration, deployment, DevOps, development, a glossary of terms, and contributor guidelines.

```markdown
* [Synapse Admin Guide](https://synapse.docs.vertex.link/en/latest/synapse/adminguide.html)
* [Synapse Deployment Guide](https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide.html)
* [Synapse Devops Guide](https://synapse.docs.vertex.link/en/latest/synapse/devopsguide.html)
* [Synapse Developer Guide](https://synapse.docs.vertex.link/en/latest/synapse/devguide.html)
* [Synapse Glossary](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html)
* [Synapse Contributors Guide](https://synapse.docs.vertex.link/en/latest/synapse/contributing.html)
```

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

### Synapse Vertex Link Navigation

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_172_0

Provides links to the main sections of the Synapse Vertex Link documentation, including introduction and getting started guides.

```APIDOC
DocumentationNavigation:
  main_page: https://synapse.docs.vertex.link/en/latest/index.html
  sections:
    - title: Introduction
      link: https://synapse.docs.vertex.link/en/latest/synapse/intro.html
    - title: Getting Started
      link: https://synapse.docs.vertex.link/en/latest/synapse/quickstart.html
```

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

### Synapse Vertex Link Navigation

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_165_0

Provides links to the main sections of the Synapse Vertex Link documentation, including introduction and getting started guides.

```APIDOC
DocumentationNavigation:
  main_page: https://synapse.docs.vertex.link/en/latest/index.html
  sections:
    - title: Introduction
      link: https://synapse.docs.vertex.link/en/latest/synapse/intro.html
    - title: Getting Started
      link: https://synapse.docs.vertex.link/en/latest/synapse/quickstart.html
```

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

### Synapse General Guides

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_215_0

Links to essential guides for Synapse, including administration, deployment, DevOps, development, a glossary of terms, and contributor guidelines.

```markdown
* [Synapse Admin Guide](https://synapse.docs.vertex.link/en/latest/synapse/adminguide.html)
* [Synapse Deployment Guide](https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide.html)
* [Synapse Devops Guide](https://synapse.docs.vertex.link/en/latest/synapse/devopsguide.html)
* [Synapse Developer Guide](https://synapse.docs.vertex.link/en/latest/synapse/devguide.html)
* [Synapse Glossary](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html)
* [Synapse Contributors Guide](https://synapse.docs.vertex.link/en/latest/synapse/contributing.html)
```

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

### Synapse Guides

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_141_0

This section provides links to various guides for Synapse, including administration, deployment, development, and a glossary of terms. These guides are essential for understanding and utilizing the Synapse platform effectively.

```markdown
* [Synapse Admin Guide](https://synapse.docs.vertex.link/en/latest/synapse/adminguide.html)
* [Synapse Deployment Guide](https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide.html)
* [Synapse Devops Guide](https://synapse.docs.vertex.link/en/latest/synapse/devopsguide.html)
* [Synapse Developer Guide](https://synapse.docs.vertex.link/en/latest/synapse/devguide.html)
* [Synapse Glossary](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html)
* [Synapse Contributors Guide](https://synapse.docs.vertex.link/en/latest/synapse/contributing.html)
```

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

### Synapse Vertex Link Navigation

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_170_0

Provides links to the main sections of the Synapse Vertex Link documentation, including introduction and getting started guides.

```APIDOC
DocumentationNavigation:
  main_page: https://synapse.docs.vertex.link/en/latest/index.html
  sections:
    - title: Introduction
      link: https://synapse.docs.vertex.link/en/latest/synapse/intro.html
    - title: Getting Started
      link: https://synapse.docs.vertex.link/en/latest/synapse/quickstart.html
```

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

### Synapse Vertex Link Navigation

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_160_0

Provides links to the main sections of the Synapse Vertex Link documentation, including introduction and getting started guides.

```APIDOC
DocumentationNavigation:
  main_page: https://synapse.docs.vertex.link/en/latest/index.html
  sections:
    - title: Introduction
      link: https://synapse.docs.vertex.link/en/latest/synapse/intro.html
    - title: Getting Started
      link: https://synapse.docs.vertex.link/en/latest/synapse/quickstart.html
```

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

### Storm Command Help Output Example

Source: https://synapse.docs.vertex.link/en/latest/synapse/devguides/power-ups

Demonstrates the help output for a Storm command, showing its description, usage, options, and arguments.

```APIDOC
storm> acme.hello.omgopts --help

This is a multi-line description containing usage examples.

// Run the command with some nodes
inet:fqdn=acme.newp | acme.hello.omgopts vertex.link

// Run the command with some command line switches
acme.hello.omgopts --debug --hehe haha vertex.link


Usage: acme.hello.omgopts [options] <fqdn>

Options:

  --help                      : Display the command usage.
  --hehe <hehe>               : The value of the hehe optional input.
  --debug                     : Enable debug output.

Arguments:

  <fqdn>                      : A mandatory / positional command line argument.
complete. 0 nodes in 6 ms (0/sec).

```

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

### Synapse Vertex Link Core Documentation

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_215_0

This section provides the core documentation for Synapse Vertex Link, including an introduction to the platform and a guide to getting started with its features.

```APIDOC
Core Documentation:
  - Introduction: An overview of Synapse Vertex Link and its purpose.
  - Getting Started: A quick start guide to help users begin using Synapse.
```

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

### Synapse Demo Instance Features

Source: https://synapse.docs.vertex.link/en/latest/synapse/quickstart

Describes the Synapse demo instance, highlighting its cloud-hosted nature, ease of use with no deployment required, and access to both open-source and commercial Rapid Power-Ups. It also mentions automatic updates and pre-loaded sample data.

```en
Demo instances provide access to all of Synapse’s Rapid Power-Ups, both open-source and commercial.
Demo instances are updated automatically each week with any new releases of Synapse and Optic.
Demo instances are pre-loaded with sample data and tags (just under 300,000 objects).

A demo instance is best for:
  * Users who want to test all of Synapse’s features and capabilities, including those only available with Synapse Enterprise.
  * Supporting multiple users and / or networked users, including the (optional) ability to configure roles and permissions.
  * Simple deployment - no hardware/software needed (other than a web browser).
  * Developers who want insight into developing Power-Ups or Workflows.
  * Users and developers who want access to the “latest and greatest” releases and features during testing.
  * Users who want to take advantage of all of Synapse’s features (including built-in Help for Synapse’s data model, Storm auto-complete, etc.) while learning - even if you ultimately deploy an open-source version.
```

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

### Synapse Vertex Link Navigation

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_214_0

This section outlines the primary navigation paths within the Synapse Vertex Link documentation, including the introduction and getting started guides.

```APIDOC
Navigation:
  - Introduction: An overview of Synapse Vertex Link.
  - Getting Started: Quick start guide for setting up and using Synapse.
```

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

### Synapse Guides

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_160_0

Provides links to various guides for Synapse, including administration, deployment, DevOps, and developer resources, as well as a glossary and contributor guidelines.

```markdown
* [Synapse Admin Guide](https://synapse.docs.vertex.link/en/latest/synapse/adminguide.html)
* [Synapse Deployment Guide](https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide.html)
* [Synapse Devops Guide](https://synapse.docs.vertex.link/en/latest/synapse/devopsguide.html)
* [Synapse Developer Guide](https://synapse.docs.vertex.link/en/latest/synapse/devguide.html)
* [Synapse Glossary](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html)
* [Synapse Contributors Guide](https://synapse.docs.vertex.link/en/latest/synapse/contributing.html)
```

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

### Synapse Vertex Link Navigation

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_189_0

This section outlines the primary navigation paths within the Synapse Vertex Link documentation. It includes links to the introduction, getting started guide, and various user guides covering data models, analytical models, views, layers, tools, and Storm references.

```APIDOC
Synapse Vertex Link Documentation:
  - Introduction: https://synapse.docs.vertex.link/en/latest/synapse/intro.html
  - Getting Started: https://synapse.docs.vertex.link/en/latest/synapse/quickstart.html
  - User Guides:
    - Background: https://synapse.docs.vertex.link/en/latest/synapse/userguides/background.html
    - Data Model: https://synapse.docs.vertex.link/en/latest/synapse/userguides/data_model.html
    - Analytical Model: https://synapse.docs.vertex.link/en/latest/synapse/userguides/analytical_model.html
    - Views and Layers: https://synapse.docs.vertex.link/en/latest/synapse/userguides/views_layers.html
    - Tools: https://synapse.docs.vertex.link/en/latest/synapse/userguides/index_tools.html
    - Storm Reference: https://synapse.docs.vertex.link/en/latest/synapse/userguides/index_storm_ref.html
    - Storm Advanced: https://synapse.docs.vertex.link/en/latest/synapse/userguides/index_storm_adv.html
```

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

### Synapse Guides

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_205_0

Provides links to essential guides for Synapse, including administration, deployment, development, and a glossary.

```en
* [Synapse Admin Guide](https://synapse.docs.vertex.link/en/latest/synapse/adminguide.html)
* [Synapse Deployment Guide](https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide.html)
* [Synapse Devops Guide](https://synapse.docs.vertex.link/en/latest/synapse/devopsguide.html)
* [Synapse Developer Guide](https://synapse.docs.vertex.link/en/latest/synapse/devguide.html)
* [Synapse Glossary](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html)
```

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

### Synapse Guides

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_156_0

Provides links to various guides for Synapse, including administration, deployment, DevOps, development, and contributor guidelines.

```en
Synapse Admin Guide: https://synapse.docs.vertex.link/en/latest/synapse/adminguide.html
Synapse Deployment Guide: https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide.html
Synapse Devops Guide: https://synapse.docs.vertex.link/en/latest/synapse/devopsguide.html
Synapse Developer Guide: https://synapse.docs.vertex.link/en/latest/synapse/devguide.html
Synapse Glossary: https://synapse.docs.vertex.link/en/latest/synapse/glossary.html
Synapse Contributors Guide: https://synapse.docs.vertex.link/en/latest/synapse/contributing.html
```

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

### Synapse Quickstart Installation

Source: https://synapse.docs.vertex.link/en/latest/synapse/quickstart

Instructions for downloading and installing the Synapse Quickstart Docker container, which includes Synapse and the Storm CLI. This is suitable for individual users, testing, and learning the Storm query language.

```bash
Download and install Synapse Quickstart from the Github repository:
https://github.com/vertexproject/synapse-quickstart
```

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

### Synapse Guides

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_216_0

Provides links to various guides for Synapse, including administration, deployment, DevOps, development, and glossary.

```markdown
* [Synapse Admin Guide](https://synapse.docs.vertex.link/en/latest/synapse/adminguide.html)
* [Synapse Deployment Guide](https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide.html)
* [Synapse Devops Guide](https://synapse.docs.vertex.link/en/latest/synapse/devopsguide.html)
* [Synapse Developer Guide](https://synapse.docs.vertex.link/en/latest/synapse/devguide.html)
* [Synapse Glossary](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html)
* [Synapse Contributors Guide](https://synapse.docs.vertex.link/en/latest/synapse/contributing.html)
```

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

### Get GUID Node by Norms

Source: https://synapse.docs.vertex.link/en/latest/_modules/synapse/lib/snap

Retrieves a GUID node using normalized property information. It handles nested GUIDs and checks for exact matches based on deconf strategy.

```python
async def _getGuidNodeByNorms(self, form, norms):

        proplist = []
        for name, info in norms.items():
            if info[0].isform:
                if (node := await self._getGuidNodeByNorms(*info[:2])) is None:
                    return
                valu = node.ndef[1]
                norms[name] = (form.prop(name), valu, {})
                proplist.append((name, valu))
            else:
                proplist.append((name, info[1]))

        # check first for an exact match via our same deconf strategy
        proplist.sort()

        node = await self.getNodeByNdef((form.full, s_common.guid(proplist)))
        if node is not None:

            # ensure we still match the property deconf criteria

```

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

### Synapse Guides

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_152_0

Provides links to various guides for Synapse, including administration, deployment, development, DevOps, and a glossary of terms.

```APIDOC
Synapse Guides:
  Synapse Admin Guide: https://synapse.docs.vertex.link/en/latest/synapse/adminguide.html
  Synapse Deployment Guide: https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide.html
  Synapse Devops Guide: https://synapse.docs.vertex.link/en/latest/synapse/devopsguide.html
  Synapse Developer Guide: https://synapse.docs.vertex.link/en/latest/synapse/devguide.html
  Synapse Glossary: https://synapse.docs.vertex.link/en/latest/synapse/glossary.html
  Synapse Contributors Guide: https://synapse.docs.vertex.link/en/latest/synapse/contributing.html
```

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

### Synapse Guides

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_188_0

Provides links to essential guides for Synapse, including administration, deployment, development, and a glossary.

```en
* [Synapse Admin Guide](https://synapse.docs.vertex.link/en/latest/synapse/adminguide.html)
* [Synapse Deployment Guide](https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide.html)
* [Synapse Devops Guide](https://synapse.docs.vertex.link/en/latest/synapse/devopsguide.html)
* [Synapse Developer Guide](https://synapse.docs.vertex.link/en/latest/synapse/devguide.html)
* [Synapse Glossary](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html)
```

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

### Get GUID Node by Dictionary

Source: https://synapse.docs.vertex.link/en/latest/_modules/synapse/lib/snap

Retrieves a GUID node based on its dictionary representation by first normalizing the dictionary and then finding the node.

```python
async def _getGuidNodeByDict(self, form, props):
        norms, _ = await self._normGuidNodeDict(form, props)
        return await self._getGuidNodeByNorms(form, norms)
```

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

### Synapse Admin Guide Enhancements

Source: https://synapse.docs.vertex.link/en/latest/synapse/changelog

The Synapse admin guide has been expanded with examples for creating extended model forms and properties, aiding in custom configuration and extension.

```markdown
Add examples for creating extended model forms and properties to the Synapse admin guide.
```

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

### Synapse Guides

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_176_0

Links to various guides for using and managing Synapse. This includes administration, deployment, DevOps, and developer guides, as well as a glossary for understanding terminology.

```MARKDOWN
* [Synapse Admin Guide](https://synapse.docs.vertex.link/en/latest/synapse/adminguide.html)
* [Synapse Deployment Guide](https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide.html)
* [Synapse Devops Guide](https://synapse.docs.vertex.link/en/latest/synapse/devopsguide.html)
* [Synapse Developer Guide](https://synapse.docs.vertex.link/en/latest/synapse/devguide.html)
* [Synapse Glossary](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html)
* [Synapse Contributors Guide](https://synapse.docs.vertex.link/en/latest/synapse/contributing.html)
```

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

### Start Cortex Mirror Service Container

Source: https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide

Pulls the Docker image and starts the Cortex mirror service container. This command is used after setting up the mirror's storage directory and configuration.

```bash
docker compose --file /srv/syn/01.cortex/docker-compose.yaml pull
docker compose --file /srv/syn/01.cortex/docker-compose.yaml up -d
```

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

### Start AHA Mirror Service Container

Source: https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide

Pulls the latest Docker image for the AHA mirror service and starts it in detached mode. This command assumes a docker-compose.yaml file is present for the service.

```bash
docker compose --file /srv/syn/01.aha/docker-compose.yaml pull
docker compose --file /srv/syn/01.aha/docker-compose.yaml up -d
```

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

### Synapse Deployment Guide

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/storm_ref_pivot

Information and steps required for deploying the Synapse platform.

```APIDOC
Synapse Deployment Guide:
  Detailed instructions for deploying Synapse in various environments.
  Refer to: https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide.html
```

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

### Synapse Deployment Guide

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/storm_ref_model_introspect

Instructions and best practices for deploying the Synapse platform in various environments.

```APIDOC
Synapse Deployment Guide:
  Details the steps and considerations for deploying Synapse.
  Includes information on infrastructure requirements, installation procedures, and environment setup.
```

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

### Start AHA Container with Docker Compose

Source: https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide

Pulls the latest image and starts the AHA container in detached mode using Docker Compose. This command assumes you are in the directory containing the docker-compose.yaml file.

```bash
docker compose --file /srv/syn/00.aha/docker-compose.yaml pull
docker compose --file /srv/syn/00.aha/docker-compose.yaml up -d
```

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

### Add Storm Service Example to Developer Docs

Source: https://synapse.docs.vertex.link/en/latest/synapse/changelog

Includes a minimal Storm Service example in the developer documentation. This provides a practical starting point for developers creating new services.

```markdown
developer documentation
```

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

### Synapse Deployment Guide

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/storm_ref_data_mod

Instructions and best practices for deploying Synapse.

```APIDOC
Synapse Deployment Guide:
  Details on how to deploy Synapse.
  URL: https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide.html
```

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

### Start Cortex Service Container

Source: https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide

Pulls the latest Docker image and starts the Cortex service container in detached mode using a Docker Compose file. This command assumes the docker-compose.yaml file is correctly configured.

```bash
docker compose --file /srv/syn/00.cortex/docker-compose.yaml pull
docker compose --file /srv/syn/00.cortex/docker-compose.yaml up -d
```

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

### Synapse Core Guides

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_162_0

Provides links to essential guides for Synapse users, including administration, deployment, DevOps, and developer resources. Also includes a link to the project's glossary and contributor guidelines.

```markdown
* [Synapse Admin Guide](https://synapse.docs.vertex.link/en/latest/synapse/adminguide.html)
* [Synapse Deployment Guide](https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide.html)
* [Synapse Devops Guide](https://synapse.docs.vertex.link/en/latest/synapse/devopsguide.html)
* [Synapse Developer Guide](https://synapse.docs.vertex.link/en/latest/synapse/devguide.html)
* [Synapse Glossary](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html)
* [Synapse Contributors Guide](https://synapse.docs.vertex.link/en/latest/synapse/contributing.html)
```

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

### Synapse Storm CLI Initialization and Options

Source: https://synapse.docs.vertex.link/en/latest/_modules/synapse/tools/storm

Initializes the Storm CLI with provided item, output, and options. Handles configuration files and view options, setting up command prompts and internal states.

```python
class StormCli(s_cli.Cli):

    histfile = 'storm_history'

    async def__anit__(self, item, outp=s_output.stdout, opts=None):

        await s_cli.Cli.__anit__(self, item, outp=outp)

        self.indented = False
        self.cmdprompt = 'storm> '

        self.stormopts = {'repr': True}

        if opts is not None:

            if opts.optsfile is not None:

                stormopts = s_common.yamlload(opts.optsfile)
                if stormopts is None:
                    mesg = f'The --optsfile {opts.optsfile} does not exist.'
                    raise s_exc.NoSuchFile(mesg=mesg)

                self.stormopts.update(stormopts)

            if opts.view:
                self.stormopts['view'] = opts.view

        self.hidetags = False
        self.hideprops = False
        self._print_skips = []
```

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

### Cortex Mirror Deployment Guide Correction

Source: https://synapse.docs.vertex.link/en/latest/synapse/changelog

Corrects an error in the Cortex mirror deployment guide. The example `docker-compose.yaml` was missing the environment variables for `SYN_CORTEX_AXON` and `SYN_CORTEX_JSONSTOR`. This documentation fix was part of version 2.155.0.

```YAML
services:
  cortex:
    image: vertex/cortex:latest
    environment:
      - SYN_CORTEX_AXON=true
      - SYN_CORTEX_JSONSTOR=true
    ports:
      - "5651:5651"
```

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

### Storm Documentation Updates

Source: https://synapse.docs.vertex.link/en/latest/synapse/changelog

Includes updates to the Storm command reference guide and glossary, providing additional examples and clarifications.

```APIDOC
Storm Documentation:
  - Updates: Command reference guide, glossary.
  - Content: Additional examples, clarifications.
  - Related Changes: Documentation for `reverse` keyword, `+?` operator, Storm lift, and data modification.
```

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

### Synapse Guides

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_167_0

Provides links to various guides for Synapse, including administration, deployment, development, and a glossary of terms. Also includes a guide for contributors.

```APIDOC
Synapse Guides:
  Admin Guide: https://synapse.docs.vertex.link/en/latest/synapse/adminguide.html
  Deployment Guide: https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide.html
  Devops Guide: https://synapse.docs.vertex.link/en/latest/synapse/devopsguide.html
  Developer Guide: https://synapse.docs.vertex.link/en/latest/synapse/devguide.html
  Glossary: https://synapse.docs.vertex.link/en/latest/synapse/glossary.html
  Contributors Guide: https://synapse.docs.vertex.link/en/latest/synapse/contributing.html
```

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

### Implementing Multiple HTTP Methods for an Endpoint

Source: https://synapse.docs.vertex.link/en/latest/synapse/devopsguide

Provides an example of implementing both GET and POST methods for a single API endpoint.

```Storm
api.add("/api/items", "GET", "return { 'items': ['item1', 'item2'] }")
api.add("/api/items", "POST", "return { 'status': 'created' }")
```

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

### Synapse Guides and Documentation

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_187_0

Provides links to various guides for Synapse, including administration, deployment, DevOps, development, a glossary of terms, contributor guidelines, and data modeling.

```markdown
* [Synapse Admin Guide](https://synapse.docs.vertex.link/en/latest/synapse/adminguide.html)
* [Synapse Deployment Guide](https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide.html)
* [Synapse Devops Guide](https://synapse.docs.vertex.link/en/latest/synapse/devopsguide.html)
* [Synapse Developer Guide](https://synapse.docs.vertex.link/en/latest/synapse/devguide.html)
* [Synapse Glossary](https://synapse.docs.vertex.link/en/latest/synapse/glossary.html)
* [Synapse Contributors Guide](https://synapse.docs.vertex.link/en/latest/synapse/contributing.html)
* [Synapse Data Model](https://synapse.docs.vertex.link/en/latest/synapse/datamodel.html)
```

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

### Synapse Guides

Source: https://synapse.docs.vertex.link/en/latest/synapse/userguides/model_updates/update_v2_155_0

Provides links to essential guides for Synapse, including administration, deployment, DevOps, development, and a glossary of terms.

```APIDOC
Synapse Guides:
  - Admin Guide: https://synapse.docs.vertex.link/en/latest/synapse/adminguide.html
  - Deployment Guide: https://synapse.docs.vertex.link/en/latest/synapse/deploymentguide.html
  - DevOps Guide: https://synapse.docs.vertex.link/en/latest/synapse/devopsguide.html
  - Developer Guide: https://synapse.docs.vertex.link/en/latest/synapse/devguide.html
  - Glossary: https://synapse.docs.vertex.link/en/latest/synapse/glossary.html
```
Tokens:
Raw