types

package
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 17, 2026 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Overview

Package types defines api structure types

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type SiteCreateRequest

type SiteCreateRequest struct {
	// SiteUUID is the uuid for the site
	SiteUUID string `json:"siteuuid,omitempty"`

	// Name is an optional name for the site
	Name string `json:"name,omitempty"`

	// Provider is the name of the service provider the site belongs to
	Provider string `json:"provider,omitempty"`

	// FCOrg is the name of the Fleetcommand org corresponding to
	// the service provider
	FCOrg string `json:"fcorg,omitempty"`
}

SiteCreateRequest defines a site create request

type SiteCredsRequest

type SiteCredsRequest struct {
	// SiteUUID is the uuid for the site
	SiteUUID string `json:"siteuuid,omitempty"`
	// OTP is the one time passcode
	OTP string `json:"otp,omitempty"`
}

SiteCredsRequest defines a site credentials request

type SiteCredsResponse

type SiteCredsResponse struct {
	// Key is the private key
	Key string `json:"key,omitempty"`
	// Certificate is the client certificate
	Certificate string `json:"certificate,omitempty"`
	// CACertificate is the CA cert for validating the server
	CACertificate string `json:"cacertificate,omitempty"`
}

SiteCredsResponse defines a site credentials response

type SiteGetResponse

type SiteGetResponse struct {
	// SiteUUID is the uuid for the site
	SiteUUID string `json:"siteuuid,omitempty"`

	// Name is an optional name for the site
	Name string `json:"name,omitempty"`

	// Provider is the name of the service provider the site belongs to
	Provider string `json:"provider,omitempty"`

	// FCOrg is the name of the Fleetcommand org corresponding to
	// the service provider
	FCOrg string `json:"fcorg,omitempty"`

	// BootstrapState is the current bootstrap state of the site
	BootstrapState string `json:"bootstrapstate,omitempty"`

	// ControlPlaneStatus is the current status of the site control plane
	ControlPlaneStatus string `json:"controlplanestatus,omitempty"`

	// OTP is the current one time passcode
	OTP string `json:"otp,omitempty"`

	// OTPExpiry is the expiry timestamp
	OTPExpiry string `json:"otpexpiry,omitempty"`
}

SiteGetResponse defines a site get response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL