Documentation
¶
Overview ¶
Package api provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen version v1.11.0 DO NOT EDIT.
Index ¶
- Constants
- type Group
- type GroupMinimum
- type GroupPatchOperation
- type GroupPatchOperationOp
- type GroupPatchOperationPath
- type PatchApiGroupsIdJSONBody
- type PatchApiGroupsIdJSONRequestBody
- type PatchApiRulesIdJSONBody
- type PatchApiRulesIdJSONRequestBody
- type Peer
- type PeerMinimum
- type PostApiGroupsJSONBody
- type PostApiGroupsJSONRequestBody
- type PostApiRulesJSONBody
- type PostApiRulesJSONRequestBody
- type PostApiSetupKeysJSONBody
- type PostApiSetupKeysJSONRequestBody
- type PutApiGroupsIdJSONBody
- type PutApiGroupsIdJSONRequestBody
- type PutApiPeersIdJSONBody
- type PutApiPeersIdJSONRequestBody
- type PutApiRulesIdJSONBody
- type PutApiRulesIdJSONRequestBody
- type PutApiSetupKeysIdJSONBody
- type PutApiSetupKeysIdJSONRequestBody
- type Rule
- type RuleMinimum
- type RulePatchOperation
- type RulePatchOperationOp
- type RulePatchOperationPath
- type SetupKey
- type SetupKeyRequest
- type User
Constants ¶
const (
BearerAuthScopes = "BearerAuth.Scopes"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Group ¶
type Group struct {
// Group ID
Id string `json:"id"`
// Group Name identifier
Name string `json:"name"`
// List of peers object
Peers []PeerMinimum `json:"peers"`
// Count of peers associated to the group
PeersCount int `json:"peers_count"`
}
Group defines model for Group.
type GroupMinimum ¶
type GroupMinimum struct {
// Group ID
Id string `json:"id"`
// Group Name identifier
Name string `json:"name"`
// Count of peers associated to the group
PeersCount int `json:"peers_count"`
}
GroupMinimum defines model for GroupMinimum.
type GroupPatchOperation ¶
type GroupPatchOperation struct {
// Patch operation type
Op GroupPatchOperationOp `json:"op"`
// Group field to update in form /<field>
Path GroupPatchOperationPath `json:"path"`
// Values to be applied
Value []string `json:"value"`
}
GroupPatchOperation defines model for GroupPatchOperation.
type GroupPatchOperationOp ¶
type GroupPatchOperationOp string
Patch operation type
const ( GroupPatchOperationOpAdd GroupPatchOperationOp = "add" GroupPatchOperationOpRemove GroupPatchOperationOp = "remove" GroupPatchOperationOpReplace GroupPatchOperationOp = "replace" )
Defines values for GroupPatchOperationOp.
type GroupPatchOperationPath ¶
type GroupPatchOperationPath string
Group field to update in form /<field>
const ( GroupPatchOperationPathName GroupPatchOperationPath = "name" GroupPatchOperationPathPeers GroupPatchOperationPath = "peers" )
Defines values for GroupPatchOperationPath.
type PatchApiGroupsIdJSONBody ¶
type PatchApiGroupsIdJSONBody = []GroupPatchOperation
PatchApiGroupsIdJSONBody defines parameters for PatchApiGroupsId.
type PatchApiGroupsIdJSONRequestBody ¶
type PatchApiGroupsIdJSONRequestBody = PatchApiGroupsIdJSONBody
PatchApiGroupsIdJSONRequestBody defines body for PatchApiGroupsId for application/json ContentType.
type PatchApiRulesIdJSONBody ¶
type PatchApiRulesIdJSONBody = []RulePatchOperation
PatchApiRulesIdJSONBody defines parameters for PatchApiRulesId.
type PatchApiRulesIdJSONRequestBody ¶
type PatchApiRulesIdJSONRequestBody = PatchApiRulesIdJSONBody
PatchApiRulesIdJSONRequestBody defines body for PatchApiRulesId for application/json ContentType.
type Peer ¶
type Peer struct {
// Provides information of who activated the Peer. User or Setup Key
ActivatedBy struct {
Type string `json:"type"`
Value string `json:"value"`
} `json:"activated_by"`
// Peer to Management connection status
Connected bool `json:"connected"`
// Groups that the peer belongs to
Groups []GroupMinimum `json:"groups"`
// Peer ID
Id string `json:"id"`
// Peer's IP address
Ip string `json:"ip"`
// Last time peer connected to Netbird's management service
LastSeen time.Time `json:"last_seen"`
// Peer's hostname
Name string `json:"name"`
// Peer's operating system and version
Os string `json:"os"`
// Indicates whether SSH server is enabled on this peer
SshEnabled bool `json:"ssh_enabled"`
// Peer's daemon or cli version
Version string `json:"version"`
}
Peer defines model for Peer.
type PeerMinimum ¶
type PeerMinimum struct {
// Peer ID
Id string `json:"id"`
// Peer's hostname
Name string `json:"name"`
}
PeerMinimum defines model for PeerMinimum.
type PostApiGroupsJSONBody ¶
type PostApiGroupsJSONBody struct {
Name string `json:"name"`
Peers *[]string `json:"peers,omitempty"`
}
PostApiGroupsJSONBody defines parameters for PostApiGroups.
type PostApiGroupsJSONRequestBody ¶
type PostApiGroupsJSONRequestBody PostApiGroupsJSONBody
PostApiGroupsJSONRequestBody defines body for PostApiGroups for application/json ContentType.
type PostApiRulesJSONBody ¶
type PostApiRulesJSONBody struct {
// Rule friendly description
Description string `json:"description"`
Destinations *[]string `json:"destinations,omitempty"`
// Rules status
Disabled bool `json:"disabled"`
// Rule flow, currently, only "bidirect" for bi-directional traffic is accepted
Flow string `json:"flow"`
// Rule name identifier
Name string `json:"name"`
Sources *[]string `json:"sources,omitempty"`
}
PostApiRulesJSONBody defines parameters for PostApiRules.
type PostApiRulesJSONRequestBody ¶
type PostApiRulesJSONRequestBody PostApiRulesJSONBody
PostApiRulesJSONRequestBody defines body for PostApiRules for application/json ContentType.
type PostApiSetupKeysJSONBody ¶
type PostApiSetupKeysJSONBody = SetupKeyRequest
PostApiSetupKeysJSONBody defines parameters for PostApiSetupKeys.
type PostApiSetupKeysJSONRequestBody ¶
type PostApiSetupKeysJSONRequestBody = PostApiSetupKeysJSONBody
PostApiSetupKeysJSONRequestBody defines body for PostApiSetupKeys for application/json ContentType.
type PutApiGroupsIdJSONBody ¶
type PutApiGroupsIdJSONBody struct {
Name *string `json:"Name,omitempty"`
Peers *[]string `json:"Peers,omitempty"`
}
PutApiGroupsIdJSONBody defines parameters for PutApiGroupsId.
type PutApiGroupsIdJSONRequestBody ¶
type PutApiGroupsIdJSONRequestBody PutApiGroupsIdJSONBody
PutApiGroupsIdJSONRequestBody defines body for PutApiGroupsId for application/json ContentType.
type PutApiPeersIdJSONBody ¶
type PutApiPeersIdJSONBody struct {
Name string `json:"name"`
SshEnabled bool `json:"ssh_enabled"`
}
PutApiPeersIdJSONBody defines parameters for PutApiPeersId.
type PutApiPeersIdJSONRequestBody ¶
type PutApiPeersIdJSONRequestBody PutApiPeersIdJSONBody
PutApiPeersIdJSONRequestBody defines body for PutApiPeersId for application/json ContentType.
type PutApiRulesIdJSONBody ¶
type PutApiRulesIdJSONBody struct {
// Rule friendly description
Description string `json:"description"`
Destinations *[]string `json:"destinations,omitempty"`
// Rules status
Disabled bool `json:"disabled"`
// Rule flow, currently, only "bidirect" for bi-directional traffic is accepted
Flow string `json:"flow"`
// Rule name identifier
Name string `json:"name"`
Sources *[]string `json:"sources,omitempty"`
}
PutApiRulesIdJSONBody defines parameters for PutApiRulesId.
type PutApiRulesIdJSONRequestBody ¶
type PutApiRulesIdJSONRequestBody PutApiRulesIdJSONBody
PutApiRulesIdJSONRequestBody defines body for PutApiRulesId for application/json ContentType.
type PutApiSetupKeysIdJSONBody ¶
type PutApiSetupKeysIdJSONBody = SetupKeyRequest
PutApiSetupKeysIdJSONBody defines parameters for PutApiSetupKeysId.
type PutApiSetupKeysIdJSONRequestBody ¶
type PutApiSetupKeysIdJSONRequestBody = PutApiSetupKeysIdJSONBody
PutApiSetupKeysIdJSONRequestBody defines body for PutApiSetupKeysId for application/json ContentType.
type Rule ¶
type Rule struct {
// Rule friendly description
Description string `json:"description"`
// Rule destination groups
Destinations []GroupMinimum `json:"destinations"`
// Rules status
Disabled bool `json:"disabled"`
// Rule flow, currently, only "bidirect" for bi-directional traffic is accepted
Flow string `json:"flow"`
// Rule ID
Id string `json:"id"`
// Rule name identifier
Name string `json:"name"`
// Rule source groups
Sources []GroupMinimum `json:"sources"`
}
Rule defines model for Rule.
type RuleMinimum ¶
type RuleMinimum struct {
// Rule friendly description
Description string `json:"description"`
// Rules status
Disabled bool `json:"disabled"`
// Rule flow, currently, only "bidirect" for bi-directional traffic is accepted
Flow string `json:"flow"`
// Rule name identifier
Name string `json:"name"`
}
RuleMinimum defines model for RuleMinimum.
type RulePatchOperation ¶
type RulePatchOperation struct {
// Patch operation type
Op RulePatchOperationOp `json:"op"`
// Rule field to update in form /<field>
Path RulePatchOperationPath `json:"path"`
// Values to be applied
Value []string `json:"value"`
}
RulePatchOperation defines model for RulePatchOperation.
type RulePatchOperationOp ¶
type RulePatchOperationOp string
Patch operation type
const ( RulePatchOperationOpAdd RulePatchOperationOp = "add" RulePatchOperationOpRemove RulePatchOperationOp = "remove" RulePatchOperationOpReplace RulePatchOperationOp = "replace" )
Defines values for RulePatchOperationOp.
type RulePatchOperationPath ¶
type RulePatchOperationPath string
Rule field to update in form /<field>
const ( RulePatchOperationPathDescription RulePatchOperationPath = "description" RulePatchOperationPathDestinations RulePatchOperationPath = "destinations" RulePatchOperationPathDisabled RulePatchOperationPath = "disabled" RulePatchOperationPathFlow RulePatchOperationPath = "flow" RulePatchOperationPathName RulePatchOperationPath = "name" RulePatchOperationPathSources RulePatchOperationPath = "sources" )
Defines values for RulePatchOperationPath.
type SetupKey ¶
type SetupKey struct {
// Setup Key expiration date
Expires time.Time `json:"expires"`
// Setup Key ID
Id string `json:"id"`
// Setup Key value
Key string `json:"key"`
// Setup key last usage date
LastUsed time.Time `json:"last_used"`
// Setup key name identifier
Name string `json:"name"`
// Setup key revocation status
Revoked bool `json:"revoked"`
// Setup key status, "valid", "overused","expired" or "revoked"
State string `json:"state"`
// Setup key type, one-off for single time usage and reusable
Type string `json:"type"`
// Usage count of setup key
UsedTimes int `json:"used_times"`
// Setup key validity status
Valid bool `json:"valid"`
}
SetupKey defines model for SetupKey.
type SetupKeyRequest ¶
type SetupKeyRequest struct {
// Expiration time in seconds
ExpiresIn int `json:"expires_in"`
// Setup Key name
Name string `json:"name"`
// Setup key revocation status
Revoked bool `json:"revoked"`
// Setup key type, one-off for single time usage and reusable
Type string `json:"type"`
}
SetupKeyRequest defines model for SetupKeyRequest.