Use the Go SDK

clumio-go-sdk is a typed Go client for the Clumio REST API. It ships controllers for each resource group and a models package holding the request and response types. Requires Go 1.20 or later.

Install

go get github.com/clumio-code/clumio-go-sdk

Authenticate

import (
    "fmt"
    "log"

    "github.com/clumio-code/clumio-go-sdk/config"
    "github.com/clumio-code/clumio-go-sdk/controllers"
)

cfg := config.Config{
    Token:   "<your_api_token>",
    BaseUrl: "<base_url>",
}

client := controllers.NewPolicyDefinitionsV1(cfg)

BaseUrl must match the control plane that issued the token. See Authentication.

Use it

resp, err := client.ListPolicyDefinitions(nil, nil)
if err != nil {
    log.Fatalf("list policies: %v", err)
}

fmt.Println(resp)

Package layout

Package	Contains
`config`	Token, base URL and HTTP client configuration
`controllers`	One controller per resource group; the entry points you call
`models`	Request and response types shared across controllers

Response envelopes

List responses follow the HAL convention the API uses, so items are under an embedded collection alongside the pagination links. Read the links instead of constructing page offsets yourself.

Errors

Controllers return a standard Go error alongside the response. Check it before dereferencing the response.

Go SDK quickstart

Install the Go module, configure your client, and run your first call.

API tokens

Create a token and configure credentials for automation.

REST API reference

The Clumio REST API reference, which documents the endpoints the controllers call.

Source and issues

Read the code, report a bug, or open a pull request.

Overview

SDKs

Infrastructure as code

Automation and integrations

Use the Go SDK

Install

Authenticate

Use it

Next

Go SDK quickstart

API tokens

REST API reference

Source and issues

​Install

​Authenticate

​Use it

​Next

Go SDK quickstart

API tokens

REST API reference

Source and issues

Install

Authenticate

Use it

Next