Rundeck Go SDK

Go SDK for the Rundeck / Runbook Automation API, generated from OpenAPI specification.

Installation

go get github.com/rundeck/go-rundeck/rundeck-v2@latest

Or pin to a specific version:

go get github.com/rundeck/go-rundeck/[email protected]

Example Usage

import "fmt"

import "github.com/rundeck/go-rundeck/rundeck"
import "github.com/rundeck/go-rundeck/rundeck/auth"

func main() {
    cl := rundeck.NewRundeckWithBaseURI("https://127.0.0.1:4440/api/26")   
    cl.Client.Authorizer = &auth.TokenAuthorizer{Token: "ABCDEFG"}  
    ctx := context.Background() 
    sysInfo, _ := cl.SystemInfoGet(ctx)

    fmt.Println(*sysInfo.System.Os.Name)
}

Building

Pre-requisites

DotNet Core SDK - Required for the Autorest backend
Nodejs/npm - Required for the Autorest frontend

Quick Start

autorest autorest.md

Versioning and Releases

This repository uses semantic versioning. Releases are automated via GitHub Actions when version tags are pushed.

For Maintainers

To create a new release:

git tag -a v1.0.0 -m "Release v1.0.0"
git push origin v1.0.0

See RELEASING.md for detailed release instructions.

For Consumers

Use standard Go module versioning:

// go.mod
require (
    github.com/rundeck/go-rundeck/rundeck-v2 v1.0.0
)

Or use pseudo-versions for unreleased commits:

github.com/rundeck/go-rundeck/rundeck-v2 v0.0.0-20251115214811-7b8e53bdb31e

SDK Structure

• rundeck/ - Legacy SDK (AutoRest-based, deprecated)
• rundeck-v2/ - Current SDK (OpenAPI Generator-based) ⭐

Contributing

See RELEASING.md for information about the release process.