runZero API - deprecated

This API client was generated by an experimental version of the OpenAPI Generator project using an older version of the YAML spec file. It is deprecated, and you are strongly recommended not to use it.

By using a current version of the OpenAPI-spec runzero-api.yml YAML file (found in the root of this repository) with an up-to-date OpenAPI generator, you can easily generate an API client.

• API version: 1.0.4
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sw "./openapi"

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identifield by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

All URIs are relative to https://console.runzero.com/api/v1.0

• APIKey
• Agent
• AgentSiteID
• Asset
• AssetComments
• AssetTags
• AssetsWithCheckpoint
• ComponentVersion
• OrgOptions
• Organization
• ScanOptions
• Service
• Site
• SiteOptions
• Task
• URL
• Wireless

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

[email protected]