types

package
v2.10.2 Latest Latest
Warning

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

 Go to latest Published: Sep 5, 2026 License: BSD-3-Clause Imports: 5 Imported by: 0

Documentation

Overview

Package types provides the Arcane API endpoint path builders and CLI configuration types.

Each endpoint is a plain function that returns the request path, escaping every caller-supplied segment so resource names with special characters cannot alter the route.

Index

Constants

View Source 
const (
	VersionEndpoint    = "/api/version"
	AppVersionEndpoint = "/api/app-version"
)

Version

Variables

View Source 
var KnownPaginatedResources = []string{
	"containers",
	"images",
	"volumes",
	"networks",
	"projects",
	"environments",
	"registries",
	"templates",
	"repos",
	"gitops-syncs",
	"users",
	"roles",
	"events",
	"apikeys",
}

KnownPaginatedResources is the canonical list of paginated CLI resources.

Functions

func Activities added in v2.9.0 

func Activities(envID string) string

func ActivitiesHistory added in v2.9.0 

func ActivitiesHistory(envID string) string

func Activity added in v2.9.0 

func Activity(envID, activityID string) string

func ActivityCancel added in v2.9.0 

func ActivityCancel(envID, activityID string) string

func ApiKey added in v2.9.0 

func ApiKey(id string) string

func ApiKeys added in v2.9.0 

func ApiKeys() string

func AuthFederated added in v2.9.0 

func AuthFederated() string

func AuthLogout added in v2.9.0 

func AuthLogout() string

func AuthMe added in v2.9.0 

func AuthMe() string

func AuthMeApiKey added in v2.9.0 

func AuthMeApiKey(id string) string

func AuthMeApiKeys added in v2.9.0 

func AuthMeApiKeys() string

func AuthPassword added in v2.9.0 

func AuthPassword() string

func AuthRefresh added in v2.9.0 

func AuthRefresh() string

func Backup added in v2.9.0 

func Backup(id string) string

func BackupRestore added in v2.9.0 

func BackupRestore(id string) string

func BackupUpload added in v2.9.0 

func BackupUpload(id string) string

func Backups added in v2.9.0 

func Backups() string

func BackupsDiscover added in v2.9.0 

func BackupsDiscover() string

func BackupsPolicies added in v2.9.0 

func BackupsPolicies() string

func BackupsRecoveryKey added in v2.9.0 

func BackupsRecoveryKey() string

func BackupsRecoveryKeyGenerate added in v2.9.0 

func BackupsRecoveryKeyGenerate() string

func BackupsS3 added in v2.9.0 

func BackupsS3() string

func BackupsS3Destination added in v2.9.0 

func BackupsS3Destination(id string) string

func BackupsS3DestinationInUse added in v2.9.0 

func BackupsS3DestinationInUse(id string) string

func BackupsS3DestinationTest added in v2.9.0 

func BackupsS3DestinationTest(id string) string

func BackupsS3Options added in v2.9.0 

func BackupsS3Options() string

func BackupsS3Test added in v2.9.0 

func BackupsS3Test() string

func Container added in v2.9.0 

func Container(envID, containerID string) string

func ContainerAutoUpdate added in v2.9.0 

func ContainerAutoUpdate(envID, containerID string) string

func ContainerCommit added in v2.9.0 

func ContainerCommit(envID, containerID string) string

func ContainerEdit added in v2.9.0 

func ContainerEdit(envID, containerID string) string

func ContainerEditConfig added in v2.9.0 

func ContainerEditConfig(envID, containerID string) string

func ContainerKill added in v2.9.0 

func ContainerKill(envID, containerID string) string

func ContainerPause added in v2.9.0 

func ContainerPause(envID, containerID string) string

func ContainerRedeploy added in v2.9.0 

func ContainerRedeploy(envID, containerID string) string

func ContainerRegistries added in v2.9.0 

func ContainerRegistries() string

func ContainerRegistriesPullUsage added in v2.9.0 

func ContainerRegistriesPullUsage() string

func ContainerRegistry added in v2.9.0 

func ContainerRegistry(id string) string

func ContainerRegistryTest added in v2.9.0 

func ContainerRegistryTest(id string) string

func ContainerRestart added in v2.9.0 

func ContainerRestart(envID, containerID string) string

func ContainerStart added in v2.9.0 

func ContainerStart(envID, containerID string) string

func ContainerStop added in v2.9.0 

func ContainerStop(envID, containerID string) string

func ContainerUnpause added in v2.9.0 

func ContainerUnpause(envID, containerID string) string

func ContainerUpdate added in v2.9.0 

func ContainerUpdate(envID, containerID string) string

func Containers added in v2.9.0 

func Containers(envID string) string

func ContainersCounts added in v2.9.0 

func ContainersCounts(envID string) string

func Environment added in v2.9.0 

func Environment(id string) string

func EnvironmentTest added in v2.9.0 

func EnvironmentTest(envID string) string

func EnvironmentVersion added in v2.9.0 

func EnvironmentVersion(envID string) string

func Environments added in v2.9.0 

func Environments() string

func Event added in v2.9.0 

func Event(id string) string

func Events added in v2.9.0 

func Events() string

func EventsEnvironment added in v2.9.0 

func EventsEnvironment(envID string) string

func EventsStats added in v2.9.0 

func EventsStats() string

func FederatedCredential added in v2.9.0 

func FederatedCredential(id string) string

func FederatedCredentials added in v2.9.0 

func FederatedCredentials() string

func GitOpsSync added in v2.9.0 

func GitOpsSync(envID, syncID string) string

func GitOpsSyncFiles added in v2.9.0 

func GitOpsSyncFiles(envID, syncID string) string

func GitOpsSyncStatus added in v2.9.0 

func GitOpsSyncStatus(envID, syncID string) string

func GitOpsSyncTrigger added in v2.9.0 

func GitOpsSyncTrigger(envID, syncID string) string

func GitOpsSyncs added in v2.9.0 

func GitOpsSyncs(envID string) string

func GitOpsSyncsImport added in v2.9.0 

func GitOpsSyncsImport(envID string) string

func GitRepositories added in v2.9.0 

func GitRepositories() string

func GitRepository added in v2.9.0 

func GitRepository(id string) string

func GitRepositoryBranches added in v2.9.0 

func GitRepositoryBranches(id string) string

func GitRepositoryFiles added in v2.9.0 

func GitRepositoryFiles(id string) string

func GitRepositoryTest added in v2.9.0 

func GitRepositoryTest(id string) string

func Image added in v2.9.0 

func Image(envID, imageID string) string

func ImageAttestations added in v2.9.0 

func ImageAttestations(envID, name string) string

func ImageBuild added in v2.9.0 

func ImageBuild(envID, buildID string) string

func ImageBuilds added in v2.9.0 

func ImageBuilds(envID string) string

func ImageExport added in v2.9.0 

func ImageExport(envID, name string) string

func ImageHistory added in v2.9.0 

func ImageHistory(envID, name string) string

func ImageTag added in v2.9.0 

func ImageTag(envID, name string) string

func ImageUpdatesCheck added in v2.9.0 

func ImageUpdatesCheck(envID, imageRef string) string

func ImageUpdatesCheckAll added in v2.9.0 

func ImageUpdatesCheckAll(envID string) string

func ImageUpdatesCheckBatch added in v2.9.0 

func ImageUpdatesCheckBatch(envID string) string

func ImageUpdatesCheckById added in v2.9.0 

func ImageUpdatesCheckById(envID, imageID string) string

func ImageUpdatesSummary added in v2.9.0 

func ImageUpdatesSummary(envID string) string

func ImageVulnerabilities added in v2.9.0 

func ImageVulnerabilities(envID, imageID string) string

func ImageVulnerabilitiesList added in v2.9.0 

func ImageVulnerabilitiesList(envID, imageID string) string

func ImageVulnerabilitiesScan added in v2.9.0 

func ImageVulnerabilitiesScan(envID, imageID string) string

func ImageVulnerabilitiesSummary added in v2.9.0 

func ImageVulnerabilitiesSummary(envID, imageID string) string

func Images added in v2.9.0 

func Images(envID string) string

func ImagesBuild added in v2.9.0 

func ImagesBuild(envID string) string

func ImagesCounts added in v2.9.0 

func ImagesCounts(envID string) string

func ImagesPrune added in v2.9.0 

func ImagesPrune(envID string) string

func ImagesPull added in v2.9.0 

func ImagesPull(envID string) string

func ImagesSearch added in v2.9.0 

func ImagesSearch(envID string) string

func ImagesUpload added in v2.9.0 

func ImagesUpload(envID string) string

func ImagesVulnerabilitiesSummaries added in v2.9.0 

func ImagesVulnerabilitiesSummaries(envID string) string

func JobRun added in v2.9.0 

func JobRun(envID, jobID string) string

func JobSchedules added in v2.9.0 

func JobSchedules(envID string) string

func Jobs added in v2.9.0 

func Jobs(envID string) string

func Network added in v2.9.0 

func Network(envID, networkID string) string

func NetworkConnect added in v2.9.0 

func NetworkConnect(envID, networkID string) string

func NetworkDisconnect added in v2.9.0 

func NetworkDisconnect(envID, networkID string) string

func Networks added in v2.9.0 

func Networks(envID string) string

func NetworksCounts added in v2.9.0 

func NetworksCounts(envID string) string

func NetworksPrune added in v2.9.0 

func NetworksPrune(envID string) string

func NetworksTopology added in v2.9.0 

func NetworksTopology(envID string) string

func NormalizePaginatedResource 

func NormalizePaginatedResource(resource string) string

NormalizePaginatedResource normalizes resource names and common aliases.

func NotificationSettingsProvider added in v2.9.0 

func NotificationSettingsProvider(envID, provider string) string

func NotificationsSettings added in v2.9.0 

func NotificationsSettings(envID string) string

func NotificationsTestProvider added in v2.9.0 

func NotificationsTestProvider(envID, provider string) string

func OIDCDeviceCode added in v2.9.0 

func OIDCDeviceCode() string

func OIDCDeviceToken added in v2.9.0 

func OIDCDeviceToken() string

func OIDCStatus added in v2.9.0 

func OIDCStatus() string

func OidcRoleMapping added in v2.9.0 

func OidcRoleMapping(id string) string

func OidcRoleMappings added in v2.9.0 

func OidcRoleMappings() string

func Project added in v2.9.0 

func Project(envID, projectID string) string

func ProjectArchive added in v2.9.0 

func ProjectArchive(envID, projectID string) string

func ProjectBuild added in v2.9.0 

func ProjectBuild(envID, projectID string) string

func ProjectDestroy added in v2.9.0 

func ProjectDestroy(envID, projectID string) string

func ProjectDown added in v2.9.0 

func ProjectDown(envID, projectID string) string

func ProjectPull added in v2.9.0 

func ProjectPull(envID, projectID string) string

func ProjectRedeploy added in v2.9.0 

func ProjectRedeploy(envID, projectID string) string

func ProjectRestart added in v2.9.0 

func ProjectRestart(envID, projectID string) string

func ProjectTags added in v2.9.0 

func ProjectTags(envID, projectID string) string

func ProjectUnarchive added in v2.9.0 

func ProjectUnarchive(envID, projectID string) string

func ProjectUp added in v2.9.0 

func ProjectUp(envID, projectID string) string

func ProjectUpdateServices added in v2.9.0 

func ProjectUpdateServices(envID, projectID string) string

func ProjectWorkspace added in v2.9.0 

func ProjectWorkspace(envID, projectID string) string

func ProjectWorkspaceFile added in v2.9.0 

func ProjectWorkspaceFile(envID, projectID string) string

func ProjectWorkspaceFileDownload added in v2.9.0 

func ProjectWorkspaceFileDownload(envID, projectID string) string

func Projects added in v2.9.0 

func Projects(envID string) string

func ProjectsCounts added in v2.9.0 

func ProjectsCounts(envID string) string

func ProjectsTags added in v2.9.0 

func ProjectsTags(envID string) string

func Role added in v2.9.0 

func Role(id string) string

func Roles added in v2.9.0 

func Roles() string

func RolesAvailablePermissions added in v2.9.0 

func RolesAvailablePermissions() string

func Settings added in v2.9.0 

func Settings(envID string) string

func SettingsPublic added in v2.9.0 

func SettingsPublic(envID string) string

func SystemContainersStartAll added in v2.9.0 

func SystemContainersStartAll(envID string) string

func SystemContainersStopAll added in v2.9.0 

func SystemContainersStopAll(envID string) string

func SystemConvert added in v2.9.0 

func SystemConvert(envID string) string

func SystemDockerInfo added in v2.9.0 

func SystemDockerInfo(envID string) string

func SystemPrune added in v2.9.0 

func SystemPrune(envID string) string

func SystemStartStopped added in v2.9.0 

func SystemStartStopped(envID string) string

func SystemUpgrade added in v2.9.0 

func SystemUpgrade(envID string) string

func SystemUpgradeAll added in v2.9.0 

func SystemUpgradeAll(envID string) string

func SystemUpgradeAllStatus added in v2.9.0 

func SystemUpgradeAllStatus(envID string) string

func SystemUpgradeCheck added in v2.9.0 

func SystemUpgradeCheck(envID string) string

func Template added in v2.9.0 

func Template(id string) string

func TemplateContent added in v2.9.0 

func TemplateContent(id string) string

func TemplateDownload added in v2.9.0 

func TemplateDownload(id string) string

func TemplateFetch added in v2.9.0 

func TemplateFetch() string

func TemplateRegistry added in v2.9.0 

func TemplateRegistry(id string) string

func Templates added in v2.9.0 

func Templates() string

func TemplatesAll added in v2.9.0 

func TemplatesAll() string

func TemplatesDefault added in v2.9.0 

func TemplatesDefault() string

func TemplatesRegistries added in v2.9.0 

func TemplatesRegistries() string

func UpdaterHistory added in v2.9.0 

func UpdaterHistory(envID string) string

func UpdaterRun added in v2.9.0 

func UpdaterRun(envID string) string

func UpdaterStatus added in v2.9.0 

func UpdaterStatus(envID string) string

func UploadSession added in v2.9.0 

func UploadSession(envID, kind, uploadID string) string

func UploadSessionChunk added in v2.9.0 

func UploadSessionChunk(envID, kind, uploadID string, index int) string

func UploadSessions added in v2.9.0 

func UploadSessions(envID, kind string) string

func User added in v2.9.0 

func User(id string) string

func UserRoleAssignments added in v2.9.0 

func UserRoleAssignments(userID string) string

func Users added in v2.9.0 

func Users() string

func Variable added in v2.9.0 

func Variable(id string) string

func Variables added in v2.9.0 

func Variables() string

func VariablesSync added in v2.9.0 

func VariablesSync() string

func VariablesSyncStatus added in v2.9.0 

func VariablesSyncStatus() string

func Volume added in v2.9.0 

func Volume(envID, volumeName string) string

func VolumeBackup added in v2.9.0 

func VolumeBackup(envID, backupID string) string

func VolumeBackupDownload added in v2.9.0 

func VolumeBackupDownload(envID, backupID string) string

func VolumeBackupFiles added in v2.9.0 

func VolumeBackupFiles(envID, backupID string) string

func VolumeBackupPolicy added in v2.9.0 

func VolumeBackupPolicy(envID, volumeName string) string

func VolumeBackupRestore added in v2.9.0 

func VolumeBackupRestore(envID, volumeName, backupID string) string

func VolumeBackupRestoreFiles added in v2.9.0 

func VolumeBackupRestoreFiles(envID, volumeName, backupID string) string

func VolumeBackupUpload added in v2.9.0 

func VolumeBackupUpload(envID, backupID string) string

func VolumeBackupUploadRestore added in v2.9.0 

func VolumeBackupUploadRestore(envID, volumeName string) string

func VolumeBackups added in v2.9.0 

func VolumeBackups(envID, volumeName string) string

func VolumeRename added in v2.9.0 

func VolumeRename(envID, volumeName string) string

func VolumeUsage added in v2.9.0 

func VolumeUsage(envID, volumeName string) string

func VolumeWorkspace added in v2.9.0 

func VolumeWorkspace(envID, volumeName string) string

func VolumeWorkspaceFile added in v2.9.0 

func VolumeWorkspaceFile(envID, volumeName string) string

func VolumeWorkspaceFileDownload added in v2.9.0 

func VolumeWorkspaceFileDownload(envID, volumeName string) string

func Volumes added in v2.9.0 

func Volumes(envID string) string

func VolumesCounts added in v2.9.0 

func VolumesCounts(envID string) string

func VolumesPrune added in v2.9.0 

func VolumesPrune(envID string) string

func VolumesSizes added in v2.9.0 

func VolumesSizes(envID string) string

func VulnerabilitiesAll added in v2.9.0 

func VulnerabilitiesAll(envID string) string

func VulnerabilitiesIgnore added in v2.9.0 

func VulnerabilitiesIgnore(envID string) string

func VulnerabilitiesIgnored added in v2.9.0 

func VulnerabilitiesIgnored(envID string) string

func VulnerabilitiesScannerStatus added in v2.9.0 

func VulnerabilitiesScannerStatus(envID string) string

func VulnerabilitiesSummary added in v2.9.0 

func VulnerabilitiesSummary(envID string) string

func VulnerabilityIgnore added in v2.9.0 

func VulnerabilityIgnore(envID, ignoreID string) string

func Webhook added in v2.9.0 

func Webhook(envID, webhookID string) string

func WebhookTrigger added in v2.9.0 

func WebhookTrigger(token string) string

func Webhooks added in v2.9.0 

func Webhooks(envID string) string

Types

type Config 

type Config struct {
	// ServerURL is the base URL of the Arcane server (e.g., http://localhost:3552)
	ServerURL string `yaml:"server_url" mapstructure:"server_url"`
	// APIKey is the API key for authentication (sent as X-API-KEY)
	APIKey string `yaml:"api_key,omitempty" mapstructure:"api_key"`
	// JWTToken is the JWT access token for authentication (sent as Authorization: Bearer)
	JWTToken string `yaml:"jwt_token,omitempty" mapstructure:"jwt_token"`
	// RefreshToken is the refresh token for obtaining new access tokens
	RefreshToken string `yaml:"refresh_token,omitempty" mapstructure:"refresh_token"`
	// DefaultEnvironment is the default environment ID to use
	DefaultEnvironment string `yaml:"default_environment,omitempty" mapstructure:"default_environment"`
	// FederatedAudience is the default token audience for `arcane-cli auth federated`
	FederatedAudience string `yaml:"federated_audience,omitempty" mapstructure:"federated_audience"`
	// LogLevel is the logging level (debug, info, warn, error, fatal, panic)
	LogLevel string `yaml:"log_level,omitempty" mapstructure:"log_level"`
	// CLIUpdateChannel controls which channel self-update uses (stable or next).
	CLIUpdateChannel string `yaml:"cli_update_channel,omitempty" mapstructure:"cli_update_channel"`
	// Pagination contains global and per-resource pagination configuration.
	Pagination PaginationConfig `yaml:"pagination,omitempty" mapstructure:"pagination"`
}

Config holds the CLI configuration for connecting to an Arcane server. It is persisted to disk as YAML and loaded on each CLI invocation.

func (*Config) Clone 

func (c *Config) Clone() *Config

Clone returns a deep-copy of Config.

func (*Config) HasAuth 

func (c *Config) HasAuth() bool

HasAuth returns true if either an API key or JWT token is configured.

func (*Config) IsConfigured 

func (c *Config) IsConfigured() bool

IsConfigured returns true if both ServerURL and APIKey are set. This is a quick check to determine if the CLI has been configured without triggering validation errors.

func (*Config) LimitFor 

func (c *Config) LimitFor(resource string) int

LimitFor returns the configured limit for a resource, falling back to the global default.

func (*Config) SetDefaultLimit 

func (c *Config) SetDefaultLimit(limit int)

SetDefaultLimit configures the global pagination default.

func (*Config) SetResourceLimit 

func (c *Config) SetResourceLimit(resource string, limit int)

SetResourceLimit configures per-resource pagination defaults.

func (*Config) Validate 

func (c *Config) Validate() error

Validate checks if the configuration has all required fields set. It returns an error with instructions if ServerURL or APIKey is missing. This should be called before using the config to make API requests.

func (*Config) ValidateServerURL 

func (c *Config) ValidateServerURL() error

ValidateServerURL checks if the configuration has the server URL set. This is useful for commands like `auth login` that do not require prior authentication.

type PaginationConfig 

type PaginationConfig struct {
	// Default applies to paginated resources that do not have explicit per-resource config.
	Default PaginationResourceConfig `yaml:"default,omitempty" mapstructure:"default"`
	// Resources contains per-resource pagination settings keyed by resource name.
	Resources map[string]PaginationResourceConfig `yaml:"resources,omitempty" mapstructure:"resources"`
}

PaginationConfig contains global and per-resource pagination settings.

type PaginationResourceConfig 

type PaginationResourceConfig struct {
	// Limit is the default page size for list commands for this resource.
	Limit int `yaml:"limit,omitempty" mapstructure:"limit"`
}

PaginationResourceConfig defines pagination options for a specific resource.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.