/repository
Methods
Gets the list of Repositories.
NOTE: The field 'transfer' will only be returned if the type is "remote", running is "true", and the field is requested.
Fields Parameter
Request Parameters
Expand Parameters
mdm (only applies to Mobile repositories. 'typeFields' must be requested)
Example Response
Adds a Repository.
NOTE: See Lumin for Lumin synchronization settings.
NOTE: The fields related to data expiration (activeVulnsLifetime, passiveVulnsLifetime, lceVulnsLifetime, complianceVulnsLifetime, mitigatedVulnsLifetime) only apply to repositories of type "Local".
Request Parameters
Example Response
/repository/{id}
/repository/{uuid}
Methods
Gets the Repository associated with {id} or {uuid}.
NOTE: The field 'transfer' will only be returned if the type is "remote", running is "true", and the field is requested.
Fields Parameter
Request Parameters
None
Expand Parameters
mdm (only applies to Mobile repositories. 'typeFields' must be requested)
Example Response
Edits the Repository associated with {id} or {uuid}, changing only the passed in fields.
NOTE: Parameters 'type', 'dataFormat', and 'mdm' may not be modified on PATCH.
Request Parameters
(All fields are optional)
See /repository::POST for parameters.
Example Response
See /repository/{id}::GET
Deletes the Repository associated with {id} or {uuid}, depending on access and permissions.
Request Parameters
None
Example Response
/repository/{id}/acceptRiskRule
/repository/{uuid}/acceptRiskRule
Methods
Gets the list of Accept Risk Rules in the Repository associated with {id} or {uuid}, unless filters are provided.
Fields Parameter
Filters
Example Response
/repository/{id}/recastRiskRule
/repository/{uuid}/recastRiskRule
Downloads the report associated with {id}.
Request Parameters
None
Example Response
None given. The response will be a PDF, RTF, CSV, ASR, ARF, or LASR file in binary or ascii format.
/repository/{id}/recastRiskRule
/repository/{uuid}/recastRiskRule
Methods
Gets the list of Recast Risk Rules in the Repository associated with {id} or {uuid}, unless filters are provided.
Fields Parameter
Filters
Example Response
/repository/{id}/assetIntersections
/repository/{uuid}/assetIntersections
Gets the ip, uuid, or hostUUID intersections of an Asset.
NOTE: The number of assets should be limited. Intersecting large numbers of assets may be cause long delays, so pagination should be used in F/E
NOTE: The "uuid" json parameter corresponds to the Tenable UUID of the host, and it should not be confused with the UUID of the repository.
NOTE: The "hostUUID json parameter corresponds to the SC generated UUID of the host, and it should not be confused with the UUID of the repository or the Tenable UUID.
Request Parameters
Example Response
/repository/{id}/import
/repository/{uuid}/import
The /repository/import resource.
Starts an on-demand, import for the Repository associated with {id} or {uuid}. The data is specified by a previously uploaded, gzipped tarball of Repository data obtained using /repository/{id}/export or /repository/{uuid}/export.
NOTE: The file field should contain the value of the same parameter passed back on /file/upload::POST.
Request Parameters
Example Response
/repository/{id}/export
/repository/{uuid}/export
The /repository/export resource.
Exports the Repository associated with {id} or {uuid} as a gzipped tar file.
Request Parameters
None
Example Response
None given. The response will be a gzipped file containing a tarball of the Repository files.
The tarball will contain the following contents:
- A Hostname.txt file corresponding to the Tenable.sc from which the repository was exported. This value is populated by the hostname field from the SC License Configuration.
- The license.key file of the Tenable.sc from which the repository was exported.
- An sc.version.txt file with the version, data format, and mdm type on consecutive lines, respectively.
- The binary files corresponding to the Repository's current data.
- A VDB directory containing binary files for the Repository's trending data (if applicable).
/repository/{id}/sync
/repository/{uuid}/sync
The /repository/sync resource.
Starts an on-demand synchronization of local data for the remote Repository associated with {id} or {uuid}.
Request Parameters
None
Example Response
/repository/{id}/updateMobileData
/repository/{uuid}/updateMobileData
The /repository/updateMobileData resource.
Starts an on-demand process to update the mobile data for the Repository associated with {id} or {uuid}. This is considered a mobile scan process by Tenable.sc.
Request Parameters
None
Example Response
/repository/{id}/deviceInfo
/repository/{uuid}/deviceInfo
Gets the device information for the Repository associated with {id} or {uuid}, or {hostUUID}.
Fields Parameter
Request Parameters
Example Response
/repository/{id}/attachment/{attachmentID}
/repository/{uuid}/attachment/{attachmentID}
Downloads the attachment with the given {attachmentID} from the provided repository.
Request Parameters
None
Example Response
None given. The response will be the downloaded file in binary or ascii format.
/repository/authorize
Authorizes communication with the remote machine associated with the provided host ip.
Request Parameters
Example Response
/repository/fetchRemote
The /repository/download resource.
Gets a list of Repositories at the specified location.
NOTE: The /sshKey/installRemoteKey command may need to be used to gain access to the list of repositories at the remote host if it has not been done so previously. An error code of 63 (RESPONSE_DENIED) will indicate if such a request is required.
Request Parameters
Example Response
Expand Items: details, shares
-
details
- Show specific details (such as vulnerability count, nessus schedule information, etc.)
-
shares
- Show the organizations granted access to the Repository.