com.iland.core.web.rest.api

Interface OrgResource

@Path(value="/orgs")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface OrgResource

Org Resource Interface V1.

Author:

Cory Snyder

Method Summary

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.
BackupPolicyResponse	createBackupPolicy(String orgUuid, BackupPolicyUpdateRequest creationRequest) Create a new org-scoped backup policy.
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	deleteBackupPolicy(String orgUuid, String backupPolicyUid) Delete a backup policy.
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.
OrgBackupSummaryStatsResponse	getBackupGroupSummaryStats(String orgUuid) Gets backup group summary stats for the Org.
BackupPolicyResponse	getBackupPolicy(String orgUuid, String backupPolicyUid) Get details of an individual org-scoped backup policy.
OrgBackupStatusResponse	getBackupStatus(String orgUuid) Gets the org's backup status.
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) Get the expired vapp and vapp templates for the given org.
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.
BackupGroupListResponse	listBackupGroups(String orgUuid, boolean includeDeleted, boolean includeSummaryStats, boolean includeLastRun, boolean includeBackupPolicy) List the existing backup groups that are configured in a specified organization.
BackupPolicyListResponse	listBackupPolicies(String orgUuid, boolean includeVdcScopedPolicies) List the existing backup policies that are configured in an organization.
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.
BackupPolicyResponse	updateBackupPolicy(String orgUuid, String backupPolicyUid, BackupPolicyUpdateRequest updateRequest) Update a backup policy.
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.

Method Detail

getOrg

@GET
 @Path(value="/{orgUuid}")
OrgResponse getOrg(@PathParam(value="orgUuid")
                                                   String orgUuid)

Get an organization given its uuid.

Parameters:

orgUuid - org uuid

Returns:

organization

getVdcsForOrg

@GET
 @Path(value="/{orgUuid}/vdcs")
VdcListResponse getVdcsForOrg(@PathParam(value="orgUuid")
                                                                   String orgUuid)

Get the virtual data centers (VDCs) for the given organization.

Parameters:

orgUuid - org uuid

Returns:

a list of virtual data centers

getVappsForOrg

@GET
 @Path(value="/{orgUuid}/vapps")
VappListResponse getVappsForOrg(@PathParam(value="orgUuid")
                                                                      String orgUuid)

Get the vApps for the organization.

Parameters:

orgUuid - org uuid

Returns:

a list of virtual applications

getVmsForOrg

@GET
 @Path(value="/{orgUuid}/vms")
VmListResponse getVmsForOrg(@PathParam(value="orgUuid")
                                                                String orgUuid)

Get the VMs for the organization.

Parameters:

orgUuid - org uuid

Returns:

a list of virtual machines

getOrgVdcNetworksForOrg

@GET
 @Path(value="/{orgUuid}/org-vdc-networks")
OrgVdcNetworkListResponse getOrgVdcNetworksForOrg(@PathParam(value="orgUuid")
                                                                                                   String orgUuid)

Get the org vdc networks for the organization.

Parameters:

orgUuid - org uuid

Returns:

a list of org vdc networks

getEdgesForOrg

@GET
 @Path(value="/{orgUuid}/edges")
EdgeListResponse getEdgesForOrg(@PathParam(value="orgUuid")
                                                                      String orgUuid)

Get the vcd edges for the organization.

Parameters:

orgUuid - org uuid

Returns:

a list of vcd edges

getVappNetworksForOrg

@GET
 @Path(value="/{orgUuid}/vapp-networks")
VappNetworkListResponse getVappNetworksForOrg(@PathParam(value="orgUuid")
                                                                                            String orgUuid)

Get the vapp networks for the organization.

Parameters:

orgUuid - org uuid

Returns:

a list of vapp networks

getAvailableIPsForPTRRecords

@GET
 @Path(value="/{orgUuid}/unmapped-dns-ptr-ip-addresses")
IPAddressSetResponse getAvailableIPsForPTRRecords(@PathParam(value="orgUuid")
                                                                                                                String orgUuid)

Get the set of IP addresses that are not mapped to PTR DNS records yet.

Parameters:

orgUuid - org uuid

Returns:

set of IP addresses that have no PTR record mapping

getDNSRecords

@GET
 @Path(value="/{orgUuid}/dns-records")
DNSRecordListResponse getDNSRecords(@PathParam(value="orgUuid")
                                                                                String orgUuid)

Get the DNS records associated with the given organization.

Parameters:

orgUuid - org uuid

Returns:

list of DNS records for the organization

addDNSRecord

@POST
 @Path(value="/{orgUuid}/dns-records")
 @Consumes(value="application/json")
DNSRecordResponse addDNSRecord(@PathParam(value="orgUuid")
                                                                                                                 String orgUuid,
                                                                                                                 DNSRecordCreateRequest record)

Add a new DNS record for the given organization.

Parameters:

orgUuid - org uuid

record - dns record

Returns:

new DNS record

getDNSZones

@GET
 @Path(value="/{orgUuid}/dns-zones")
OrgDNSZoneListResponse getDNSZones(@PathParam(value="orgUuid")
                                                                             String orgUuid)

Get the managed DNS zones associated with the given organization.

Parameters:

orgUuid - org uuid

Returns:

list of managed DNS zones for the organization

addDNSZone

@POST
 @Path(value="/{orgUuid}/dns-zones")
 @Consumes(value="application/json")
DNSZoneResponse addDNSZone(@PathParam(value="orgUuid")
                                                                                                           String orgUuid,
                                                                                                           DNSZoneCreateRequest zoneSpec)

Add a new managed DNS zone for the given organization.

Parameters:

orgUuid - org uuid

zoneSpec - dns zone spec

Returns:

new DNS zone

checkDNSZone

@GET
 @Path(value="/{orgUuid}/dns-zones/{zoneId}/is-valid")
CheckDNSZoneResponse checkDNSZone(@PathParam(value="orgUuid")
                                                                                              String orgUuid,
                                                                                              @PathParam(value="zoneId")
                                                                                              int zoneId)

Check a managed DNS Zone for Validity and report errors.

Parameters:

orgUuid - org uuid

zoneId - zoneId

Returns:

dns zone check result

deleteDNSZone

@DELETE
 @Path(value="/{orgUuid}/dns-zones/{zoneId}")
void deleteDNSZone(@PathParam(value="orgUuid")
                                                                         String orgUuid,
                                                                         @PathParam(value="zoneId")
                                                                         int zoneId)

Delete a DNS zone for the given organization and zone ID.

Parameters:

orgUuid - org uuid

zoneId - dns zone id

updateDNSRecord

@PUT
 @Path(value="/{orgUuid}/dns-records/{recordId}")
 @Consumes(value="application/json")
DNSRecordResponse updateDNSRecord(@PathParam(value="orgUuid")
                                                                                                                              String orgUuid,
                                                                                                                              @PathParam(value="recordId")
                                                                                                                              int recordId,
                                                                                                                              DNSRecordUpdateRequest record)

Update a DNS record for the given organization.

Parameters:

orgUuid - org uuid

recordId - the DNS record ID

record - dns record

Returns:

updated DNS record

deleteDNSRecord

@DELETE
 @Path(value="/{orgUuid}/dns-records/{recordId}")
void deleteDNSRecord(@PathParam(value="orgUuid")
                                                                               String orgUuid,
                                                                               @PathParam(value="recordId")
                                                                               int recordId)

Delete a DNS record for the given organization.

Parameters:

orgUuid - org uuid

recordId - dns record id to delete

getCatalogsForOrg

@GET
 @Path(value="/{orgUuid}/catalogs")
CatalogListResponse getCatalogsForOrg(@PathParam(value="orgUuid")
                                                                               String orgUuid)

Get catalogs associated with the given organization.

Parameters:

orgUuid - org uuid

Returns:

list of catalogs for the organization

getVappTemplatesForOrg

@GET
 @Path(value="/{orgUuid}/vapp-templates")
VappTemplateListResponse getVappTemplatesForOrg(@PathParam(value="orgUuid")
                                                                                               String orgUuid)

Get vapp templates for a given organization.

Parameters:

orgUuid - org uuid

Returns:

list of vapp templates for the given organization

getBilling

@GET
 @Path(value="/{orgUuid}/billing")
BillResponse getBilling(@PathParam(value="orgUuid")
                                                                String orgUuid,
                                                                @QueryParam(value="year")
                                                                Integer year,
                                                                @QueryParam(value="month")
                                                                Integer month)

Returns Org Billing for a given invoice period.

If month and year are not explicitly supplied the current invoice period is used.

Parameters:

orgUuid - org uuid

year - the invoice period year (defaults to current year)

month - the invoice period month (defaults to the current month) must be in range 1-12

Returns:

billing for the organization and given invoice period

getCurrentBillingByVdc

@GET
 @Path(value="/{orgUuid}/billing-by-vdc")
OrgBillingByVdcResponse getCurrentBillingByVdc(@PathParam(value="orgUuid")
                                                                                              String orgUuid)

Get current org billing broken down by Vdc.

Parameters:

orgUuid - org uuid

Returns:

current billing for the organization broken down by VDC

getHistoricalBilling

@GET
 @Path(value="/{orgUuid}/historical-billing")
BillListResponse getHistoricalBilling(@PathParam(value="orgUuid")
                                                                                         String orgUuid,
                                                                                         @QueryParam(value="start")
                                                                                         Long start,
                                                                                         @QueryParam(value="end")
                                                                                         Long end)

Get historical org billing.

Parameters:

orgUuid - org uuid

start - start

end - end

Returns:

list of historical bills for the organization between the given dates

sendEventHistory

@POST
 @Path(value="/{orgUuid}/actions/email-event-history")
 @Consumes(value="application/json")
void sendEventHistory(@PathParam(value="orgUuid")
                                                                                                                        String orgUuid,
                                                                                                                        EventHistoryEmailRequest spec)

Email a CSV report with all event history for a given Org.

Parameters:

orgUuid - org uuid

spec - email address spec

updateOrgVappLeaseSettings

@POST
 @Path(value="/{orgUuid}/actions/update-vapp-lease-settings")
 @Consumes(value="application/json")
OrgResponse updateOrgVappLeaseSettings(@PathParam(value="orgUuid")
                                                                                                                                                String orgUuid,
                                                                                                                                                OrgVappLeaseUpdateRequest spec)

Update the org / vapp lease settings section for a given org.

Parameters:

orgUuid - org uuid

spec - specification for updating org vapp lease settings

Returns:

organization

updateOrgVappTemplateLeaseSettings

@POST
 @Path(value="/{orgUuid}/actions/update-vapp-template-lease-settings")
 @Consumes(value="application/json")
OrgResponse updateOrgVappTemplateLeaseSettings(@PathParam(value="orgUuid")
                                                                                                                                                                 String orgUuid,
                                                                                                                                                                 OrgVappTemplateLeaseUpdateRequest spec)

Update the org / vapp template lease settings section for a given org.

Parameters:

orgUuid - org uuid

spec - specification for updating org vapp template lease settings

Returns:

organization

getMedias

@GET
 @Path(value="/{orgUuid}/medias")
MediaListResponse getMedias(@PathParam(value="orgUuid")
                                                                   String orgUuid)

Get medias for a given Org.

Parameters:

orgUuid - org uuid

Returns:

list of medias for the given organization

isComplianceOrg

@GET
 @Path(value="/{orgUuid}/is-compliance-org")
IsComplianceOrgResponse isComplianceOrg(@PathParam(value="orgUuid")
                                                                                          String orgUuid)

Return whether an org is a compliance organization.

Parameters:

orgUuid - organization uuid

Returns:

whether the org is a compliance org

createCatalog

@POST
 @Path(value="/{orgUuid}/catalog")
 @Consumes(value="application/json")
TaskResponse createCatalog(@PathParam(value="orgUuid")
                                                                                                         String orgUuid,
                                                                                                         CatalogCreateRequest request)

Create a catalog in the organization.

Parameters:

orgUuid - organization uuid

request - request for new catalog

Returns:

core task

getBillingCurrencyCode

@GET
 @Path(value="/{orgUuid}/billing-currency-code")
CurrencyCodeResponse getBillingCurrencyCode(@PathParam(value="orgUuid")
                                                                                                  String orgUuid)

Returns Org Billing Currency Code.

Will return one of the following currency codes:

• USD US dollars
• SGD Singapore dollars
• GBP British Pounds
• EUR Euros
• AUD Australian Dollar

Parameters:

orgUuid - org uuid

Returns:

org currency code

getOrgPublicIpAssignments

@GET
 @Path(value="/{orgUuid}/public-ip-assignments")
 @Consumes(value="application/json")
PublicIpAssignmentListResponse getOrgPublicIpAssignments(@PathParam(value="orgUuid")
                                                                                                                                                    String orgUuid)

Gets the public IP assignments for the organization.

Parameters:

orgUuid - org uuid

Returns:

public IP assignments

getOrgPublicIps

@GET
 @Path(value="/{orgUuid}/public-ips")
 @Consumes(value="application/json")
IPAddressSetResponse getOrgPublicIps(@PathParam(value="orgUuid")
                                                                                                                     String orgUuid)

Gets the public IPs for the organization.

Parameters:

orgUuid - org uuid

Returns:

public IPs

getVpgsForOrg

@GET
 @Path(value="/{orgUuid}/vpgs")
ExpandedVpgListResponse getVpgsForOrg(@PathParam(value="orgUuid")
                                                                           String orgUuid,
                                                                           @QueryParam(value="expand")
                                                                           List<VpgSubEntityRequest> expand)

Returns the list of VPGs for a given target vCloud Organization.

Parameters:

orgUuid - org uuid

Returns:

list of zerto vpgs

getVpgsProtectionSummary

@GET
 @Path(value="/{orgUuid}/vpgs-protection-info")
VpgsProtectionInfoResponse getVpgsProtectionSummary(@PathParam(value="orgUuid")
                                                                                                         String orgUuid)

Returns a VPGs protection info.

Parameters:

orgUuid - org uuid

Returns:

a VpgsProtectionInfoResponse the VPGs protection info

getVccFailoverPlans

@GET
 @Path(value="/{orgUuid}/vcc-failover-plans")
VccFailoverPlanListResponse getVccFailoverPlans(@PathParam(value="orgUuid")
                                                                                                   String orgUuid)

Returns the list of VCC-R failover plans for a given target vCloud Organization.

Parameters:

orgUuid - org uuid

Returns:

list of VCC-R failover Plans

batchFailoverTest

@POST
 @Path(value="/{orgUuid}/actions/vpg-batch-failover-test")
 @Consumes(value="application/json")
TaskResponse batchFailoverTest(@PathParam(value="orgUuid")
                                                                                                                                     String orgUuid,
                                                                                                                                     BatchFailoverTestParamsRequest params)

Batch test failover for one or more VPGs within an org.

Parameters:

params - the batch failover test parameters

orgUuid - the uuid of the organization that the vpgs belong to

Returns:

asynchronous task details

batchFailover

@POST
 @Path(value="/{orgUuid}/actions/vpg-batch-failover")
 @Consumes(value="application/json")
TaskResponse batchFailover(@PathParam(value="orgUuid")
                                                                                                                            String orgUuid,
                                                                                                                            BatchFailoverParamsRequest params)

Initiates a batch live failover on one or more VPGs withing an org.

Parameters:

params - the batch failover parameters

orgUuid - the uuid of the organization that the vpgs belong to

Returns:

asynchronous task details

getExpiredItems

@GET
 @Path(value="/{orgUuid}/expired-items")
OrgExpiredItemsResponse getExpiredItems(@PathParam(value="orgUuid")
                                                                                      String orgUuid)

Get the expired vapp and vapp templates for the given org.

Parameters:

orgUuid - String org uuid

Returns:

expired items, vapps and vapp templates

getBandwidthUsageSummary

@GET
 @Path(value="/{orgUuid}/bandwidth-usage-summary")
BandwidthUsageSummaryResponse getBandwidthUsageSummary(@PathParam(value="orgUuid")
                                                                                                               String orgUuid,
                                                                                                               @QueryParam(value="month")
                                                                                                               Integer month,
                                                                                                               @QueryParam(value="year")
                                                                                                               Integer year)

Returns the summary of bandwidth usage, and current reservation for the given month and year. If no month / year values are provided, the current month will be defaulted to. If you provide the month or year query parameters you must provide both of them to receive a valid response.

All bandwidth units are GB.

Parameters:

orgUuid - the UUID of the organization for which bandwidth summary is returned

month - 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

Returns:

the monthly bandwidth summary

getVdcCostOverInvoicePeriodSeries

@GET
 @Path(value="/{orgUuid}/vdcs-cost-over-invoice-period")
BillingSampleSerieListResponse getVdcCostOverInvoicePeriodSeries(@PathParam(value="orgUuid")
                                                                                                                               String orgUuid,
                                                                                                                               @QueryParam(value="year")
                                                                                                                               Integer year,
                                                                                                                               @QueryParam(value="month")
                                                                                                                               Integer month,
                                                                                                                               @QueryParam(value="additionalFields")
                                                                                                                               List<String> additionalFields)

Get a list of series detailing the hourly cost over an invoice period for all vDCs in a given Organization.

Parameters:

orgUuid - the UUID of the organization

year - the year

month - the month in range 1-12

additionalFields - additional bill fields that should be included in the series

Returns:

a list of series of samples detailing hourly vDC total cost by hour for the invoice period

getHistoricalBillingByVdc

@GET
 @Path(value="/{orgUuid}/historical-billing-by-vdc")
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)

Get a list of vDC bills for a given org between the given date ranges.

Parameters:

orgUuid - the UUID of the organization

startYear - the start year

startMonth - the start month (must be in range of 1-12)

endYear - the end year

endMonth - the end month (must be in range of 1-12)

Returns:

list of vDC bills per invoice period for the given org

getExternalNetworkUsageFor

@GET
 @Path(value="/{orgUuid}/external-network-usage")
NetworkPerfSampleSerieListResponse getExternalNetworkUsageFor(@PathParam(value="orgUuid")
                                                                                                                     String orgUuid,
                                                                                                                     @QueryParam(value="type")
                                                                                                                     String type,
                                                                                                                     @QueryParam(value="start")
                                                                                                                     Long start,
                                                                                                                     @QueryParam(value="end")
                                                                                                                     Long end)

Get external network usage for the given organization and type.

Parameters:

orgUuid - org uuid

type - type

start - start date

end - end date

Returns:

performance samples for external network, given counter, and date range

getExternalNetworkSummaryFor

@GET
 @Path(value="/{orgUuid}/external-network-summation")
NetworkPerfSampleSerieListResponse getExternalNetworkSummaryFor(@PathParam(value="orgUuid")
                                                                                                                           String orgUuid,
                                                                                                                           @QueryParam(value="type")
                                                                                                                           String type,
                                                                                                                           @QueryParam(value="start")
                                                                                                                           Long start,
                                                                                                                           @QueryParam(value="end")
                                                                                                                           Long end)

Get external network usage summary for the given organization and type.

Parameters:

orgUuid - org uuid

type - type

start - start date

end - end date

Returns:

performance samples for external network, given counter, and date range

getNetUsageFor

@GET
 @Path(value="/{orgUuid}/bandwidth-usage")
NetworkPerfSampleSerieListResponse getNetUsageFor(@PathParam(value="orgUuid")
                                                                                                  String orgUuid,
                                                                                                  @QueryParam(value="type")
                                                                                                  String type,
                                                                                                  @QueryParam(value="start")
                                                                                                  Long start,
                                                                                                  @QueryParam(value="end")
                                                                                                  Long end)

Get network usage for the given organization and type.

Parameters:

orgUuid - org uuid

type - type

start - start date

end - end date

Returns:

list of network performance samples for the network

getNetSummaryFor

@GET
 @Path(value="/{orgUuid}/bandwidth-summation")
NetworkPerfSampleSerieListResponse getNetSummaryFor(@PathParam(value="orgUuid")
                                                                                                        String orgUuid,
                                                                                                        @QueryParam(value="type")
                                                                                                        String type,
                                                                                                        @QueryParam(value="start")
                                                                                                        Long start,
                                                                                                        @QueryParam(value="end")
                                                                                                        Long end)

Get network usage summary for the given organization and type.

Parameters:

orgUuid - org uuid

type - type

start - start date

end - end date

Returns:

list of network performane samples for the network

launchNessusScan

@POST
 @Path(value="/{orgUuid}/nessus-scan-templates/{scanTemplateId}/actions/launch-scan")
NessusLaunchResponse launchNessusScan(@PathParam(value="orgUuid")
                                                                                                                                  String orgUuid,
                                                                                                                                  @PathParam(value="scanTemplateId")
                                                                                                                                  int scanTemplateId)

Launch a nessus scan given an organization uuid and a scan id.

Will only successfully queue scan launch if that scan is not currently in progress.

Parameters:

orgUuid - org uuid

scanTemplateId - nessus scan id

Returns:

nessus launch

pauseNessusScan

@POST
 @Path(value="/{orgUuid}/nessus-scan-templates/{scanTemplateId}/actions/pause-scan")
void pauseNessusScan(@PathParam(value="orgUuid")
                                                                                                                String orgUuid,
                                                                                                                @PathParam(value="scanTemplateId")
                                                                                                                int scanTemplateId)

Pause a nessus scan given an organization uuid and a scan id.

Will only successfully pause scan if that scan is currently running.

Parameters:

orgUuid - org uuid

scanTemplateId - nessus scan id

stopNessusScan

@POST
 @Path(value="/{orgUuid}/nessus-scan-templates/{scanTemplateId}/actions/stop-scan")
void stopNessusScan(@PathParam(value="orgUuid")
                                                                                                              String orgUuid,
                                                                                                              @PathParam(value="scanTemplateId")
                                                                                                              int scanTemplateId)

Stop a nessus scan given an organization uuid and a scan id.

Will only successfully stop scan if that scan is currently running.

Parameters:

orgUuid - org uuid

scanTemplateId - nessus scan id

resumeNessusScan

@POST
 @Path(value="/{orgUuid}/nessus-scan-templates/{scanTemplateId}/actions/resume-scan")
void resumeNessusScan(@PathParam(value="orgUuid")
                                                                                                                  String orgUuid,
                                                                                                                  @PathParam(value="scanTemplateId")
                                                                                                                  int scanTemplateId)

Resume a nessus scan given an organization uuid and a scan id.

Will only successfully resume scan if that scan is currently paused.

Parameters:

orgUuid - org uuid

scanTemplateId - nessus scan id

getNessusScanTemplates

@GET
 @Path(value="/{orgUuid}/nessus-scan-templates")
NessusScanListResponse getNessusScanTemplates(@PathParam(value="orgUuid")
                                                                                                    String orgUuid,
                                                                                                    @QueryParam(value="offset")
                                                                                                    Integer offset,
                                                                                                    @QueryParam(value="limit")
                                                                                                    Integer limit)

Get a list of all scans for a given organization.

Parameters:

orgUuid - org uuid

offset - the offset of the first scan to retrieve

limit - the limit of the number of scans to retrieve

Returns:

list of nessus scans for the organization

getNessusScanResultsForTemplate

@GET
 @Path(value="/{orgUuid}/nessus-scan-templates/{scanTemplateId}/nessus-scan-results")
NessusScanListResponse getNessusScanResultsForTemplate(@PathParam(value="orgUuid")
                                                                                                                                                  String orgUuid,
                                                                                                                                                  @PathParam(value="scanTemplateId")
                                                                                                                                                  int scanTemplateId,
                                                                                                                                                  @QueryParam(value="offset")
                                                                                                                                                  Integer offset,
                                                                                                                                                  @QueryParam(value="limit")
                                                                                                                                                  Integer limit)

Get a list of all scans with given ID that are in a given organization.

This will only return all the scans with the given ID.

Parameters:

orgUuid - org uuid

offset - the offset of the first scan to retrieve

limit - the limit of the number of scans to retrieve

Returns:

list of launched nessus scans for the organization

getNessusScanResult

@GET
 @Path(value="/{orgUuid}/nessus-scans-results/{scanResultUuid}")
NessusScanDetailsResponse getNessusScanResult(@PathParam(value="orgUuid")
                                                                                                                    String orgUuid,
                                                                                                                    @PathParam(value="scanResultUuid")
                                                                                                                    String scanResultUuid)

Get the scan details for a given organization and a scan UUID.

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.

Parameters:

orgUuid - org uuid

Returns:

list of launched nessus scans for the organization

updateNessusScanTemplate

@PUT
 @Path(value="/{orgUuid}/nessus-scan-templates/{scanTemplateId}")
 @Consumes(value="application/json")
NessusScanUpdateResponse updateNessusScanTemplate(@PathParam(value="orgUuid")
                                                                                                                                                              String orgUuid,
                                                                                                                                                              @PathParam(value="scanTemplateId")
                                                                                                                                                              int scanTemplateId,
                                                                                                                                                              NessusScanUpdateRequest spec)

Update a scan given an organization and the scan ID.

The following options are availble to configure:

• uuid: the uuid for the editor template to use
• settings.name: the name of the scan
• settings.description: the description of the scan
• settings.policy_id: the unique id of the policy to use
• settings.folder_id: the unique id of the destination folder for thescan
• settings.scanner_id: the unique id of the scanner to use
• settings.enabled: if true, the schedule for the scan is enabled
• settings.launch: when to launch the scan (i.e. DAILY, WEEKLY, MONTHLY or YEARLY)
• settings.starttime: the starting time and date for the scan (i.e. YYYYMMDDTHHMMSS)
• settings.rrules: Expects a semi-colon delimited string comprised of three values. The frequency (FREQ=ONCE or DAILY or WEEKLY or MONTHLY or YEARLY), the interval (INTERVAL=1 or 2 or 3 ... x), and the days of the week (BYDAY=SU,MO,TU,WE,TH,FR,SA). To create a scan that runs every three weeks on Monday Wednesday and Friday the string would be 'FREQ=WEEKLY;INTERVAL=3;BYDAY=MO,WE,FR'
• settings.timezone: The timezone for the scan schedule
• settings.text_targets: The list of targets to scan
• settings.file_targets: The name of a file containing the list of targets to scan
• settings.emails: A comma seperated list of accounts who will receive the email summary report
• settings.acls: An array containing permissions to apply to the scan
• settings.use_dashboard: If true, the dashboard will be enabled for this scan

Parameters:

orgUuid - org uuid

scanTemplateId - scan template id

spec - specification for updating the scan

Returns:

details of the updated scan

getEdgeNetworkUsageSummary

@GET
 @Path(value="/{orgUuid}/edge-network-usage-summary")
NetworkPerfSampleSerieListResponse getEdgeNetworkUsageSummary(@PathParam(value="orgUuid")
                                                                                                                         String orgUuid,
                                                                                                                         @QueryParam(value="type")
                                                                                                                         String type,
                                                                                                                         @QueryParam(value="start")
                                                                                                                         Long start,
                                                                                                                         @QueryParam(value="end")
                                                                                                                         Long end)

Gets a vCD edge gateway usage summary, summarizing the total bandwidth used for both inbound and outbound edge network traffic.

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

Parameters:

orgUuid - UUID of the parent organization

type - type

start - start date

end - end date

getEdgeNetworkUsageOverTime

@GET
 @Path(value="/{orgUuid}/edge-network-usage-over-time")
NetworkPerfSampleSerieListResponse getEdgeNetworkUsageOverTime(@PathParam(value="orgUuid")
                                                                                                                            String orgUuid,
                                                                                                                            @QueryParam(value="type")
                                                                                                                            String type,
                                                                                                                            @QueryParam(value="start")
                                                                                                                            Long start,
                                                                                                                            @QueryParam(value="end")
                                                                                                                            Long end)

Gets usage data for a VCD edge gateway. Returns a time series showing the average inbound and outbound network thoughput in KBps.

Parameters:

orgUuid - UUID of the parent organization

type - type

start - start date

end - end date

Returns:

network performance samples

getRecoveryRunbooks

@GET
 @Path(value="/{orgUuid}/disaster-recovery-runbooks")
DisasterRecoveryRunbookListResponse getRecoveryRunbooks(@PathParam(value="orgUuid")
                                                                                                                   String orgUuid)

Get the list of recovery runbooks for a given organization.

Parameters:

orgUuid - the organization UUID

Returns:

the list of runbooks

createRecoveryRunbook

@POST
 @Path(value="/{orgUuid}/disaster-recovery-runbooks")
 @Consumes(value="application/json")
DisasterRecoveryRunbookResponse createRecoveryRunbook(@PathParam(value="orgUuid")
                                                                                                                                                       String orgUuid,
                                                                                                                                                       DisasterRecoveryRunbookCreateRequest spec)

Add a runbook to the given organizations runbooks.

Parameters:

orgUuid - the organization UUID

spec - the specification for the new recovery runbook

Returns:

the newly craeted recovery runbook

updateNessusScanOptOutPreferences

@POST
 @Path(value="/{orgUuid}/actions/update-nessus-scan-opt-out-preferences")
 @Consumes(value="application/json")
NessusScanOptOutResponse updateNessusScanOptOutPreferences(@PathParam(value="orgUuid")
                                                                                                                                                                                String orgUuid,
                                                                                                                                                                                NessusScanOptOutCreateRequest request)

Update a set of ip addresses or ranges to opt out of weekly Nessus scans for a given org. Or opt out completely of all scans.

Parameters:

request - nessus scan opt out details

getNessusScanOptOutPreferences

@GET
 @Path(value="/{orgUuid}/nessus-scan-opt-out-preferences")
NessusScanOptOutResponse getNessusScanOptOutPreferences(@PathParam(value="orgUuid")
                                                                                                                        String orgUuid)

Get the nessus scan opt out details for the given org.

Parameters:

orgUuid - String org uuid

listBackupGroups

@GET
 @Path(value="/{orgUuid}/backup-groups")
BackupGroupListResponse listBackupGroups(@PathParam(value="orgUuid")
                                                                                       String orgUuid,
                                                                                       @QueryParam(value="includeDeleted")
                                                                                       boolean includeDeleted,
                                                                                       @QueryParam(value="includeSummaryStats")
                                                                                       boolean includeSummaryStats,
                                                                                       @QueryParam(value="includeLastRun")
                                                                                       boolean includeLastRun,
                                                                                       @QueryParam(value="includeBackupPolicy")
                                                                                       boolean includeBackupPolicy)

List the existing backup groups that are configured in a specified organization.

Parameters:

orgUuid - the UUID of the org

includeDeleted - whether to include deleted backup groups

includeSummaryStats - whether to include backup summary stats

includeLastRun - whether to include last run info in the response

includeBackupPolicy - whether to include backup policy info

Returns:

BackupGroupListResponse

getBackupGroupSummaryStats

@GET
 @Path(value="/{orgUuid}/backup-group-summary-stats")
OrgBackupSummaryStatsResponse getBackupGroupSummaryStats(@PathParam(value="orgUuid")
                                                                                                                    String orgUuid)

Gets backup group summary stats for the Org.

Parameters:

orgUuid - the UUID of the Org

Returns:

OrgBackupSummaryStatsResponse

listBackupPolicies

@GET
 @Path(value="/{orgUuid}/backup-policies")
BackupPolicyListResponse listBackupPolicies(@PathParam(value="orgUuid")
                                                                                            String orgUuid,
                                                                                            @QueryParam(value="includeVdcScopedPolicies")
                                                                                            boolean includeVdcScopedPolicies)

List the existing backup policies that are configured in an organization.

Parameters:

orgUuid - the UUID of the organization

includeVdcScopedPolicies - whether to include vDC scoped policies for all vDCs that are children of the org.

Returns:

BackupPolicyListResponse

getBackupPolicy

@GET
 @Path(value="/{orgUuid}/backup-policies/{backupPolicyUid}")
BackupPolicyResponse getBackupPolicy(@PathParam(value="orgUuid")
                                                                                                       String orgUuid,
                                                                                                       @PathParam(value="backupPolicyUid")
                                                                                                       String backupPolicyUid)

Get details of an individual org-scoped backup policy.

Parameters:

backupPolicyUid - the UID of the backup policy

orgUuid - the UUID of the organization

Returns:

BackupPolicyResponse

createBackupPolicy

@POST
 @Path(value="/{orgUuid}/backup-policies")
 @Consumes(value="application/json")
BackupPolicyResponse createBackupPolicy(@PathParam(value="orgUuid")
                                                                                                                              String orgUuid,
                                                                                                                              BackupPolicyUpdateRequest creationRequest)

Create a new org-scoped backup policy.

Parameters:

orgUuid - the UUID of the organization

creationRequest - the creation request body

Returns:

BackupPolicyResponse

updateBackupPolicy

@PUT
 @Path(value="/{orgUuid}/backup-policies/{backupPolicyUid}")
 @Consumes(value="application/json")
BackupPolicyResponse updateBackupPolicy(@PathParam(value="orgUuid")
                                                                                                                                               String orgUuid,
                                                                                                                                               @PathParam(value="backupPolicyUid")
                                                                                                                                               String backupPolicyUid,
                                                                                                                                               BackupPolicyUpdateRequest updateRequest)

Update a backup policy.

Parameters:

orgUuid - the UUID of the organization

backupPolicyUid - the UID of the backup policy

updateRequest - the update request body

Returns:

BackupPolicyResponse

getBackupStatus

@GET
 @Path(value="/{orgUuid}/backup-status")
OrgBackupStatusResponse getBackupStatus(@PathParam(value="orgUuid")
                                                                                      String orgUuid)

Gets the org's backup status.

Parameters:

orgUuid - the UUID of the org

Returns:

org backup status details

deleteBackupPolicy

@DELETE
 @Path(value="/{orgUuid}/backup-policies/{backupPolicyUid}")
 @Consumes(value="application/json")
void deleteBackupPolicy(@PathParam(value="orgUuid")
                                                                                                                                  String orgUuid,
                                                                                                                                  @PathParam(value="backupPolicyUid")
                                                                                                                                  String backupPolicyUid)

Delete a backup policy.

Parameters:

orgUuid - the UUID of the organization

backupPolicyUid - the UID of the backup policy