📚 Documentation

Introduction

Welcome to NetOps Vault! This platform helps network engineers and DevOps professionals store, organize, and share configuration snippets, scripts, and code in a secure and collaborative environment.

Quick Start

1. Create Your Account

Sign up using your email, Google, or GitHub account. Email verification is required for security.

2. Create Your First Snippet

1. Click the "+ New Snippet" button in the navigation bar
2. Enter a title and description for your snippet
3. Select the programming language for syntax highlighting
4. Paste or type your code
5. Add tags for easy searching
6. Click "Save"

Creating & Managing Snippets

Snippet Visibility

When creating a snippet, you can choose its visibility:

• Private: Only you can see it
• Team: Share with specific teams
• Public: Anyone with the link can view

Syntax Highlighting

NetOps Vault supports syntax highlighting for over 100 programming languages, including:

• Python, JavaScript, Go, Rust
• Cisco IOS, Juniper JunOS configurations
• YAML, JSON, XML
• Bash, PowerShell scripts
• And many more...

Editing Snippets

To edit a snippet:

1. Navigate to the snippet you want to edit
2. Click the "Edit" button
3. Make your changes
4. Click "Update"

Organizations

Organizations allow you to manage multiple teams and users under a single umbrella, perfect for companies or large groups.

Creating an Organization

1. Go to Organizations in the navigation menu
2. Click "Create Organization"
3. Enter organization name and description
4. Set visibility (public or private)
5. Click "Create"

Organization Roles

• Owner: Full control over organization and all teams
• Admin: Manage members and teams
• Member: Access organization resources

Managing Members

Organization owners and admins can:

• Invite users by username or email
• Assign roles to members
• Remove members
• View audit logs (Organization plan)

Teams & Collaboration

Teams enable collaboration on snippets. Share code, configurations, and scripts with your teammates.

Creating a Team

1. Navigate to Teams
2. Click "Create Team"
3. Enter team name and description
4. Choose visibility:
   • Public: Anyone can join
   • Private: Invite-only (requires Individual Pro or Organization plan)
5. Optionally link to an organization
6. Click "Create"

Team Roles

• Owner: Full control, can delete team
• Admin: Manage members and snippets
• Member: View and create team snippets

Folders & Organization

Organize your snippets into folders for better management and quick access.

Creating Folders

1. Go to your snippet library
2. Click "New Folder"
3. Enter folder name and optional description
4. Set permissions (who can view/edit)
5. Click "Create"

Moving Snippets to Folders

When creating or editing a snippet, select the destination folder from the dropdown menu.

Version Control

Every time you edit a snippet, NetOps Vault automatically creates a new version, allowing you to track changes and revert if needed.

Viewing Version History

1. Open any snippet
2. Click "Version History"
3. Browse all previous versions
4. Click on a version to view its content

Comparing Versions

Compare any two versions to see what changed:

1. In version history, select two versions to compare
2. Click "Compare"
3. View a side-by-side diff highlighting additions and deletions

Sharing Snippets

Public Sharing

To share a snippet publicly:

1. Open the snippet
2. Click "Make Public"
3. Copy the public link
4. Share the link with anyone

Team Sharing

When creating a snippet, assign it to a team. All team members will have access based on their role.

Import & Export

Import from GitHub Gist

1. Go to Import in the menu
2. Select "Import from Gist"
3. Enter the Gist URL
4. Click "Import"

Export Collection

Export all your snippets as JSON:

1. Go to your profile
2. Click "Export Collection"
3. Download the JSON file

Import Collection

Import a previously exported collection:

1. Go to Import
2. Select "Import Collection"
3. Upload your JSON file
4. Review and confirm import

API Overview

NetOps Vault provides a full REST API for programmatic access to your snippets. Perfect for automation, CI/CD pipelines, and custom integrations.

Base URL

https://netops-vault.com/api/

Response Format

All API responses are in JSON format with the following structure:

{
  "status": "success",
  "data": {
    // Response data here
  }
}

Error responses:

{
  "status": "error",
  "error": "Error message description"
}

Authentication

The API uses token-based authentication. Include your API token in the Authorization header of every request.

Getting Your API Token

1. Go to your Profile
2. Scroll to "API Tokens" section
3. Click "Create New Token"
4. Give your token a name
5. Copy the token (you won't see it again!)

Using Your Token

Include the token in the Authorization header:

Authorization: Token YOUR_API_TOKEN_HERE

Example with curl:

curl -H "Authorization: Token abc123..." \
     https://netops-vault.com/api/snippets/

API Endpoints

curl -H "Authorization: Token YOUR_TOKEN" \
     "https://netops-vault.com/api/snippets/?language=python"

{
  "status": "success",
  "data": [
    {
      "id": 1,
      "title": "Cisco VLAN Configuration",
      "description": "Standard VLAN setup template",
      "language": "cisco",
      "content": "interface GigabitEthernet0/1...",
      "tags": ["cisco", "vlan", "template"],
      "created_at": "2025-12-27T10:00:00Z",
      "updated_at": "2025-12-27T15:30:00Z"
    }
  ]
}

curl -H "Authorization: Token YOUR_TOKEN" \
     https://netops-vault.com/api/snippets/123/

curl -X POST \
     -H "Authorization: Token YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "title": "Backup Script",
       "content": "#!/bin/bash\nbackup.sh",
       "language": "bash",
       "description": "Daily backup automation",
       "tags": ["backup", "automation"]
     }' \
     https://netops-vault.com/api/snippets/create/

curl -X PUT \
     -H "Authorization: Token YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "content": "#!/bin/bash\n# Updated script\nbackup.sh"
     }' \
     https://netops-vault.com/api/snippets/123/update/

curl -X DELETE \
     -H "Authorization: Token YOUR_TOKEN" \
     https://netops-vault.com/api/snippets/123/delete/

{
  "status": "success",
  "data": [
    {
      "id": 1,
      "name": "DevOps Team",
      "slug": "devops-team",
      "description": "Infrastructure automation",
      "is_private": true,
      "member_count": 5
    }
  ]
}

{
  "status": "success",
  "data": [
    {
      "id": 1,
      "name": "python",
      "snippet_count": 42
    },
    {
      "id": 2,
      "name": "cisco",
      "snippet_count": 28
    }
  ]
}