Nexpose API Guide

340 Pages·2015·1.26 MB·Romanian

Nexpose
API 1.1 and 1.2 Guide
Product version: 6.0
Contents
Contents 2
Revisionhistory 10
Aboutthisguide 11
Documentconventions 11
OtherdocumentsandHelp 12
Fortechnicalsupport 13
Architectureandfunctionality 14
Sites 14
DistributedScanEngines 15
Agentlessoperation 15
Assetgroups 16
SecurityConsole 17
Scanning 18
Device(asset)discovery 18
Reporting 20
Managementanddiagnosticfunctions 20
UsingtheAPI 21
WorkingwithtwoAPIversions 21
SendingAPIrequests 22
APIrequirements 24
APIapplications 24
ThestructureoftheAPIv1.1section 26
ListsofindividualAPIsthatmakeupAPIv1.1 27
SessionManagement 30
Login 30
Contents 2
Logout 31
Sitemanagement 32
SiteListing 32
SiteConfig 32
SiteConfigResponsesample 34
SiteSave 34
SiteSaveResponsesample 37
SiteDelete 37
SiteDeviceListing 38
SiteScanHistory 39
Scanmanagement 43
SiteScan 43
SiteDevicesScan 44
ScanActivity 48
ScanActivityResponsesample 49
ScanPause 49
ScanResume 50
ScanStop 51
ScanStatus 51
ScanStatistics 52
EngineListing 55
EngineActivity 56
Generalmanagementanddiagnosticfunctions 59
ConsoleCommand 59
SystemInformation 59
StartUpdate 61
Contents 3
Restart 62
SendLog 63
Device(asset)management 64
DeviceDelete 64
Assetgroupmanagement 65
AssetGroupListing 65
AssetGroupConfig 65
AssetGroupSave 66
AssetGroupDelete 68
Vulnerabilitymanagement 70
VulnerabilityListing 70
VulnerabilityDetails 71
Reporting 73
ReportTemplateListing 73
ReportTemplateConfig 73
ReportTemplateSave 74
ReportListing 75
ReportHistory 75
ReportConfig 76
ReportSave 77
ReportGenerate 77
ReportDelete 78
ReportAdhocGenerate 78
Usermanagementfunctions 81
UserListing 81
UserAuthenticatorListing 82
Contents 4
UserConfig 83
UserSave 84
UserDelete 85
Generalmanagementanddiagnosticfunctions 87
ConsoleCommand 87
SystemInformation 87
StartUpdate 89
Restart 90
SendLog 91
DTDlistings 92
DeviceDTD 92
SiteSummaryDTD 92
SiteDTD 92
AssetGroupSummaryDTD 96
AssetGroupDTD 97
EngineSummaryDTD 98
ScanConfigDTD 99
ScanSummaryDTD 102
ReportTemplateSummaryDTD 103
ReportTemplateDTD 104
ReportConfigSummaryDTD 105
ReportConfigDTD 106
EmailDTD 109
ReportSummaryDTD 110
UserConfigDTD 111
UserSiteDTD 112
Contents 5
UserGroupDTD 112
UserSummaryDTD 112
AuthenticatorSummaryDTD 113
XMLResponseDTD 113
FailureDTD 114
UsingtheExtendedAPIv1.2section 115
Usingbreadcrumbheadings 115
Validationwithschemas 115
ListsofindividualAPIsthatmakeupExtendedAPIv1.2 116
Sessionmanagement 121
Login 121
Logout 122
Assetdiscoveryconnectionmanagement 123
DiscoveryConnectionCreate 123
DiscoveryConnectionUpdate 125
DiscoveryConnectionListing 127
DiscoveryConnectionDelete 129
DiscoveryConnectionConnect 130
Scanenginemanagement 132
EngineActivity 132
EngineConfig 137
EngineDelete 139
EngineListing 140
EngineSave 143
Ticketmanagement 148
TicketCreate 148
Contents 6
TicketListing 151
TicketDetails 157
TicketDelete 162
Vulnerabilitymanagement 164
VulnerabilityListing 164
VulnerabilityDetails 166
VulnerabilityDetailsResponseexample 170
Vulnerabilityexceptionmanagement 172
PendingVulnExceptionCount 172
VulnerabilityExceptionListing 174
VulnerabilityExceptionCreate 177
VulnerabilityExceptionResubmit 179
VulnerabilityExceptionRecall 181
VulnerabilityExceptionApprove 182
VulnerabilityExceptionReject 183
VulnerabilityExceptionDelete 184
VulnerabilityExceptionUpdateComment 185
VulnerabilityExceptionUpdateCommentRequestattribute 186
VulnerabilityExceptionUpdateExpirationDate 187
VulnerabilityExceptionUpdateExpirationDateRequestexample 187
Multi-Tenantusers 188
MultiTenantUserCreate 188
MultiTenantUserUpdate 195
MultiTenantUserConfig 200
MultiTenantUserDelete 205
SiloProfiles 207
Contents 7
SiloProfileCreate 207
SiloProfileListing 214
SiloProfileUpdate 217
SiloProfileConfig 224
SiloProfileDelete 230
SiloManagement 232
SiloCreate 232
SiloListing 240
SiloConfig 242
SiloUpdate 250
SiloDelete 258
RoleManagement 261
RoleCreate 261
RoleListing 277
RoleDetails 278
RoleUpdate 295
RoleDelete 310
ScanEnginePoolManagement 313
EnginePoolCreate 313
EnginePoolCreateRequestexample 314
EnginePoolCreateResponseattributes 314
EnginePoolListing 315
EnginePoolDetails 316
EnginePoolUpdate 319
EnginePoolDelete 321
Codesamples 323
Contents 8
FundamentalAPIsequence 324
Preliminaries:HTTPSconnectioninitializationexample 324
Loginimplementation 326
Usercreationimplementation 327
Sitecreationimplementation 328
Logoutimplementation 333
Errorresponses 334
Contents 9
Revision history
Copyright©2015Rapid7,LLC.Boston,Massachusetts,USA.Allrightsreserved.Rapid7andNexposearetrademarksof
Rapid7,Inc.Othernamesappearinginthiscontentmaybetrademarksoftheirrespectiveowners.
Forinternaluseonly.
Revisiondate Description
Createdthisguide,whichconsolidatestwoseparateguidesforAPIv1.1and
May16,2012 ExtendedAPIv1.2.Asofthisreleasedate,theprecedingseparateguidesare
deprecated.Madeformattingchangesforimprovedreadability.
August8,2012 Addedinformationonvulnerabilityfiltering.
April17,2013 Correctedformattingerrorsandtypos.
AddedtheManagePolicieselementtotheRoleCreate,RoleCreate
May24,2013 RoleDetailRoleListingandRoleDeleteAPIs.TheuserIDelementhasbeen
addedtotheRoleUpdateRequestexample.
July17,2013 AddeddetailstoAdhocReportConfigAPIandcorrectedformattingerrors.
November13,2013 Correctedformattingissues.
Addedinformationaboutassettaggingsupportinsite,assetgroup,report,
March26,2014
androleAPIs.
July30,2014 Updateddocumentlookandfeel.
October10,2014 Mademinorformattingchanges.
November12,2014 Nexpose5.11: Updatedproductversionforguide.
AddednoteonproperuseofhostandrangeelementsinSiteSaveAPI and
November19,2014
SiteDTD.
Nexpose5.12: Addedinformationaboutnewattributestosupportexpanded
February4,2015
scanscheduling.
ProvidedexamplesformostAPI 1.1calls.ReplacedgraphicalXML samples
March19,2015
withtext-basedsamples.
April8,2015 Nexpose5.13: Addedinformationaboutscanschedulingenhancements.
Nexpose5.14:Addedinformationaboutscanblackouts.See
May27,2015
SiteDevicesScanonpage44.
June24,2015 Nexpose5.15:Updatedproductversion.
July29,2015 Nexpose5.16:Updatedproductversion.
August26,2015 Nexpose5.17:Updatedproductversion.
October8,2015 Nexpose6.0:Updatedproductversion.
Revision history 10