pacfiles

Documentation

Index

• func DeletePacFile(ctx context.Context, service *zscaler.Service, fileID int) (*http.Response, error)
• type LastModifiedBy
• type PACFileConfig
  • func CreateClonedPacFileVersion(ctx context.Context, service *zscaler.Service, pacID int, clonedPacVersion int, ...) (*PACFileConfig, error)
  • func CreatePacFile(ctx context.Context, service *zscaler.Service, file *PACFileConfig) (*PACFileConfig, error)
  • func GetPacFileByName(ctx context.Context, service *zscaler.Service, pacFileName string) (*PACFileConfig, error)
  • func GetPacFileVersion(ctx context.Context, service *zscaler.Service, pacID int, filter string) ([]PACFileConfig, error)
  • func GetPacFiles(ctx context.Context, service *zscaler.Service, filter string) ([]PACFileConfig, error)
  • func GetPacVersionID(ctx context.Context, service *zscaler.Service, pacID, pacVersion int, ...) (*PACFileConfig, error)
  • func UpdatePacFile(ctx context.Context, service *zscaler.Service, pacID, pacVersion int, ...) (*PACFileConfig, error)
• type PacContentRequest
• type PacResult
  • func ValidatePacFile(ctx context.Context, service *zscaler.Service, pacContent string) (*PacResult, error)
• type PacValidationMessage

Functions

func DeletePacFile

func DeletePacFile(ctx context.Context, service *zscaler.Service, fileID int) (*http.Response, error)

Types

type LastModifiedBy

type LastModifiedBy struct {
	ID         int                    `json:"id,omitempty"`
	Name       string                 `json:"name,omitempty"`
	ExternalID string                 `json:"externalId,omitempty"`
	Extensions map[string]interface{} `json:"extensions,omitempty"`
}

type PACFileConfig

type PACFileConfig struct {
	// The unique identifier for the PAC file
	ID int `json:"id,omitempty"`

	//The name of the PAC file
	Name string `json:"name,omitempty"`

	// The description of the PAC file
	Description string `json:"description,omitempty"`

	// The domain of your organization to which the PAC file applies
	Domain string `json:"domain,omitempty"`

	// The URL location of the PAC file that is auto-generated when the PAC file is added for the first time.
	// Note: This value is not required in POST and PUT requests and the value is ignored if present.
	PACUrl string `json:"pacUrl,omitempty"`

	// The content of the PAC file.
	// To learn more, see Writing a PAC File. https://help.zscaler.com/zia/writing-pac-file
	PACContent string `json:"pacContent,omitempty"`

	// Indicates whether the PAC file is editable
	Editable bool `json:"editable,omitempty"`

	// Obfuscated domain name of the organization to which this PAC file applies
	PACSubURL string `json:"pacSubURL,omitempty"`

	// A Boolean value that indicates whether the PAC file URL is obfuscated.
	// If this value is true, the obfuscated URL is returned in the pacSubURL field.
	PACUrlObfuscated bool `json:"pacUrlObfuscated,omitempty"`

	// Indicates the verification status of the PAC file and if any errors are identified in the syntax
	// Supported values are: VERIFY_NOERR, VERIFY_ERR, NOVERIFY
	PACVerificationStatus string `json:"pacVerificationStatus,omitempty"`

	// Indicates the status of a specific version of a PAC file
	// as whether it is deployed, staged for deployment, or is marked as the last known good version.
	// Supported values are: DEPLOYED, STAGE, LKG
	PACVersionStatus string `json:"pacVersionStatus,omitempty"`

	// The version number of the PAC file
	PACVersion int `json:"pacVersion,omitempty"`

	// The commit message entered while saving the PAC file version as indicated by the pacVersion field
	PACCommitMessage string `json:"pacCommitMessage,omitempty"`

	// The number of times the PAC file was used during the last 30 days
	TotalHits int `json:"totalHits,omitempty"`

	// The timestamp when the PAC file was last modified. This value is represented in Unix time.
	LastModificationTime int64 `json:"lastModificationTime,omitempty"`

	// The username of the admin who last modified the PAC file
	LastModifiedBy LastModifiedBy `json:"lastModifiedBy,omitempty"`

	// The timestamp when the PAC file was created. This value is represented in Unix time.
	CreateTime int64 `json:"createTime,omitempty"`
}

func CreateClonedPacFileVersion

func CreateClonedPacFileVersion(ctx context.Context, service *zscaler.Service, pacID int, clonedPacVersion int, deleteVersion *int, file *PACFileConfig) (*PACFileConfig, error)

func CreatePacFile

func CreatePacFile(ctx context.Context, service *zscaler.Service, file *PACFileConfig) (*PACFileConfig, error)

func GetPacFileByName

func GetPacFileByName(ctx context.Context, service *zscaler.Service, pacFileName string) (*PACFileConfig, error)

func GetPacFileVersion

func GetPacFileVersion(ctx context.Context, service *zscaler.Service, pacID int, filter string) ([]PACFileConfig, error)

func GetPacFiles

func GetPacFiles(ctx context.Context, service *zscaler.Service, filter string) ([]PACFileConfig, error)

func GetPacVersionID

func GetPacVersionID(ctx context.Context, service *zscaler.Service, pacID, pacVersion int, filter string) (*PACFileConfig, error)

func UpdatePacFile

func UpdatePacFile(ctx context.Context, service *zscaler.Service, pacID, pacVersion int, pacVersionAction string, file *PACFileConfig, newLKGVer *int) (*PACFileConfig, error)

UpdatePacFile updates a PAC file version with a specified action. pacID: the PAC file ID pacVersion: the PAC file version pacVersionAction: the action to be performed on the PAC file version (DEPLOY, STAGE, LKG, UNSTAGE, REMOVE_LKG) newLKGVer: optional, specify if removing LKG and want to assign a new version

type PacContentRequest

type PacContentRequest struct {
	PacContent string `json:"pacContent"`
}

type PacResult

type PacResult struct {
	Success      bool                   `json:"success"`
	Messages     []PacValidationMessage `json:"messages"`
	WarningCount int                    `json:"warningCount"`
	ErrorCount   int                    `json:"errorCount"`
}

PacResult represents the result of PAC file validation

func ValidatePacFile

func ValidatePacFile(ctx context.Context, service *zscaler.Service, pacContent string) (*PacResult, error)

type PacValidationMessage

type PacValidationMessage struct {
	Severity  int    `json:"severity"`
	EndLine   int    `json:"endLine"`
	EndColumn int    `json:"endColumn"`
	Line      int    `json:"line"`
	Column    int    `json:"column"`
	Message   string `json:"message"`
	Fatal     bool   `json:"fatal"`
}

PacValidationMessage represents each validation message returned by the API