No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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: 0.1.0
• Package version: 1.0.0
• Generator version: 7.10.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.GoClientCodegen

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 goyeti "github.com/yeti-platform/goyeti"

To use a proxy, set the environment variable HTTP_PROXY:

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

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 goyeti.ContextServerIndex of type int.

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

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

ctx := context.WithValue(context.Background(), goyeti.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 identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using goyeti.ContextOperationServerIndices and goyeti.ContextOperationServerVariables context maps.

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

All URIs are relative to http://localhost

• ASNInput
• ASNOutput
• AddContextRequest
• AddTextRequest
• AddedInner
• AnalysisRequest
• AnalysisResponse
• AnalyticsTask
• AttackPatternInput
• AttackPatternOutput
• BICInput
• BICOutput
• BulkObservableAddResponse
• CIDRInput
• CIDROutput
• CampaignInput
• CampaignOutput
• CertificateInput
• CertificateOutput
• CommandLineInput
• CommandLineOutput
• CompanyInput
• CompanyOutput
• CourseOfActionInput
• CourseOfActionOutput
• DFIQApproach
• DFIQApproachNotes
• DFIQApproachStep
• DFIQConfigResponse
• DFIQFacet
• DFIQQuestion
• DFIQScenario
• DFIQSearchRequest
• DFIQSearchRequestType
• DFIQSearchResponse
• DFIQType
• DFIQValidateRequest
• DFIQValidateResponse
• DeleteContextRequest
• DfiqInner
• DiamondModel
• DockerImageInput
• DockerImageOutput
• EmailInput
• EmailOutput
• EntitiesInner
• Entity
• Entity1
• EntitySearchRequest
• EntitySearchRequestType
• EntitySearchResponse
• EntityTagRequest
• EntityTagResponse
• EntityType
• Error
• ExportTaskInput
• ExportTaskOutput
• FeedTask
• FileInput
• FileOutput
• ForensicArtifactInput
• ForensicArtifactOutput
• GenericInput
• GenericOutput
• GraphAddRequest
• GraphDirection
• GraphFilter
• GraphPatchRequest
• GraphSearchRequest
• GraphSearchResponse
• HTTPValidationError
• Hops
• HostnameInput
• HostnameOutput
• IBANInput
• IBANOutput
• IPv4Input
• IPv4Output
• IPv6Input
• IPv6Output
• IdentityInput
• IdentityOutput
• ImphashInput
• ImphashOutput
• Indicator
• Indicator1
• IndicatorSearchRequest
• IndicatorSearchRequestType
• IndicatorSearchResponse
• IndicatorTagRequest
• IndicatorTagResponse
• IndicatorType
• IndicatorsInner
• IntrusionSetInput
• IntrusionSetOutput
• InvestigationInput
• InvestigationOutput
• JA3Input
• JA3Output
• JARMInput
• JARMOutput
• MD5Input
• MD5Output
• MacAddressInput
• MacAddressOutput
• MalwareInput
• MalwareOutput
• MaxHops
• MergeTagRequest
• MergeTagResult
• MinHops
• MutexInput
• MutexOutput
• Name
• NamedPipeInput
• NamedPipeOutput
• NewBulkObservableAddRequest
• NewDFIQRequest
• NewEntityRequest
• NewExportRequest
• NewExtendedObservableRequest
• NewIndicatorRequest
• NewObservableRequest
• NewRequest
• NewUserRequest
• NoteInput
• NoteOutput
• Observable
• Observable1
• ObservableSearchRequest
• ObservableSearchRequestType
• ObservableSearchResponse
• ObservableTagRequest
• ObservableTagResponse
• ObservableTypeInput
• OneShotTask
• PackageInput
• PackageOutput
• PatchDFIQRequest
• PatchEntityRequest
• PatchExportRequest
• PatchIndicatorRequest
• PatchObservableRequest
• PathInput
• PathOutput
• PathsInnerInner
• PhoneInput
• PhoneOutput
• QueryInput
• QueryOutput
• QueryValue
• RegexInput
• RegexOutput
• RegistryHive
• RegistryKeyInput
• RegistryKeyOutput
• Relationship
• RenderTemplateRequest
• ResetApiKeyRequest
• ResetPasswordRequest
• ResponseAddContextApiV2ObservablesObservableIdContextPost
• ResponseAddTextApiV2ObservablesAddTextPost
• ResponseDeleteContextApiV2ObservablesObservableIdContextDeletePost
• ResponseDetailsApiV2DfiqDfiqIdGet
• ResponseDetailsApiV2EntitiesEntityIdGet
• ResponseDetailsApiV2IndicatorsIndicatorIdGet
• ResponseDetailsApiV2ObservablesObservableIdGet
• ResponseNewApiV2EntitiesPost
• ResponseNewApiV2IndicatorsPost
• ResponseNewApiV2ObservablesPost
• ResponseNewExtendedApiV2ObservablesExtendedPost
• ResponseNewFromYamlApiV2DfiqFromYamlPost
• ResponsePatchApiV2DfiqDfiqIdPatch
• ResponsePatchApiV2EntitiesEntityIdPatch
• ResponsePatchApiV2IndicatorsIndicatorIdPatch
• ResponsePatchApiV2ObservablesObservableIdPatch
• ResponseToggleApiV2TasksTaskNameTogglePost
• SHA1Input
• SHA1Output
• SHA256Input
• SHA256Output
• SearchQuery
• SearchUserRequest
• SearchUserResponse
• SeverityType
• SigmaInput
• SigmaOutput
• SsdeepInput
• SsdeepOutput
• SuricataInput
• SuricataOutput
• SystemConfigResponse
• TLSHInput
• TLSHOutput
• Tag
• TagRelationshipInput
• TagRelationshipOutput
• TagSearchRequest
• TagSearchResponse
• TaskParams
• TaskSearchRequest
• TaskSearchRequestType
• TaskSearchResponse
• TaskStatus
• TaskType
• TasksInner
• Template
• TemplateSearchRequest
• TemplateSearchResponse
• ThreatActorInput
• ThreatActorOutput
• ToggleUserRequest
• ToggleableField
• ToolInput
• ToolOutput
• UpdateRequest
• UrlInput
• UrlOutput
• User
• UserAccountInput
• UserAccountOutput
• UserAgentInput
• UserAgentOutput
• ValidationError
• ValidationErrorLocInner
• VerticesValue
• VulnerabilityInput
• VulnerabilityOutput
• WalletInput
• WalletOutput
• WorkerRestartResponse
• WorkerStatusResponse
• YaraInput
• YaraOutput

Authentication schemes defined for the API:

• Type: API key
• API key parameter name: x-yeti-apikey
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: APIKeyHeader and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		goyeti.ContextAPIKeys,
		map[string]goyeti.APIKey{
			"APIKeyHeader": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A

Example

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

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, goyeti.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

• Type: API key
• API key parameter name: yeti_session
• Location:

Note, each API key must be added to a map of map[string]APIKey where the key is: APIKeyCookie and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		goyeti.ContextAPIKeys,
		map[string]goyeti.APIKey{
			"APIKeyCookie": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

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