@Path(value="/orgs") @Consumes(value="application/json") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") public interface OrgResource extends Serializable
| Modifier and Type | Method and Description |
|---|---|
DNSRecordResponse |
addDNSRecord(String orgUuid,
DNSRecordCreateRequest record)
Add a new DNS record for the given organization.
|
DNSZoneResponse |
addDNSZone(String orgUuid,
DNSZoneCreateRequest zoneSpec)
Add a new managed DNS zone for the given organization.
|
TaskResponse |
batchFailover(String orgUuid,
BatchFailoverParamsRequest params)
Initiates a batch live failover on one or more VPGs withing an org.
|
TaskResponse |
batchFailoverTest(String orgUuid,
BatchFailoverTestParamsRequest params)
Batch test failover for one or more VPGs within an org.
|
CheckDNSZoneResponse |
checkDNSZone(String orgUuid,
int zoneId)
Check a managed DNS Zone for Validity and report errors.
|
TaskResponse |
createCatalog(String orgUuid,
CatalogCreateRequest request)
Create a catalog in the organization.
|
DisasterRecoveryRunbookResponse |
createRecoveryRunbook(String orgUuid,
DisasterRecoveryRunbookCreateRequest spec)
Add a runbook to the given organizations runbooks.
|
void |
deleteDNSRecord(String orgUuid,
int recordId)
Delete a DNS record for the given organization.
|
void |
deleteDNSZone(String orgUuid,
int zoneId)
Delete a DNS zone for the given organization and zone ID.
|
IPAddressSetResponse |
getAvailableIPsForPTRRecords(String orgUuid)
Get the set of IP addresses that are not mapped to PTR DNS records yet.
|
BandwidthUsageSummaryResponse |
getBandwidthUsageSummary(String orgUuid,
Integer month,
Integer year)
Returns the summary of bandwidth usage, and current reservation for the
given month and year.
|
BillResponse |
getBilling(String orgUuid,
Integer year,
Integer month)
Returns Org Billing for a given invoice period.
|
CurrencyCodeResponse |
getBillingCurrencyCode(String orgUuid)
Returns Org Billing Currency Code.
|
CatalogListResponse |
getCatalogsForOrg(String orgUuid)
Get catalogs associated with the given organization.
|
OrgBillingByVdcResponse |
getCurrentBillingByVdc(String orgUuid)
Get current org billing broken down by Vdc.
|
DNSRecordListResponse |
getDNSRecords(String orgUuid)
Get the DNS records associated with the given organization.
|
OrgDNSZoneListResponse |
getDNSZones(String orgUuid)
Get the managed DNS zones associated with the given organization.
|
NetworkPerfSampleSerieListResponse |
getEdgeNetworkUsageOverTime(String orgUuid,
String type,
Long start,
Long end)
Gets usage data for a VCD edge gateway.
|
NetworkPerfSampleSerieListResponse |
getEdgeNetworkUsageSummary(String orgUuid,
String type,
Long start,
Long end)
Gets a vCD edge gateway usage summary, summarizing the total bandwidth used
for both inbound and outbound edge network traffic.
|
EdgeListResponse |
getEdgesForOrg(String orgUuid)
Get the vcd edges for the organization.
|
OrgExpiredItemsResponse |
getExpiredItems(String orgUuid) |
NetworkPerfSampleSerieListResponse |
getExternalNetworkSummaryFor(String orgUuid,
String type,
Long start,
Long end)
Get external network usage summary for the given organization and type.
|
NetworkPerfSampleSerieListResponse |
getExternalNetworkUsageFor(String orgUuid,
String type,
Long start,
Long end)
Get external network usage for the given organization and type.
|
BillListResponse |
getHistoricalBilling(String orgUuid,
Long start,
Long end)
Get historical org billing.
|
OrgVdcBillsListResponse |
getHistoricalBillingByVdc(String orgUuid,
Integer startYear,
Integer startMonth,
Integer endYear,
Integer endMonth)
Get a list of vDC bills for a given org between the given date ranges.
|
MediaListResponse |
getMedias(String orgUuid)
Get medias for a given Org.
|
NessusScanOptOutResponse |
getNessusScanOptOutPreferences(String orgUuid)
Get the nessus scan opt out details for the given org.
|
NessusScanDetailsResponse |
getNessusScanResult(String orgUuid,
String scanResultUuid)
Get the scan details for a given organization and a scan UUID.
|
NessusScanListResponse |
getNessusScanResultsForTemplate(String orgUuid,
int scanTemplateId,
Integer offset,
Integer limit)
Get a list of all scans with given ID that are in a given organization.
|
NessusScanListResponse |
getNessusScanTemplates(String orgUuid,
Integer offset,
Integer limit)
Get a list of all scans for a given organization.
|
NetworkPerfSampleSerieListResponse |
getNetSummaryFor(String orgUuid,
String type,
Long start,
Long end)
Get network usage summary for the given organization and type.
|
NetworkPerfSampleSerieListResponse |
getNetUsageFor(String orgUuid,
String type,
Long start,
Long end)
Get network usage for the given organization and type.
|
OrgResponse |
getOrg(String orgUuid)
Get an organization given its uuid.
|
PublicIpAssignmentListResponse |
getOrgPublicIpAssignments(String orgUuid)
Gets the public IP assignments for the organization.
|
IPAddressSetResponse |
getOrgPublicIps(String orgUuid)
Gets the public IPs for the organization.
|
OrgVdcNetworkListResponse |
getOrgVdcNetworksForOrg(String orgUuid)
Get the org vdc networks for the organization.
|
DisasterRecoveryRunbookListResponse |
getRecoveryRunbooks(String orgUuid)
Get the list of recovery runbooks for a given organization.
|
VappNetworkListResponse |
getVappNetworksForOrg(String orgUuid)
Get the vapp networks for the organization.
|
VappListResponse |
getVappsForOrg(String orgUuid)
Get the vApps for the organization.
|
VappTemplateListResponse |
getVappTemplatesForOrg(String orgUuid)
Get vapp templates for a given organization.
|
VccFailoverPlanListResponse |
getVccFailoverPlans(String orgUuid)
Returns the list of VCC-R failover plans for a given target vCloud
Organization.
|
BillingSampleSerieListResponse |
getVdcCostOverInvoicePeriodSeries(String orgUuid,
Integer year,
Integer month,
List<String> additionalFields)
Get a list of series detailing the hourly cost over an invoice period for
all vDCs in a given Organization.
|
VdcListResponse |
getVdcsForOrg(String orgUuid)
Get the virtual data centers (VDCs) for the given organization.
|
VmListResponse |
getVmsForOrg(String orgUuid)
Get the VMs for the organization.
|
ExpandedVpgListResponse |
getVpgsForOrg(String orgUuid,
List<VpgSubEntityRequest> expand)
Returns the list of VPGs for a given target vCloud Organization.
|
VpgsProtectionInfoResponse |
getVpgsProtectionSummary(String orgUuid)
Returns a VPGs protection info.
|
IsComplianceOrgResponse |
isComplianceOrg(String orgUuid)
Return whether an org is a compliance organization.
|
NessusLaunchResponse |
launchNessusScan(String orgUuid,
int scanTemplateId)
Launch a nessus scan given an organization uuid and a scan id.
|
void |
pauseNessusScan(String orgUuid,
int scanTemplateId)
Pause a nessus scan given an organization uuid and a scan id.
|
void |
resumeNessusScan(String orgUuid,
int scanTemplateId)
Resume a nessus scan given an organization uuid and a scan id.
|
void |
sendEventHistory(String orgUuid,
EventHistoryEmailRequest spec)
Email a CSV report with all event history for a given Org.
|
void |
stopNessusScan(String orgUuid,
int scanTemplateId)
Stop a nessus scan given an organization uuid and a scan id.
|
DNSRecordResponse |
updateDNSRecord(String orgUuid,
int recordId,
DNSRecordUpdateRequest record)
Update a DNS record for the given organization.
|
NessusScanOptOutResponse |
updateNessusScanOptOutPreferences(String orgUuid,
NessusScanOptOutCreateRequest request)
Update a set of ip addresses or ranges to opt out of weekly Nessus scans
for a given org.
|
NessusScanUpdateResponse |
updateNessusScanTemplate(String orgUuid,
int scanTemplateId,
NessusScanUpdateRequest spec)
Update a scan given an organization and the scan ID.
|
OrgResponse |
updateOrgVappLeaseSettings(String orgUuid,
OrgVappLeaseUpdateRequest spec)
Update the org / vapp lease settings section for a given org.
|
OrgResponse |
updateOrgVappTemplateLeaseSettings(String orgUuid,
OrgVappTemplateLeaseUpdateRequest spec)
Update the org / vapp template lease settings section for a given org.
|
@GET
@Path(value="/{orgUuid}")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
OrgResponse getOrg(@PathParam(value="orgUuid")
String orgUuid)
orgUuid - org uuid@GET
@Path(value="/{orgUuid}/vdcs")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VdcListResponse getVdcsForOrg(@PathParam(value="orgUuid")
String orgUuid)
orgUuid - org uuid@GET
@Path(value="/{orgUuid}/vapps")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VappListResponse getVappsForOrg(@PathParam(value="orgUuid")
String orgUuid)
orgUuid - org uuid@GET
@Path(value="/{orgUuid}/vms")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VmListResponse getVmsForOrg(@PathParam(value="orgUuid")
String orgUuid)
orgUuid - org uuid@GET
@Path(value="/{orgUuid}/org-vdc-networks")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
OrgVdcNetworkListResponse getOrgVdcNetworksForOrg(@PathParam(value="orgUuid")
String orgUuid)
orgUuid - org uuid@GET
@Path(value="/{orgUuid}/edges")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
EdgeListResponse getEdgesForOrg(@PathParam(value="orgUuid")
String orgUuid)
orgUuid - org uuid@GET
@Path(value="/{orgUuid}/vapp-networks")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VappNetworkListResponse getVappNetworksForOrg(@PathParam(value="orgUuid")
String orgUuid)
orgUuid - org uuid@GET
@Path(value="/{orgUuid}/unmapped-dns-ptr-ip-addresses")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
IPAddressSetResponse getAvailableIPsForPTRRecords(@PathParam(value="orgUuid")
String orgUuid)
orgUuid - org uuid@GET
@Path(value="/{orgUuid}/dns-records")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
DNSRecordListResponse getDNSRecords(@PathParam(value="orgUuid")
String orgUuid)
orgUuid - org uuid@POST
@Path(value="/{orgUuid}/dns-records")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
DNSRecordResponse addDNSRecord(@PathParam(value="orgUuid")
String orgUuid,
DNSRecordCreateRequest record)
orgUuid - org uuidrecord - dns record@GET
@Path(value="/{orgUuid}/dns-zones")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
OrgDNSZoneListResponse getDNSZones(@PathParam(value="orgUuid")
String orgUuid)
orgUuid - org uuid@POST
@Path(value="/{orgUuid}/dns-zones")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
DNSZoneResponse addDNSZone(@PathParam(value="orgUuid")
String orgUuid,
DNSZoneCreateRequest zoneSpec)
orgUuid - org uuidzoneSpec - dns zone spec@GET
@Path(value="/{orgUuid}/dns-zones/{zoneId}/is-valid")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
CheckDNSZoneResponse checkDNSZone(@PathParam(value="orgUuid")
String orgUuid,
@PathParam(value="zoneId")
int zoneId)
orgUuid - org uuidzoneId - zoneId@DELETE
@Path(value="/{orgUuid}/dns-zones/{zoneId}")
void deleteDNSZone(@PathParam(value="orgUuid")
String orgUuid,
@PathParam(value="zoneId")
int zoneId)
orgUuid - org uuidzoneId - dns zone id@PUT
@Path(value="/{orgUuid}/dns-records/{recordId}")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
DNSRecordResponse updateDNSRecord(@PathParam(value="orgUuid")
String orgUuid,
@PathParam(value="recordId")
int recordId,
DNSRecordUpdateRequest record)
orgUuid - org uuidrecordId - the DNS record IDrecord - dns record@DELETE
@Path(value="/{orgUuid}/dns-records/{recordId}")
void deleteDNSRecord(@PathParam(value="orgUuid")
String orgUuid,
@PathParam(value="recordId")
int recordId)
orgUuid - org uuidrecordId - dns record id to delete@GET
@Path(value="/{orgUuid}/catalogs")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
CatalogListResponse getCatalogsForOrg(@PathParam(value="orgUuid")
String orgUuid)
orgUuid - org uuid@GET
@Path(value="/{orgUuid}/vapp-templates")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VappTemplateListResponse getVappTemplatesForOrg(@PathParam(value="orgUuid")
String orgUuid)
orgUuid - org uuid@GET
@Path(value="/{orgUuid}/billing")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
BillResponse getBilling(@PathParam(value="orgUuid")
String orgUuid,
@QueryParam(value="year")
Integer year,
@QueryParam(value="month")
Integer month)
If month and year are not explicitly supplied the current invoice period is used.
orgUuid - org uuidyear - the invoice period year (defaults to current year)month - the invoice period month (defaults to the current month) must
be in range 1-12@GET
@Path(value="/{orgUuid}/billing-by-vdc")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
OrgBillingByVdcResponse getCurrentBillingByVdc(@PathParam(value="orgUuid")
String orgUuid)
orgUuid - org uuid@GET
@Path(value="/{orgUuid}/historical-billing")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
BillListResponse getHistoricalBilling(@PathParam(value="orgUuid")
String orgUuid,
@QueryParam(value="start")
Long start,
@QueryParam(value="end")
Long end)
orgUuid - org uuidstart - startend - end@POST
@Path(value="/{orgUuid}/actions/email-event-history")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
void sendEventHistory(@PathParam(value="orgUuid")
String orgUuid,
EventHistoryEmailRequest spec)
orgUuid - org uuidspec - email address spec@POST
@Path(value="/{orgUuid}/actions/update-vapp-lease-settings")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
OrgResponse updateOrgVappLeaseSettings(@PathParam(value="orgUuid")
String orgUuid,
OrgVappLeaseUpdateRequest spec)
orgUuid - org uuidspec - specification for updating org vapp lease settings@POST
@Path(value="/{orgUuid}/actions/update-vapp-template-lease-settings")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
OrgResponse updateOrgVappTemplateLeaseSettings(@PathParam(value="orgUuid")
String orgUuid,
OrgVappTemplateLeaseUpdateRequest spec)
orgUuid - org uuidspec - specification for updating org vapp template lease settings@GET
@Path(value="/{orgUuid}/medias")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
MediaListResponse getMedias(@PathParam(value="orgUuid")
String orgUuid)
orgUuid - org uuid@GET
@Path(value="/{orgUuid}/is-compliance-org")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
IsComplianceOrgResponse isComplianceOrg(@PathParam(value="orgUuid")
String orgUuid)
orgUuid - organization uuid@POST
@Path(value="/{orgUuid}/catalog")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse createCatalog(@PathParam(value="orgUuid")
String orgUuid,
CatalogCreateRequest request)
orgUuid - organization uuidrequest - request for new catalog@GET
@Path(value="/{orgUuid}/billing-currency-code")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
CurrencyCodeResponse getBillingCurrencyCode(@PathParam(value="orgUuid")
String orgUuid)
Will return one of the following currency codes:
orgUuid - org uuid@GET
@Path(value="/{orgUuid}/public-ip-assignments")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
PublicIpAssignmentListResponse getOrgPublicIpAssignments(@PathParam(value="orgUuid")
String orgUuid)
orgUuid - org uuid@GET
@Path(value="/{orgUuid}/public-ips")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
IPAddressSetResponse getOrgPublicIps(@PathParam(value="orgUuid")
String orgUuid)
orgUuid - org uuid@GET
@Path(value="/{orgUuid}/vpgs")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
ExpandedVpgListResponse getVpgsForOrg(@PathParam(value="orgUuid")
String orgUuid,
@QueryParam(value="expand")
List<VpgSubEntityRequest> expand)
orgUuid - org uuid@GET
@Path(value="/{orgUuid}/vpgs-protection-info")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VpgsProtectionInfoResponse getVpgsProtectionSummary(@PathParam(value="orgUuid")
String orgUuid)
orgUuid - org uuidVpgsProtectionInfoResponse the VPGs protection info@GET
@Path(value="/{orgUuid}/vcc-failover-plans")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VccFailoverPlanListResponse getVccFailoverPlans(@PathParam(value="orgUuid")
String orgUuid)
orgUuid - org uuid@POST
@Path(value="/{orgUuid}/actions/vpg-batch-failover-test")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse batchFailoverTest(@PathParam(value="orgUuid")
String orgUuid,
BatchFailoverTestParamsRequest params)
params - the batch failover test parametersorgUuid - the uuid of the organization that the vpgs belong to@POST
@Path(value="/{orgUuid}/actions/vpg-batch-failover")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse batchFailover(@PathParam(value="orgUuid")
String orgUuid,
BatchFailoverParamsRequest params)
params - the batch failover parametersorgUuid - the uuid of the organization that the vpgs belong to@GET
@Path(value="/{orgUuid}/expired-items")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
OrgExpiredItemsResponse getExpiredItems(@PathParam(value="orgUuid")
String orgUuid)
@GET
@Path(value="/{orgUuid}/bandwidth-usage-summary")
BandwidthUsageSummaryResponse getBandwidthUsageSummary(@PathParam(value="orgUuid")
String orgUuid,
@QueryParam(value="month")
Integer month,
@QueryParam(value="year")
Integer year)
All bandwidth units are GB.
orgUuid - the UUID of the organization for which bandwidth summary is
returnedmonth - the month to return bandwidth summary for. The valid values
for the month query parameter are 1-12.year - the year to return bandwidth summary for@GET
@Path(value="/{orgUuid}/vdcs-cost-over-invoice-period")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
BillingSampleSerieListResponse getVdcCostOverInvoicePeriodSeries(@PathParam(value="orgUuid")
String orgUuid,
@QueryParam(value="year")
Integer year,
@QueryParam(value="month")
Integer month,
@QueryParam(value="additionalFields")
List<String> additionalFields)
orgUuid - the UUID of the organizationyear - the yearmonth - the month in range 1-12additionalFields - additional bill fields that should be included in
the series@GET
@Path(value="/{orgUuid}/historical-billing-by-vdc")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
OrgVdcBillsListResponse getHistoricalBillingByVdc(@PathParam(value="orgUuid")
String orgUuid,
@QueryParam(value="startYear")
Integer startYear,
@QueryParam(value="startMonth")
Integer startMonth,
@QueryParam(value="endYear")
Integer endYear,
@QueryParam(value="endMonth")
Integer endMonth)
orgUuid - the UUID of the organizationstartYear - the start yearstartMonth - the start month (must be in range of 1-12)endYear - the end yearendMonth - the end month (must be in range of 1-12)@GET
@Path(value="/{orgUuid}/external-network-usage")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
NetworkPerfSampleSerieListResponse getExternalNetworkUsageFor(@PathParam(value="orgUuid")
String orgUuid,
@QueryParam(value="type")
String type,
@QueryParam(value="start")
Long start,
@QueryParam(value="end")
Long end)
orgUuid - org uuidtype - typestart - start dateend - end date@GET
@Path(value="/{orgUuid}/external-network-summation")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
NetworkPerfSampleSerieListResponse getExternalNetworkSummaryFor(@PathParam(value="orgUuid")
String orgUuid,
@QueryParam(value="type")
String type,
@QueryParam(value="start")
Long start,
@QueryParam(value="end")
Long end)
orgUuid - org uuidtype - typestart - start dateend - end date@GET
@Path(value="/{orgUuid}/bandwidth-usage")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
NetworkPerfSampleSerieListResponse getNetUsageFor(@PathParam(value="orgUuid")
String orgUuid,
@QueryParam(value="type")
String type,
@QueryParam(value="start")
Long start,
@QueryParam(value="end")
Long end)
orgUuid - org uuidtype - typestart - start dateend - end date@GET
@Path(value="/{orgUuid}/bandwidth-summation")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
NetworkPerfSampleSerieListResponse getNetSummaryFor(@PathParam(value="orgUuid")
String orgUuid,
@QueryParam(value="type")
String type,
@QueryParam(value="start")
Long start,
@QueryParam(value="end")
Long end)
orgUuid - org uuidtype - typestart - start dateend - end date@POST
@Path(value="/{orgUuid}/nessus-scan-templates/{scanTemplateId}/actions/launch-scan")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
NessusLaunchResponse launchNessusScan(@PathParam(value="orgUuid")
String orgUuid,
@PathParam(value="scanTemplateId")
int scanTemplateId)
Will only successfully queue scan launch if that scan is not currently in progress.
orgUuid - org uuidscanTemplateId - nessus scan id@POST
@Path(value="/{orgUuid}/nessus-scan-templates/{scanTemplateId}/actions/pause-scan")
void pauseNessusScan(@PathParam(value="orgUuid")
String orgUuid,
@PathParam(value="scanTemplateId")
int scanTemplateId)
Will only successfully pause scan if that scan is currently running.
orgUuid - org uuidscanTemplateId - nessus scan id@POST
@Path(value="/{orgUuid}/nessus-scan-templates/{scanTemplateId}/actions/stop-scan")
void stopNessusScan(@PathParam(value="orgUuid")
String orgUuid,
@PathParam(value="scanTemplateId")
int scanTemplateId)
Will only successfully stop scan if that scan is currently running.
orgUuid - org uuidscanTemplateId - nessus scan id@POST
@Path(value="/{orgUuid}/nessus-scan-templates/{scanTemplateId}/actions/resume-scan")
void resumeNessusScan(@PathParam(value="orgUuid")
String orgUuid,
@PathParam(value="scanTemplateId")
int scanTemplateId)
Will only successfully resume scan if that scan is currently paused.
orgUuid - org uuidscanTemplateId - nessus scan id@GET
@Path(value="/{orgUuid}/nessus-scan-templates")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
NessusScanListResponse getNessusScanTemplates(@PathParam(value="orgUuid")
String orgUuid,
@QueryParam(value="offset")
Integer offset,
@QueryParam(value="limit")
Integer limit)
orgUuid - org uuidoffset - the offset of the first scan to retrievelimit - the limit of the number of scans to retrieve@GET
@Path(value="/{orgUuid}/nessus-scan-templates/{scanTemplateId}/nessus-scan-results")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
NessusScanListResponse getNessusScanResultsForTemplate(@PathParam(value="orgUuid")
String orgUuid,
@PathParam(value="scanTemplateId")
int scanTemplateId,
@QueryParam(value="offset")
Integer offset,
@QueryParam(value="limit")
Integer limit)
This will only return all the scans with the given ID.
orgUuid - org uuidoffset - the offset of the first scan to retrievelimit - the limit of the number of scans to retrieve@GET
@Path(value="/{orgUuid}/nessus-scans-results/{scanResultUuid}")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
NessusScanDetailsResponse getNessusScanResult(@PathParam(value="orgUuid")
String orgUuid,
@PathParam(value="scanResultUuid")
String scanResultUuid)
Scan uuid is different than scan id: scan uuid points to a specific scan where scan ID points to the tbplate the scan was run from.
orgUuid - org uuid@PUT
@Path(value="/{orgUuid}/nessus-scan-templates/{scanTemplateId}")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
NessusScanUpdateResponse updateNessusScanTemplate(@PathParam(value="orgUuid")
String orgUuid,
@PathParam(value="scanTemplateId")
int scanTemplateId,
NessusScanUpdateRequest spec)
The following options are availble to configure:
orgUuid - org uuidscanTemplateId - scan template idspec - specification for updating the scan@GET
@Path(value="/{orgUuid}/edge-network-usage-summary")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
NetworkPerfSampleSerieListResponse getEdgeNetworkUsageSummary(@PathParam(value="orgUuid")
String orgUuid,
@QueryParam(value="type")
String type,
@QueryParam(value="start")
Long start,
@QueryParam(value="end")
Long end)
If no start/end dates are provided it will default to the latest hour range. If you pass a custom time range both start and end date must be passed together
orgUuid - UUID of the parent organizationtype - typestart - start dateend - end date@GET
@Path(value="/{orgUuid}/edge-network-usage-over-time")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
NetworkPerfSampleSerieListResponse getEdgeNetworkUsageOverTime(@PathParam(value="orgUuid")
String orgUuid,
@QueryParam(value="type")
String type,
@QueryParam(value="start")
Long start,
@QueryParam(value="end")
Long end)
orgUuid - UUID of the parent organizationtype - typestart - start dateend - end date@GET
@Path(value="/{orgUuid}/disaster-recovery-runbooks")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
DisasterRecoveryRunbookListResponse getRecoveryRunbooks(@PathParam(value="orgUuid")
String orgUuid)
orgUuid - the organization UUID@POST
@Path(value="/{orgUuid}/disaster-recovery-runbooks")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
DisasterRecoveryRunbookResponse createRecoveryRunbook(@PathParam(value="orgUuid")
String orgUuid,
DisasterRecoveryRunbookCreateRequest spec)
orgUuid - the organization UUIDspec - the specification for the new recovery runbook@POST
@Path(value="/{orgUuid}/actions/update-nessus-scan-opt-out-preferences")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
NessusScanOptOutResponse updateNessusScanOptOutPreferences(@PathParam(value="orgUuid")
String orgUuid,
NessusScanOptOutCreateRequest request)
request - nessus scan opt out details@GET
@Path(value="/{orgUuid}/nessus-scan-opt-out-preferences")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
NessusScanOptOutResponse getNessusScanOptOutPreferences(@PathParam(value="orgUuid")
String orgUuid)
orgUuid - String org uuidCopyright © 2020 iland Internet Solutions, Corp. All rights reserved.