Skip to content
This repository was archived by the owner on Sep 28, 2022. It is now read-only.

CiscoDevNet/java-msx-sdk

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
.openapi-generator
.openapi-generator
 
 
api
api
 
 
docs
docs
 
 
src
src
 
 
.gitignore
.gitignore
 
 
.openapi-generator-ignore
.openapi-generator-ignore
 
 
.travis.yml
.travis.yml
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
pom.old
pom.old
 
 
pom.xml
pom.xml
 
 

Repository files navigation

java-msx-sdk

MSX SDK

  • API version: 1.0.10
    • Build date: 2022-05-17T18:31:30.346538700-04:00[America/Toronto]

MSX SDK client.

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 1.8+
  2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.cisco.msx.platform</groupId>
  <artifactId>java-msx-sdk</artifactId>
  <version>1.0.10</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'java-msx-sdk' jar has been published to maven central.
    mavenLocal()       // Needed if the 'java-msx-sdk' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.cisco.msx.platform:java-msx-sdk:1.0.10"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/java-msx-sdk-1.0.10.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import com.cisco.msx.platform.ApiClient;
import com.cisco.msx.platform.ApiException;
import com.cisco.msx.platform.Configuration;
import com.cisco.msx.platform.models.*;
import com.cisco.msx.platform.client.AuditingGenericEventsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    AuditingGenericEventsApi apiInstance = new AuditingGenericEventsApi(defaultClient);
    GenericEventCreate genericEventCreate = new GenericEventCreate(); // GenericEventCreate | 
    try {
      GenericEvent result = apiInstance.createGenericEvent(genericEventCreate);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AuditingGenericEventsApi#createGenericEvent");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AuditingGenericEventsApi createGenericEvent POST /auditing/api/v8/genericevents Create Generic Event
BillingCyclesApi addBillingCycle POST /billing/api/v8/cycles Add a billing cycle.
BillingCyclesApi deleteBillingCycle DELETE /billing/api/v8/cycles/{id} Delete a billing cycle.
BillingCyclesApi getBillingCycle GET /billing/api/v8/cycles/{id} Get a billing cycle.
BillingCyclesApi getBillingCyclesPage GET /billing/api/v8/cycles Retrieve a page of billing cycles.
BillingCyclesApi processBillingCycle POST /billing/api/v8/cycles/process Process a billing cycle.
BillingCyclesApi updateBillingCycle PUT /billing/api/v8/cycles/{id} Update billing cycle for an event type and tenant.
BillingEventsApi getCostSummary GET /billing/api/v8/events/costs Retrieve a summary for tenant cost.
BillingEventsApi getEvent GET /billing/api/v8/events/{id} Get an Event.
BillingEventsApi getEventsPage GET /billing/api/v8/events Retrieve a page of events for tenant.
BillingPricesApi addPrice POST /billing/api/v8/prices Add price for tenant and event type.
BillingPricesApi deletePrice DELETE /billing/api/v8/prices/{id} Delete a price.
BillingPricesApi getPrice GET /billing/api/v8/prices/{id} Get a price.
BillingPricesApi getPricesPage GET /billing/api/v8/prices Retrieve a page of prices.
BillingPricesApi updatePrice PUT /billing/api/v8/prices/{id} Update price for an event type and tenant.
DeviceTemplatesApi createDeviceTemplate POST /manage/api/v8/devicetemplates Creates a device template.
DeviceTemplatesApi createDeviceTemplateVersion POST /manage/api/v8/devicetemplates/versions Creates a new version of an existing device template.
DeviceTemplatesApi deleteDeviceTemplate DELETE /manage/api/v8/devicetemplates/{id} Deletes a device template.
DeviceTemplatesApi getDeviceTemplate GET /manage/api/v8/devicetemplates/{id} Returns a device template.
DeviceTemplatesApi getDeviceTemplatesList GET /manage/api/v8/devicetemplates/list Returns a list of device templates.
DeviceTemplatesApi scanDeviceTemplateParameters POST /manage/api/v8/devicetemplates/parameters/scan API to scan parameters from the device template XML.
DeviceTemplatesApi updateDeviceTemplateAccess PUT /manage/api/v8/devicetemplates/{id}/access Updates device template access.
DevicesApi attachDeviceTemplates POST /manage/api/v8/devices/{id}/templates Attaches one or more device templates to a device instance.
DevicesApi batchAttachDeviceTemplates POST /manage/api/v8/devices/templates/attach Attaches one or more device templates to a batch of device instances.
DevicesApi createDevice POST /manage/api/v8/devices Creates a device.
DevicesApi deleteDevice DELETE /manage/api/v8/devices/{id} Deletes a device.
DevicesApi detachDeviceTemplate DELETE /manage/api/v8/devices/{id}/templates/{templateId} Detaches a template from a device.
DevicesApi detachDeviceTemplates DELETE /manage/api/v8/devices/{id}/templates Detach device templates that are already attached to a device.
DevicesApi getDevice GET /manage/api/v8/devices/{id} Returns a device.
DevicesApi getDeviceConfig GET /manage/api/v8/devices/{id}/config Returns the running configuration for a device.
DevicesApi getDeviceTemplateHistory GET /manage/api/v8/devices/{id}/templates Returns device template history.
DevicesApi getDevicesPage GET /manage/api/v8/devices Returns a page of devices.
DevicesApi patchDevice PATCH /manage/api/v8/devices/{id} Update a device.
DevicesApi redeployDevice POST /manage/api/v8/devices/{id}/redeploy Dedeploys a device.
DevicesApi updateDevice PUT /manage/api/v8/devices/{id} Update a device.
DevicesApi updateDeviceConfig POST /manage/api/v8/devices/{id}/config/update push device configuration to the actual device
DevicesApi updateDeviceTemplates PUT /manage/api/v8/devices/{id}/templates Update device templates that are already attached to a device.
HealthApi getDevicesHealthList GET /monitor/api/v8/health/devices/list
HealthApi getServicesHealthList GET /monitor/api/v8/health/services/list
IncidentChangeRequestsApi createChangeRequest POST /incident/api/v8/changerequests Create a change request.
IncidentChangeRequestsApi deleteChangeRequest DELETE /incident/api/v8/changerequests/{id} Deletes a change request.
IncidentChangeRequestsApi getChangeRequest GET /incident/api/v8/changerequests/{id} Returns a change request.
IncidentChangeRequestsApi getChangeRequestsPage GET /incident/api/v8/changerequests Returns a filtered list of change requests.
IncidentChangeRequestsApi updateChangeRequest PUT /incident/api/v8/changerequests/{id} Updates a change request.
IncidentConfigurationsApi createServiceNowConfiguration POST /incident/api/v8/configurations Creates a ServiceNow configuration.
IncidentConfigurationsApi deleteServiceNowConfiguration DELETE /incident/api/v8/configurations/{id} Deletes a ServiceNow configuration.
IncidentConfigurationsApi getConfiguration GET /incident/api/v1/config API to get configuration of encloud service.
IncidentConfigurationsApi getServiceNowConfiguration GET /incident/api/v8/configurations/{id} Returns a ServiceNow configuration.
IncidentConfigurationsApi getServiceNowConfigurationsPage GET /incident/api/v8/configurations Returns a ServiceNow configurations.
IncidentConfigurationsApi patchConfiguration PATCH /incident/api/v1/config API to patch configure encloud service
IncidentConfigurationsApi updateConfiguration PUT /incident/api/v1/config API to configure encloud service.
IncidentsApi cancelIncident PATCH /incident/api/v1/incidents/{id}/cancel Cancels an incident.
IncidentsApi createIncident POST /incident/api/v1/incidents Create a new Incident.
IncidentsApi deleteIncident DELETE /incident/api/v1/incidents/{id} Deletes an incident.
IncidentsApi getIncident GET /incident/api/v1/incidents/{id} Get incident details.
IncidentsApi getIncidents GET /incident/api/v1/incidents Get Incidents by filter.
IncidentsApi updateIncident PUT /incident/api/v1/incidents/{id} Updates an incident.
LicensingAccountsApi getUserAccountsList GET /licensing/api/v8/accounts/smart/list Returns a filtered page of smart accounts.
LicensingConfigurationsApi createSmartAccountConfiguration POST /licensing/api/v8/configuration Creates a smart account configuration.
LicensingConfigurationsApi getSmartAccountConfiguration GET /licensing/api/v8/configuration Returns a smart account configuration.
LicensingConfigurationsApi updateSmartAccountConfiguration PUT /licensing/api/v8/configuration Updates a smart account configuration.
LicensingLicensesApi getLicensesList GET /licensing/api/v8/licensing/api/v8/licenses/list Returns a filtered list of licenses.
OffersApi createOffer POST /consume/api/v8/offers Creates a product offer.
OffersApi deleteOffer DELETE /consume/api/v8/offers/{id} Deletes a product offer
OffersApi getOffer GET /consume/api/v8/offers/{id} Returns a product offer.
OffersApi getOfferAssignmentsList GET /consume/api/v8/offers/{id}/assignments/list Returns a list of tenant assignments for a product offer.
OffersApi getOffersCount GET /consume/api/v8/offers/count Returns the number of product offers.
OffersApi getOffersPage GET /consume/api/v8/offers Returns a page of product offers.
OffersApi updateOffer PUT /consume/api/v8/offers/{id} Updates a product offer.
OffersApi updateOfferAssignments PUT /consume/api/v8/offers/{id}/assignments Updates the tenant assignemnts for a product offer.
ProductsApi createProduct POST /consume/api/v8/products Creates a product.
ProductsApi deleteProduct DELETE /consume/api/v8/products/{id} Deletes a product.
ProductsApi getProduct GET /consume/api/v8/products/{id} Returns a product.
ProductsApi getProductAssignmentsList GET /consume/api/v8/products/{id}/assignments/list Returns a list of tenant assignments for a product .
ProductsApi getProductsCount GET /consume/api/v8/products/count Returns the number of products.
ProductsApi getProductsPage GET /consume/api/v8/products Returns a page of products.
ProductsApi updateProduct PUT /consume/api/v8/products/{id} Updates a product.
ProductsApi updateProductAssignments PUT /consume/api/v8/products/{id}/assignments Updates the tenant assignments for a product.
RegistrationApi deleteRegisteredProductVersion DELETE /vulnerability/api/v8/vulnerabilities/registrations/{id} Delete a registration.
RegistrationApi getRegisteredProductVersionPage GET /vulnerability/api/v8/vulnerabilities/registrations Returns a filtered page of registered products / versions.
RegistrationApi registerProductVersion POST /vulnerability/api/v8/vulnerabilities/registrations Register a product / verison combination for vulnerability inspection.
RolesApi getRoleByName GET /idm/api/v8/roles/name/{name} Returns a role by name.
RolesApi getRolesList GET /idm/api/v8/roles/list Returns a list of roles.
SecurityApi getAccessToken POST /idm/v2/token Returns an access token.
ServicesApi deleteService DELETE /manage/api/v8/services/{id} Deletes a service.
ServicesApi getService GET /manage/api/v8/services/{id} Returns a service.
ServicesApi getServicesPage GET /manage/api/v8/services Returns a page of services.
ServicesApi submitOrder POST /manage/api/v8/services Submits an order.
ServicesApi updateOrder PUT /manage/api/v8/services Updates an order.
ServicesApi updateService PUT /manage/api/v8/services/{id} Updates a service.
SitesApi addDevicesToSite POST /manage/api/v8/sites/{id}/devices/add Add devices to a site.
SitesApi addServicesToSite POST /manage/api/v8/sites/{id}/services/add Add services to a site.
SitesApi createSite POST /manage/api/v8/sites Creates a new site.
SitesApi deleteSite DELETE /manage/api/v8/sites/{id} Deletes a site.
SitesApi getSite GET /manage/api/v8/sites/{id} Returns a site.
SitesApi getSitesPage GET /manage/api/v8/sites Returns a page of Sites. Only one filter is supported at a time.
SitesApi removeDevicesFromSite POST /manage/api/v8/sites/{id}/devices/remove Removes devices from a site.
SitesApi removeServicesFromSite POST /manage/api/v8/sites/{id}/services/remove Remove services from a site.
SitesApi updateSite PUT /manage/api/v8/sites/{id} Updates a site.
TemplateApplicationsApi applyTemplate POST /template/api/v8/templates/{id}/applications Applies a template to a target.
TemplateApplicationsApi deleteTemplateApplication DELETE /template/api/v8/templates/applications/{id} Deletes a template application.
TemplateApplicationsApi getTemplateApplication GET /template/api/v8/templates/applications/{id} Gets a template application.
TemplateApplicationsApi getTemplateApplicationHistory GET /template/api/v8/templates/applications/{id}/history Gets a template application history.
TemplateApplicationsApi getTemplateApplicationsPage GET /template/api/v8/templates/applications Get a page of template applications.
TemplateApplicationsApi updateApplicationStatus PATCH /template/api/v8/templates/applications/{id} Updates an application status.
TemplateAssignmentsApi batchAssignTemplate POST /template/api/v8/templates/{id}/assignments/add Assigns a template to one or more tenants.
TemplateAssignmentsApi batchUnassignTemplate POST /template/api/v8/templates/{id}/assignments/remove Unassigns a template from one or more tenants.
TemplateAssignmentsApi getAssignment GET /template/api/v8/templates/assignments/{id} Gets a template assignment.
TemplateAssignmentsApi getAssignmentHistory GET /template/api/v8/templates/assignments/{id}/history Gets a template assignment history.
TemplateAssignmentsApi getTemplateAssignmentsPage GET /template/api/v8/templates/assignments Returns a page of template assignments.
TemplateAssignmentsApi updateAssignmentStatus PATCH /template/api/v8/templates/assignments/{id} Updates a template assignment status.
TemplatesApi deleteTemplate DELETE /template/api/v8/templates/{id} Deletes a template.
TemplatesApi getTemplate GET /template/api/v8/templates/{id} Returns a template by id.
TemplatesApi getTemplateHistory GET /template/api/v8/templates/{id}/history Returns a template history by id.
TemplatesApi getTemplatesPage GET /template/api/v8/templates Returns a page of templates.
TemplatesApi importTemplate POST /template/api/v8/templates Imports a template.
TemplatesApi updateTemplateStatus PATCH /template/api/v8/templates/{id} Updates a template status.
TenantsApi createTenant POST /idm/api/v8/tenants Creates a new tenant.
TenantsApi deleteTenant DELETE /idm/api/v8/tenants/{id} Deletes a tenant by id.
TenantsApi getTenant GET /idm/api/v8/tenants/{id} Returns a tenant by id.
TenantsApi getTenantByExternalId GET /idm/api/v8/tenants/externalId/{externalId} Returns a tenant by externalId.
TenantsApi getTenantsList GET /idm/api/v8/tenants/list Returns a list of tenants.
TenantsApi getTenantsPage GET /idm/api/v8/tenants Returns a page of tenants.
TenantsApi updateTenant PUT /idm/api/v8/tenants/{id} Updates a tenant by id.
UsersApi createUser POST /idm/api/v8/users Creates a new user.
UsersApi deleteUser DELETE /idm/api/v8/users/{id} Deletes a user by id.
UsersApi getCurrentUser GET /idm/api/v8/users/current Returns the current user.
UsersApi getUser GET /idm/api/v8/users/{id} Returns an existing user.
UsersApi getUsersPage GET /idm/api/v8/users Returns a page of users.
UsersApi updateUser PUT /idm/api/v8/users/{id} Updates an existing user.
UsersApi updateUserPassword PUT /idm/api/v8/users/updatepassword Update a user password.
ValidationApi getValidateProductVersionPage GET /vulnerability/api/v8/vulnerabilities/validations Returns a filtered page of validations.
ValidationApi validateProductVersion POST /vulnerability/api/v8/vulnerabilities/validations Validate registered product / verison combinations for vulnerabilities.
VulnerabilitiesApi getIngestVulnerabilitiesTasksPage GET /vulnerability/api/v8/vulnerabilities/ingests Returns a filtered page of ingest tasks.
VulnerabilitiesApi getVulnerabilitiesPage GET /vulnerability/api/v8/vulnerabilities Returns a filtered page of vulnerabilities.
VulnerabilitiesApi ingestVulnerabilities POST /vulnerability/api/v8/vulnerabilities/ingests Ingests a CVE JSON feed into the Vulnerability Service datastore.
WorkflowCategoriesApi createWorkflowCategory POST /workflow/api/v8/categories Creates a new workflow category.
WorkflowCategoriesApi deleteWorkflowCategory DELETE /workflow/api/v8/categories/{id} Deletes a workflow category.
WorkflowCategoriesApi getWorkflowCategoriesList GET /workflow/api/v8/categories/list Returns a list of workflow categories.
WorkflowCategoriesApi getWorkflowCategory GET /workflow/api/v8/categories/{id} Returns a workflow category.
WorkflowCategoriesApi updateWorkflowCategory PUT /workflow/api/v8/categories/{id} Updates a workflow category.
WorkflowEventsApi createWorkflowEvent POST /workflow/api/v8/events Creates a new workflow event.
WorkflowEventsApi deleteWorkflowEvent DELETE /workflow/api/v8/events/{id} Deletes a workflow event.
WorkflowEventsApi getWorkflowEvent GET /workflow/api/v8/events/{id} Returns a workflow event.
WorkflowEventsApi getWorkflowEventsList GET /workflow/api/v8/events/list Returns a list of workflow events.
WorkflowEventsApi updateWorkflowEvent PUT /workflow/api/v8/events/{id} Updates a workflow event.
WorkflowInstancesApi cancelWorkflowInstance POST /workflow/api/v8/workflows/instances/{id}/cancel Cancels a workflow instance.
WorkflowInstancesApi deleteWorkflowInstance DELETE /workflow/api/v8/workflows/instances/{id} Deletes a workflow instance.
WorkflowInstancesApi getWorkflowInstance GET /workflow/api/v8/workflows/instances/{id} Returns a workflow instance.
WorkflowInstancesApi getWorkflowInstanceAction GET /workflow/api/v8/workflows/instances/{id}/actions/{actionId} Returns a workflow instance action.
WorkflowInstancesApi getWorkflowInstancesList GET /workflow/api/v8/workflows/{id}/instances/list Returns a list of workflow instances.
WorkflowSchemasApi getWorkflowSchema GET /workflow/api/v8/schemas/{id} Returns a workflow schema.
WorkflowSchemasApi getWorkflowSchemasList GET /workflow/api/v8/schemas/list Returns a list of workflow schemas.
WorkflowTargetsApi createWorkflowTarget POST /workflow/api/v8/targets Creates a new workflow target.
WorkflowTargetsApi deleteWorkflowTarget DELETE /workflow/api/v8/targets/{id} Deletes a workflow target.
WorkflowTargetsApi getWorkflowTarget GET /workflow/api/v8/targets/{id} Returns a workflow target.
WorkflowTargetsApi getWorkflowTargetsList GET /workflow/api/v8/targets/list Returns a list of workflow targets.
WorkflowTargetsApi updateWorkflowTarget PUT /workflow/api/v8/targets/{id} Updates a workflow target.
WorkflowsApi deleteWorkflow DELETE /workflow/api/v8/workflows/{id} Delete a workflow.
WorkflowsApi exportWorkflow GET /workflow/api/v8/workflows/{id}/export Exports a workflow.
WorkflowsApi getWorkflow GET /workflow/api/v8/workflows/{id} Returns a workflow.
WorkflowsApi getWorkflowStartConfig GET /workflow/api/v8/workflows/{id}/startconfig Returns a workflow start config.
WorkflowsApi getWorkflowsList GET /workflow/api/v8/workflows/list Returns a list of workflows.
WorkflowsApi importWorkflow POST /workflow/api/v8/workflows Imports a workflow.
WorkflowsApi startWorkflow POST /workflow/api/v8/workflows/{id}/start Starts a workflow.
WorkflowsApi updateWorkflow PUT /workflow/api/v8/workflows/{id} Updates a workflow.
WorkflowsApi validateWorkflow POST /workflow/api/v8/workflows/{id}/validate Validates a workflow.

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization. Authentication schemes defined for the API:

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

About

No description, website, or topics provided.

Resources

Readme

License

MIT license

Code of conduct

Code of conduct

Contributing

Contributing

Security policy

Security policy
Activity
Custom properties

Stars

1 star

Watchers

16 watching

Forks

0 forks
Report repository

Releases 8

v1.0.11 Latest
May 12, 2022
+ 7 releases

Packages

No packages published

Languages