Documentation

Netskein Documentation

Everything you need to get started with automated network device management

Quick Start

Get up and running in minutes with our step-by-step guide

Configuration

Learn how to configure devices and set up automation

Netskein Agent

Deploy the unified collector binary at customer sites

Git Integration

Version control your network configurations with Git

Deployment

Deploy Netskein on AWS, GCP, or your own infrastructure

API Reference

Integrate Netskein with your existing tools via API

Quick Start

Follow these steps to start managing your network devices with Netskein:

1

Create an Account

Sign up for a free trial account. No credit card required for the 14-day trial period.

2

Add Your Organization

Create your organization and invite team members to collaborate on device management.

3

Register Devices

Add your network devices by providing their connection details (IP, credentials, device type).

4

Configure Backup Schedule

Set up automated backup schedules for your devices. Backups run automatically based on your schedule.

5

Set Up Notifications

Configure email notifications to get alerted when configuration changes are detected.

Configuration

Supported Vendors

Netskein currently supports the following network device vendors:

  • ✓Cisco IOS/IOS-XE - Full support for show running-config
  • ✓Juniper JunOS - Configuration retrieval via NETCONF
  • ○Arista EOS - Coming soon
  • ○Palo Alto - Coming soon

Device Connection Methods

Netskein supports multiple connection methods:

  • •SSH - Secure shell with username/password or key-based auth
  • •NETCONF - For devices supporting NETCONF protocol
  • •API - REST API for supported devices

Netskein Agent

The Netskein Agent is a single Go binary that runs at customer sites. It performs config collection and latency monitoring — the modules it actually runs are decided by what the admin has enabled for your organization.

Installation

# Build from source
cd agent
go build -o netskein-agent ./cmd/netskein-agent

Configuration

Get an API key from the admin Collectors page (shown exactly once), then run:

NETSKEIN_SERVER_URL=https://api.netskein.io \
NETSKEIN_API_KEY=nkc_... \
./netskein-agent run

Git Integration

All device configurations are automatically stored in Git repositories, providing full version control capabilities.

Features

  • •Automatic commits when configuration changes are detected
  • •View configuration history and diffs
  • •Clone repositories to your local machine
  • •Integrate with external Git services (GitHub, GitLab)

Repository Structure

Each organization gets a dedicated Git repository with the following structure:

organization-repo/
├── routers/
│   ├── router-01.cfg
│   └── router-02.cfg
├── switches/
│   ├── switch-01.cfg
│   └── switch-02.cfg
└── firewalls/
    └── firewall-01.cfg

Deployment

Netskein can be deployed in multiple environments to suit your infrastructure needs.

Cloud Deployment

We provide Terraform templates for easy deployment on major cloud providers:

  • •AWS - ECS/EKS deployment with RDS and S3
  • •GCP - GKE deployment with Cloud SQL
  • •Azure - Coming soon

On-Premises Deployment

Deploy using Docker Compose or Kubernetes:

# Using Docker Compose
docker-compose up -d

# Using Kubernetes
kubectl apply -f infrastructure/kubernetes/deployment.yaml

API Reference

Netskein provides a comprehensive REST API for integration with your existing tools and workflows.

Authentication

All API requests require authentication using an API token:

curl -H "Authorization: Bearer YOUR_API_TOKEN" \
     https://api.netskein.io/v1/devices

Common Endpoints

GET/v1/devices

List all devices in your organization

POST/v1/devices

Register a new device

GET/v1/configs/:device_id

Get device configurations

GET/v1/diffs/:device_id

Get configuration diffs

Need Help?

Our support team is here to help you get the most out of Netskein

Contact SupportStart Free Trial