package
1.3.51
Repository: https://github.com/adevinta/vulcan-api.git
Documentation: pkg.go.dev

# Functions

AssetsGlobalStatsPath computes a request path to the assets action of global-stats.
CoverageStatsPath computes a request path to the coverage action of stats.
CreateAPITokenPath computes a request path to the create action of api-token.
CreateAssetAnnotationsPath computes a request path to the create action of asset-annotations.
CreateAssetGroupPath computes a request path to the create action of asset-group.
CreateAssetsPath computes a request path to the create action of assets.
CreateGroupPath computes a request path to the create action of group.
CreateMultiStatusAssetsPath computes a request path to the createMultiStatus action of assets.
CreatePoliciesPath computes a request path to the create action of policies.
CreatePolicySettingsPath computes a request path to the create action of policy-settings.
CreateProgramsPath computes a request path to the create action of programs.
CreateScanPath computes a request path to the create action of scan.
CreateSchedulePath computes a request path to the create action of schedule.
CreateTeamMembersPath computes a request path to the create action of team-members.
CreateTeamsPath computes a request path to the create action of teams.
CreateUserPath computes a request path to the create action of user.
CurrentExposureGlobalStatsPath computes a request path to the current exposure action of global-stats.
CurrentExposureStatsPath computes a request path to the current exposure action of stats.
DeleteAssetAnnotationsPath computes a request path to the delete action of asset-annotations.
DeleteAssetGroupPath computes a request path to the delete action of asset-group.
DeleteAssetsPath computes a request path to the delete action of assets.
DeleteGroupPath computes a request path to the delete action of group.
DeletePoliciesPath computes a request path to the delete action of policies.
DeletePolicySettingsPath computes a request path to the delete action of policy-settings.
DeleteProgramsPath computes a request path to the delete action of programs.
DeleteSchedulePath computes a request path to the delete action of schedule.
DeleteTeamMembersPath computes a request path to the delete action of team-members.
DeleteTeamsPath computes a request path to the delete action of teams.
DeleteUserPath computes a request path to the delete action of user.
DiscoverAssetsPath computes a request path to the discover action of assets.
ExposureGlobalStatsPath computes a request path to the exposure action of global-stats.
ExposureStatsPath computes a request path to the exposure action of stats.
FindFindingFindingsPath computes a request path to the Find finding action of findings.
FindFindingsFromAIssueFindingsPath computes a request path to the Find findings from a Issue action of findings.
FindFindingsFromATargetFindingsPath computes a request path to the Find findings from a Target action of findings.
FixedGlobalStatsPath computes a request path to the fixed action of global-stats.
FixedStatsPath computes a request path to the fixed action of stats.
ListAssetAnnotationsPath computes a request path to the list action of asset-annotations.
ListAssetGroupPath computes a request path to the list action of asset-group.
ListAssetsPath computes a request path to the list action of assets.
ListFindingOverwritesFindingsPath computes a request path to the List Finding Overwrites action of findings.
ListFindingsFindingsPath computes a request path to the list findings action of findings.
ListFindingsIssuesFindingsPath computes a request path to the list findings issues action of findings.
ListFindingsLabelsFindingsPath computes a request path to the List findings labels action of findings.
ListFindingsTargetsFindingsPath computes a request path to the list findings targets action of findings.
ListGroupPath computes a request path to the list action of group.
ListIssuesPath computes a request path to the list action of issues.
ListPoliciesPath computes a request path to the list action of policies.
ListPolicySettingsPath computes a request path to the list action of policy-settings.
ListProgramScansPath computes a request path to the list action of program-scans.
ListProgramsPath computes a request path to the list action of programs.
ListRecipientsPath computes a request path to the list action of recipients.
ListTeamMembersPath computes a request path to the list action of team-members.
ListTeamsPath computes a request path to the list action of teams.
ListTeamsUserPath computes a request path to the list-teams action of user.
ListUserPath computes a request path to the list action of user.
MttrGlobalStatsPath computes a request path to the mttr action of global-stats.
MttrStatsPath computes a request path to the mttr action of stats.
New instantiates the client.
OpenGlobalStatsPath computes a request path to the open action of global-stats.
OpenStatsPath computes a request path to the open action of stats.
ProfileUserPath computes a request path to the profile action of user.
PutAssetAnnotationsPath computes a request path to the put action of asset-annotations.
SendDigestReportPath computes a request path to the send digest action of report.
ShowAssetsPath computes a request path to the show action of assets.
ShowGroupPath computes a request path to the show action of group.
ShowHealthcheckPath computes a request path to the show action of healthcheck.
ShowJobsPath computes a request path to the show action of jobs.
ShowPoliciesPath computes a request path to the show action of policies.
ShowPolicySettingsPath computes a request path to the show action of policy-settings.
ShowProgramsPath computes a request path to the show action of programs.
ShowScanPath computes a request path to the show action of scan.
ShowTeamMembersPath computes a request path to the show action of team-members.
ShowTeamsPath computes a request path to the show action of teams.
ShowUserPath computes a request path to the show action of user.
SubmitAFindingOverwriteFindingsPath computes a request path to the Submit a Finding Overwrite action of findings.
SubmitAFindingTicketCreationFindingsPath computes a request path to the Submit a Finding Ticket Creation action of findings.
UpdateAssetAnnotationsPath computes a request path to the update action of asset-annotations.
UpdateAssetsPath computes a request path to the update action of assets.
UpdateGroupPath computes a request path to the update action of group.
UpdatePoliciesPath computes a request path to the update action of policies.
UpdatePolicySettingsPath computes a request path to the update action of policy-settings.
UpdateProgramsPath computes a request path to the update action of programs.
UpdateRecipientsPath computes a request path to the update action of recipients.
UpdateSchedulePath computes a request path to the update action of schedule.
UpdateTeamMembersPath computes a request path to the update action of team-members.
UpdateTeamsPath computes a request path to the update action of teams.
UpdateUserPath computes a request path to the update action of user.

# Structs

Asset (default view) Identifier: asset; view=default.
AssetAnnotationDeleteRequest user type.
AssetAnnotationRequest user type.
Asset Annotations (default view) Identifier: assetannotations_response; view=default.
Create Assets Errors (default view) Identifier: asseterror; view=default.
Asset group (default view) Identifier: assetgroup; view=default.
AssetGroupPayload user type.
AssetPayload user type.
Asset (default view) Identifier: assetresponse; view=default.
Asset Type (default view) Identifier: assettype; view=default.
AssetUpdatePayload user type.
AssetWithAnnotationsPayload user type.
attachment (default view) Identifier: attachment; view=default.
Client is the Vulcan-API service client.
CreateAssetPayload user type.
Create Assets (default view) Identifier: create_assets; view=default.
Current exposure stats (default view) Identifier: current_exposure; view=default.
DigestPayload user type.
DiscoveredAssetsPayload user type.
Error (default view) Identifier: error; view=default.
Exposure stats (default view) Identifier: exposure; view=default.
Finding (default view) Identifier: finding; view=default.
Finding Overwrite (default view) Identifier: finding_overwrite; view=default.
FindingOverwritePayload user type.
Findings by Issue (default view) Identifier: findings_issue; view=default.
Findings by Issue list (default view) Identifier: findings_issues_list; view=default.
Findings Labels (default view) Identifier: findings_labels; view=default.
Findings list (default view) Identifier: findings_list; view=default.
Findings by Target (default view) Identifier: findings_target; view=default.
Findings by Target list (default view) Identifier: findings_targets_list; view=default.
Finding Ticket (default view) Identifier: finding_ticket; view=default.
FindingTicketPayload user type.
Group (default view) Identifier: group; view=default.
GroupPayload user type.
Group (WithoutAssetsCount view) Identifier: group; view=WithoutAssetsCount.
Healthcheck (default view) Identifier: healthcheck; view=default.
Issue (default view) Identifier: issue; view=default.
Issue list (default view) Identifier: issues_list; view=default.
Job (default view) Identifier: job; view=default.
List Asset Entry (default view) Identifier: listassetentry; view=default.
List asset group (default view) Identifier: listassetgroup; view=default.
MTTR stats (default view) Identifier: mttr; view=default.
Pagination info (default view) Identifier: pagination; view=default.
Policy (default view) Identifier: policy; view=default.
PolicyPayload user type.
Policy Setting (default view) Identifier: policysetting; view=default.
PolicySettingPayload user type.
PolicySettingUploadPayload user type.
PolicyUpdatePayload user type.
Program (default view) Identifier: program; view=default.
ProgramPayload user type.
Program_policy_group media type (default view) Identifier: program_policy_group; view=default.
ProgramPolicyGroupPayload user type.
ProgramUpdatePayload user type.
Recipient (default view) Identifier: recipient; view=default.
RecipientsPayload user type.
resource (default view) Identifier: resource; view=default.
Scan (default view) Identifier: scan; view=default.
ScanPayload user type.
Schedule (default view) Identifier: schedule; view=default.
SchedulePayload user type.
ScheduleUpdatePayload user type.
source (default view) Identifier: source; view=default.
Stats by severity (default view) Identifier: stats; view=default.
Assets by severity stats (default view) Identifier: statsassets; view=default.
Stats by different averages (default view) Identifier: statsaverages; view=default.
Asset Coverage: discovered vs.
Fixed issues stats (default view) Identifier: statsfixed; view=default.
Open issues stats (default view) Identifier: statsopen; view=default.
Stats by severity (default view) Identifier: statstotal; view=default.
target (default view) Identifier: target; view=default.
Team (default view) Identifier: team; view=default.
Team Member (default view) Identifier: teammember; view=default.
TeamMemberPayload user type.
TeamMemberUpdatePayload user type.
TeamPayload user type.
TeamUpdatePayload user type.
Token (default view) Identifier: token; view=default.
Token (metadata view) Identifier: token; view=metadata.
User (default view) Identifier: user; view=default.
UserPayload user type.
UserUpdatePayload user type.

# Type aliases

AssetCollection is the media type for an array of Asset (default view) Identifier: asset; type=collection; view=default.
AsseterrorCollection is the media type for an array of Asseterror (default view) Identifier: asseterror; type=collection; view=default.
AssetresponseCollection is the media type for an array of Assetresponse (default view) Identifier: assetresponse; type=collection; view=default.
FindingCollection is the media type for an array of Finding (default view) Identifier: finding; type=collection; view=default.
Finding_overwriteCollection is the media type for an array of Finding_overwrite (default view) Identifier: finding_overwrite; type=collection; view=default.
Findings_issueCollection is the media type for an array of Findings_issue (default view) Identifier: findings_issue; type=collection; view=default.
Findings_targetCollection is the media type for an array of Findings_target (default view) Identifier: findings_target; type=collection; view=default.
GroupCollection is the media type for an array of Group (default view) Identifier: group; type=collection; view=default.
GroupCollection is the media type for an array of Group (WithoutAssetsCount view) Identifier: group; type=collection; view=WithoutAssetsCount.
IssueCollection is the media type for an array of Issue (default view) Identifier: issue; type=collection; view=default.
ListassetentryCollection is the media type for an array of Listassetentry (default view) Identifier: listassetentry; type=collection; view=default.
PolicyCollection is the media type for an array of Policy (default view) Identifier: policy; type=collection; view=default.
PolicysettingCollection is the media type for an array of Policysetting (default view) Identifier: policysetting; type=collection; view=default.
ProgramCollection is the media type for an array of Program (default view) Identifier: program; type=collection; view=default.
RecipientCollection is the media type for an array of Recipient (default view) Identifier: recipient; type=collection; view=default.
ScanCollection is the media type for an array of Scan (default view) Identifier: scan; type=collection; view=default.
TeamCollection is the media type for an array of Team (default view) Identifier: team; type=collection; view=default.
TeammemberCollection is the media type for an array of Teammember (default view) Identifier: teammember; type=collection; view=default.
UserCollection is the media type for an array of User (default view) Identifier: user; type=collection; view=default.