VAST Go Client

The VAST Go client provides an interface to the VAST Data REST API. It wraps low-level HTTP calls in structured methods, allowing you to interact with volumes, views, quotas, and other resources easily.

---

NOTE: Since version 0.100.0, the REST client has been split into two distinct client types. String and integer fields in SearchParams structs use typed expressions from github.com/vast-data/go-vast-client/resources/typed/expr — see Typed Search Expressions for the full reference.

• Typed Client (NewTypedVMSRest): Provides strongly-typed structs for requests and responses. Offers compile-time type safety, IDE auto-completion, and clear API contracts. Recommended for most use cases.
• Untyped Client (NewVMSRest): Uses flexible map[string]any for data handling. Useful for dynamic scenarios and prototyping. This is the default recommended client.

Installation

go get github.com/vast-data/go-vast-client@v0.145.0  # Replace with the latest available tag

Import it in your Go code:

import client "github.com/vast-data/go-vast-client"

Quick Start

package main

import (
    "fmt"
    client "github.com/vast-data/go-vast-client"
    "github.com/vast-data/go-vast-client/resources/typed"
    "github.com/vast-data/go-vast-client/resources/typed/expr"
)

func main() {
    config := &client.VMSConfig{
        Host:     "10.27.40.1",
        Username: "admin",
        Password: "123456",
    }

    rest, err := client.NewTypedVMSRest(config)
    if err != nil {
        panic(err)
    }

    // expr.Str("...") is an exact-match StrField — see docs/typed-expressions.md
    searchParams := &typed.ViewSearchParams{
        Path: expr.Str("/myview"),
    }

    body := &typed.ViewRequestBody{
        Name:      "myview",
        Path:      "/myview",
        Protocols: &[]string{"NFS"},
        PolicyId:  1,
        CreateDir: true,
    }

    view, err := rest.Views.Ensure(searchParams, body)
    if err != nil {
        panic(err)
    }

    fmt.Printf("View: %s (ID: %d)\n", view.Name, view.Id)

    // Expression-based search: name starts with "my"
    views, err := rest.Views.List(&typed.ViewSearchParams{
        Name: expr.Str.StartsWith("my"),
    })
    if err != nil {
        panic(err)
    }
    fmt.Printf("Found %d views starting with 'my'\n", len(views))
}