Go API client for argus

API endpoints for Argus on STACKIT

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 1.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

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 argus "github.com/GIT_USER_ID/GIT_REPO_ID"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

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

Select Server Configuration

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

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

Templated Server URL

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(), argus.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

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

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified 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(), argus.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), argus.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.argus.eu01.stackit.cloud

Class	Method	HTTP request	Description
AlertConfigApi	V1InstancesAlertconfigsList	Get /v1/instances/{instanceId}/alertconfigs
AlertConfigApi	V1InstancesAlertconfigsUpdate	Put /v1/instances/{instanceId}/alertconfigs
AlertConfigApi	V1ProjectsInstancesAlertconfigsList	Get /v1/projects/{projectId}/instances/{instanceId}/alertconfigs
AlertConfigApi	V1ProjectsInstancesAlertconfigsUpdate	Put /v1/projects/{projectId}/instances/{instanceId}/alertconfigs
AlertGroupsApi	V1InstancesAlertgroupsAllDelete	Delete /v1/instances/{instanceId}/alertgroups
AlertGroupsApi	V1InstancesAlertgroupsCreate	Post /v1/instances/{instanceId}/alertgroups
AlertGroupsApi	V1InstancesAlertgroupsDelete	Delete /v1/instances/{instanceId}/alertgroups/{groupName}
AlertGroupsApi	V1InstancesAlertgroupsList	Get /v1/instances/{instanceId}/alertgroups
AlertGroupsApi	V1InstancesAlertgroupsPartialUpdate	Patch /v1/instances/{instanceId}/alertgroups
AlertGroupsApi	V1InstancesAlertgroupsRead	Get /v1/instances/{instanceId}/alertgroups/{groupName}
AlertGroupsApi	V1InstancesAlertgroupsUpdate	Put /v1/instances/{instanceId}/alertgroups/{groupName}
AlertGroupsApi	V1ProjectsInstancesAlertgroupsAllDelete	Delete /v1/projects/{projectId}/instances/{instanceId}/alertgroups
AlertGroupsApi	V1ProjectsInstancesAlertgroupsCreate	Post /v1/projects/{projectId}/instances/{instanceId}/alertgroups
AlertGroupsApi	V1ProjectsInstancesAlertgroupsDelete	Delete /v1/projects/{projectId}/instances/{instanceId}/alertgroups/{groupName}
AlertGroupsApi	V1ProjectsInstancesAlertgroupsList	Get /v1/projects/{projectId}/instances/{instanceId}/alertgroups
AlertGroupsApi	V1ProjectsInstancesAlertgroupsPartialUpdate	Patch /v1/projects/{projectId}/instances/{instanceId}/alertgroups
AlertGroupsApi	V1ProjectsInstancesAlertgroupsRead	Get /v1/projects/{projectId}/instances/{instanceId}/alertgroups/{groupName}
AlertGroupsApi	V1ProjectsInstancesAlertgroupsUpdate	Put /v1/projects/{projectId}/instances/{instanceId}/alertgroups/{groupName}
AlertRulesApi	V1InstancesAlertgroupsAlertrulesAllDelete	Delete /v1/instances/{instanceId}/alertgroups/{groupName}/alertrules
AlertRulesApi	V1InstancesAlertgroupsAlertrulesCreate	Post /v1/instances/{instanceId}/alertgroups/{groupName}/alertrules
AlertRulesApi	V1InstancesAlertgroupsAlertrulesDelete	Delete /v1/instances/{instanceId}/alertgroups/{groupName}/alertrules/{alertName}
AlertRulesApi	V1InstancesAlertgroupsAlertrulesList	Get /v1/instances/{instanceId}/alertgroups/{groupName}/alertrules
AlertRulesApi	V1InstancesAlertgroupsAlertrulesPartialUpdate	Patch /v1/instances/{instanceId}/alertgroups/{groupName}/alertrules
AlertRulesApi	V1InstancesAlertgroupsAlertrulesRead	Get /v1/instances/{instanceId}/alertgroups/{groupName}/alertrules/{alertName}
AlertRulesApi	V1InstancesAlertgroupsAlertrulesUpdate	Put /v1/instances/{instanceId}/alertgroups/{groupName}/alertrules/{alertName}
AlertRulesApi	V1ProjectsInstancesAlertgroupsAlertrulesAllDelete	Delete /v1/projects/{projectId}/instances/{instanceId}/alertgroups/{groupName}/alertrules
AlertRulesApi	V1ProjectsInstancesAlertgroupsAlertrulesCreate	Post /v1/projects/{projectId}/instances/{instanceId}/alertgroups/{groupName}/alertrules
AlertRulesApi	V1ProjectsInstancesAlertgroupsAlertrulesDelete	Delete /v1/projects/{projectId}/instances/{instanceId}/alertgroups/{groupName}/alertrules/{alertName}
AlertRulesApi	V1ProjectsInstancesAlertgroupsAlertrulesList	Get /v1/projects/{projectId}/instances/{instanceId}/alertgroups/{groupName}/alertrules
AlertRulesApi	V1ProjectsInstancesAlertgroupsAlertrulesPartialUpdate	Patch /v1/projects/{projectId}/instances/{instanceId}/alertgroups/{groupName}/alertrules
AlertRulesApi	V1ProjectsInstancesAlertgroupsAlertrulesRead	Get /v1/projects/{projectId}/instances/{instanceId}/alertgroups/{groupName}/alertrules/{alertName}
AlertRulesApi	V1ProjectsInstancesAlertgroupsAlertrulesUpdate	Put /v1/projects/{projectId}/instances/{instanceId}/alertgroups/{groupName}/alertrules/{alertName}
BucketRetentionApi	V1InstancesBucketRetentionsList	Get /v1/instances/{instanceId}/bucket-retentions
BucketRetentionApi	V1InstancesBucketRetentionsUpdate	Put /v1/instances/{instanceId}/bucket-retentions
BucketRetentionApi	V1ProjectsInstancesBucketRetentionsList	Get /v1/projects/{projectId}/instances/{instanceId}/bucket-retentions
BucketRetentionApi	V1ProjectsInstancesBucketRetentionsUpdate	Put /v1/projects/{projectId}/instances/{instanceId}/bucket-retentions
GrafanaConfigsApi	V1InstancesGrafanaConfigsList	Get /v1/instances/{instanceId}/grafana-configs
GrafanaConfigsApi	V1InstancesGrafanaConfigsUpdate	Put /v1/instances/{instanceId}/grafana-configs
GrafanaConfigsApi	V1ProjectsInstancesGrafanaConfigsList	Get /v1/projects/{projectId}/instances/{instanceId}/grafana-configs
GrafanaConfigsApi	V1ProjectsInstancesGrafanaConfigsUpdate	Put /v1/projects/{projectId}/instances/{instanceId}/grafana-configs
InstancesApi	V1InstancesRead	Get /v1/instances/{instanceId}
InstancesApi	V1ProjectsInstancesRead	Get /v1/projects/{projectId}/instances/{instanceId}
ScrapeConfigApi	V1InstancesScrapeconfigsAllDelete	Delete /v1/instances/{instanceId}/scrapeconfigs
ScrapeConfigApi	V1InstancesScrapeconfigsCreate	Post /v1/instances/{instanceId}/scrapeconfigs
ScrapeConfigApi	V1InstancesScrapeconfigsDelete	Delete /v1/instances/{instanceId}/scrapeconfigs/{jobName}
ScrapeConfigApi	V1InstancesScrapeconfigsList	Get /v1/instances/{instanceId}/scrapeconfigs
ScrapeConfigApi	V1InstancesScrapeconfigsPartialUpdate	Patch /v1/instances/{instanceId}/scrapeconfigs
ScrapeConfigApi	V1InstancesScrapeconfigsRead	Get /v1/instances/{instanceId}/scrapeconfigs/{jobName}
ScrapeConfigApi	V1InstancesScrapeconfigsUpdate	Put /v1/instances/{instanceId}/scrapeconfigs/{jobName}
ScrapeConfigApi	V1ProjectsInstancesScrapeconfigsAllDelete	Delete /v1/projects/{projectId}/instances/{instanceId}/scrapeconfigs
ScrapeConfigApi	V1ProjectsInstancesScrapeconfigsCreate	Post /v1/projects/{projectId}/instances/{instanceId}/scrapeconfigs
ScrapeConfigApi	V1ProjectsInstancesScrapeconfigsDelete	Delete /v1/projects/{projectId}/instances/{instanceId}/scrapeconfigs/{jobName}
ScrapeConfigApi	V1ProjectsInstancesScrapeconfigsList	Get /v1/projects/{projectId}/instances/{instanceId}/scrapeconfigs
ScrapeConfigApi	V1ProjectsInstancesScrapeconfigsPartialUpdate	Patch /v1/projects/{projectId}/instances/{instanceId}/scrapeconfigs
ScrapeConfigApi	V1ProjectsInstancesScrapeconfigsRead	Get /v1/projects/{projectId}/instances/{instanceId}/scrapeconfigs/{jobName}
ScrapeConfigApi	V1ProjectsInstancesScrapeconfigsUpdate	Put /v1/projects/{projectId}/instances/{instanceId}/scrapeconfigs/{jobName}

Documentation For Models

• Alert
• AlertGroup
• AlertRule
• ApiUser
• BasicAuth
• BucketRetentionTimeRespond
• ClusterList
• CreateJob
• Dashboard
• DeleteAlertGroup
• DeleteAlertRule
• DeleteJob
• EmailConfig
• GetAlert
• GetAlertGroup
• GetAlertRule
• GetAllAlertGroups
• GetAllAlertRules
• GetAllJob
• GetJob
• Global
• GrafanaConfigsSerializerRespond
• HttpConfig
• InhibitRules
• Instance
• InstanceSensitiveData
• Job
• Message
• MetricsRelabelConfig
• OpsgenieConfig
• PermissionDenied
• Plan
• PlanModel
• PlanSingle
• PostAlertGroup
• PostAlertRule
• PutAlert
• PutAlertGroup
• PutAlertRule
• Receivers
• Route
• RouteSerializer2
• Service
• Services
• StaticConfigs
• Status
• TLSConfig
• Tag
• V1InstancesAlertconfigsUpdateRequest
• V1InstancesAlertconfigsUpdateRequestGlobal
• V1InstancesAlertconfigsUpdateRequestInhibitRules
• V1InstancesAlertconfigsUpdateRequestReceiversInner
• V1InstancesAlertconfigsUpdateRequestReceiversInnerEmailConfigsInner
• V1InstancesAlertconfigsUpdateRequestReceiversInnerOpsgenieConfigsInner
• V1InstancesAlertconfigsUpdateRequestReceiversInnerOpsgenieConfigsInnerHttpConfig
• V1InstancesAlertconfigsUpdateRequestReceiversInnerWebHookConfigsInner
• V1InstancesAlertconfigsUpdateRequestRoute
• V1InstancesAlertconfigsUpdateRequestRouteRoutesInner
• V1InstancesAlertgroupsAlertrulesCreateRequest
• V1InstancesAlertgroupsCreateRequest
• V1InstancesAlertgroupsCreateRequestRulesInner
• V1InstancesBucketRetentionsUpdateRequest
• V1InstancesGrafanaConfigsUpdateRequest
• V1InstancesScrapeconfigsCreateRequest
• V1InstancesScrapeconfigsCreateRequestBasicAuth
• V1InstancesScrapeconfigsCreateRequestMetricsRelabelConfigsInner
• V1InstancesScrapeconfigsCreateRequestParams
• V1InstancesScrapeconfigsCreateRequestStaticConfigsInner
• V1InstancesScrapeconfigsCreateRequestTlsConfig
• WebHook

Documentation For Authorization

Basic

• Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

bearerAuth

• Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

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

Author

[email protected]