Continuous Optimization REST API endpoints
Agent Data endpoints in the REST API
URL to access: https://<host name>/opt/api/agentdata/openapi.yaml
This table lists the endpoints for Agent data.
API endpoint | Description |
|---|---|
GET/opt/api/v1/agentdata/about | Returns the status of the agent data service. |
POST /opt/api/v1/agentdata/gwsrequest | Creates a Gateway Server for the specified request. |
PUT /opt/api/v1/agentdata/gwsrequest | Updates the details of the specified Gateway Server ID. |
GET /opt/api/v1/agentdata/gwsrequest/{gws_id} | Retrieves the Gateway Server details for the specified Gateway Server ID. |
Analysis endpoints in the REST API
URL to access: https://<host name>/opt/api/analysis/openapi.yaml
This table lists the endpoints for analysis.
API endpoint | Description |
|---|---|
Endpoints for Execute | |
GET /opt/api/v1/analysis/about | Returns the status of the analysis service. |
POST /opt/api/v1/analysis/execute | Executes an analysis and returns the results synchronously. |
POST/opt/api/v1/analysis/execute_async | Executes an analysis and returns the results asynchronously. |
GET /opt/api/v1/analysis/executions/{execution_id} | Retrieves the status of an analysis execution. |
GET/opt/api/v1/analysis/executions | Retrieves the recent execution results for the current user. |
GET/opt/api/v1/analysis/executions/tag/{external_group_id} | Retrieves the list of all executions with the specified tag. |
GET/opt/api/v1/analysis/executions/{type}/{id} | Retrieves the details of all analysis or models with the specified plot ID. |
Endpoints for Results | |
GET/opt/api/v1/analysis/results/{type}/{id}/chart/{chart_id} | Retrieves the chart details. |
GET/opt/api/v1/analysis/entity_filter/{id} | Retrieves the list of entities for the specified entity ID. |
POST/opt/api/v1/analysis/entity_filter | Retrieves the list of entities. |
Endpoint for Threshold | |
POST/opt/api/v1/analysis/threshold/{structure_id} | Retrieves thresholds for the specified entity IDs and metrics. |
Catalog endpoints in the REST API
URL to access: https://<host name>/opt/api/catalog/openapi.yaml
This table lists the endpoints for catalog. Use the Catalog REST API to view the status of the tenants and the lookup fields.
API endpoint | Description |
|---|---|
Endpoints for Tenants | |
GET/opt/api/v1/catalog/about | Returns the status of the catalog service. |
POST/opt/api/v1/catalog/tenants/activation | Creates the required index and index mapping for the tenant activation. |
DELETE /opt/api/v1/catalog/tenants/deactivation | Deactivates the tenant and removes the associated mappings and documents. |
Endpoints for Lookup | |
GET/opt/api/v1/catalog/lookup/{entityId} | Retrieves all lookup entries for the specified entity. |
PATCH /opt/api/v1/catalog/lookup/{entityId}/add | Adds the specified set of lookup fields. |
DELETE /opt/api/v1/catalog/lookup/{entityId}/remove | Deletes the specified set of lookup fields |
POST /opt/api/v1/catalog/lookup/bycatalog/{entityCatalogId} | Creates a shared lookup catalog with filtering options by provider_id. |
POST /opt/api/v1/catalog/lookup | Creates an entity in the catalog, if the entity does not exist. |
POST /opt/api/v1/catalog/lookup/sequences | Searches for lookup sequences based on the specified set of mandatory filters on entity IDs and lookup sequences. |
Endpoints for Entities | |
POST/opt/api/v1/catalog/entities | Creates a new entity. |
GET/opt/api/v1/catalog/entities/{entityId} | Retrieves all entities by their entity ID. |
PUT/opt/api/v1/catalog/entities/{entityId} | Updates an entity for the specified entity ID. |
DELETE /opt/api/v1/catalog/entities/{entityId} | Deletes the entity for the specified ID. |
POST /opt/api/v1/catalog/entities/{entityId}/resources | Creates a resource for the specified entity ID. |
PATCH /opt/api/v1/catalog/entities/{entityId}/resources | Adds a resource. |
GET /opt/api/v1/catalog/entities/{entityId}/resources | Retrieves all resources for the entity ID. |
DELETE /opt/api/v1/catalog/entities/{entityId}/resources | Deletes all resources and metrics for the specified entity ID. |
POST /opt/api/v1/catalog/entities/{entityId}/resources/update | Updates the resources. |
GET /opt/api/v1/catalog/entities/{entityId}/resources/{resourceId} | Retrieves all resources for the resource ID. |
PUT /opt/api/v1/catalog/entities/{entityId}/resources/{resourceId} | Updates the resource by ID. |
DELETE /opt/api/v1/catalog/entities/{entityId}/resources/ | Deletes all resources for a resource ID. |
POST /opt/api/v1/catalog/entities/resources/metric-activity | Retrieves the metric activity details for the specified set of metrics. |
POST /opt/api/v1/catalog/entities/resources/{resourceId}/metric-activity | Updates the metric activity for a resource. |
POST /opt/api/v1/catalog/entities/resources/{resourceId}/metric-activity/bulk | Updates the metric activity for a resource in bulk. |
POST /opt/api/v1/catalog/entities/relations | Retrieves the parent/child relations linked to a set of entities. |
POST /opt/api/v1/catalog/entities/{entityId}/relations | Creates a relation. |
GET /opt/api/v1/catalog/entities/{entityId}/relations | Retrieves all relations for an entity ID. |
DELETE /opt/api/v1/catalog/entities/relations/bulk | Deletes all relations for an entity ID in bulk. |
Endpoints for Explore | |
GET /opt/api/v1/catalog/explore/domains/{domainId}/tree | Explores domain relations for a specific domain. |
GET /opt/api/v1/catalog/explore/entities/{entityId}/tree | Explores entities relations for a specific domain. |
POST /opt/api/v1/catalog/explore/entities/{entityId}/tree | Explores entities relations for a specific domain by applying filters. |
Endpoints for Metrics | |
POST /opt/api/v1/catalog/metrics/last | Retrieves configuration data for last (current) values. |
DELETE /opt/api/v1/catalog/metrics/last | Deletes configuration data for last (current) values. |
POST /opt/api/v1/catalog/metrics/last/bulk | Deletes configuration data for last (current) values in bulk. |
Search API | |
POST /opt/api/v1/catalog/search | Searches the catalog resources. |
POST /opt/api/v1/catalog/search/free | Searches the catalog resources with free search text capabilities. |
POST /opt/api/v1/catalog/search/light | Searches the catalog resources and lists IDs associated with a given search. |
POST /opt/api/v1/catalog/search/light/free | Searches the catalog resources with free search text capabilities and lists IDs associated with a given search. |
Endpoints for RBAC | |
POST /opt/api/v1/catalog/rbac/domains/configuration | Updates the groups for the specified domains. |
PUT /opt/api/v1/catalog/rbac/domains/configuration | Adds the groups to the specified domains. |
DELETE /opt/api/v1/catalog/rbac/domains/configuration | Deletes the groups from the specified domains. |
GET /opt/api/v1/catalog/rbac/domains/configuration | Retrieves the list of domains on which visibility privileges are set for the specified group. |
GET /opt/api/v1/catalog/rbac/domains/configuration/{requestId} | Retrieves the status of the RBAC configuration request. |
Endpoints for Entity tag | |
GET/opt/api/v1/catalog/entities/tags/types | Retrieves the list of available tag types. |
POST/opt/api/v1/catalog/entities/tags/types | Retrieves the list of available tag types by entity ID. |
POST/opt/api/v1/catalog/entities/tags | Retrieves the list of available tag types and entity IDs. |
POST/opt/api/v1/catalog/entities/{entityId}/tags | Adds tags to the specified entities |
PATCH/opt/api/v1/catalog/entities/{entityId}/tags | Updates the specified set of tags for given entity. |
DELETE/opt/api/v1/catalog/entities/{entityId}/tags | Deletes the specified set of tags for given entity. |
Forecast endpoints in the REST API
URL to access: https://<host name>/opt/api/forecast/openapi.yaml
This table lists the endpoints for forecast.
API endpoint | Description |
|---|---|
GET /opt/api/forecast/about | Returns the status of the forecast service. |
POST /opt/api/v2/forecast/prediction | Uploads the data series prediction values. |
POST /opt/api/v2/forecast/time_prediction | Uploads the time series prediction values. |
POST /opt/api/v2/forecast/regression | Uploads the data series regression values. |
POST/opt/api/v2/forecast/time_regression | Uploads the time series regression values. |
POST/opt/api/v2/forecast/correlation | Uploads the correlation analysis values. |
POST/opt/api/v2/forecast/extrapolation | Uploads the data series extrapolation values. |
POST/opt/api/v2/forecast/cost | Uploads the forecast costs for the next 12 months based on the aggregated data series. |
Historical Time Series Ingestion endpoints in the REST API
URL to access: https://<host name>/opt/api/htsingest/openapi.yaml
This table lists the endpoints for historical time series ingestion.
API endpoint | Description |
|---|---|
GET/opt/api/htsingest/about | Returns the status of the historical time series ingestion service. |
POST/opt/api/v1/htsingest/relations | Uploads an object relation file archive for processing. |
POST /opt/api/v1/htsingest/tags | Uploads object tags for processing. |
POST /opt/api/v1/htsingest/timeseries | Uploads time series for the specified entity. |
POST/opt/api/v1/htsingest/timeseries/bulk | Uploads time series for the specified entity in bulk. |
POST /opt/api/v1/htsingest/timeseries/{resid} | Uploads time series for a specified resource ID. |
Recommendation endpoints in the REST API
URL to access: https://<host name>/opt/api/optimizer/openapi.yaml
This table lists the endpoints for recommendation.
API endpoint | Description |
|---|---|
GET/opt/api/optimizer/about | Returns the status of the recommendation service. |
POST/opt/api/v1/optimizer/recommendations | Generates recommendations. |
POST/opt/api/v1/optimizer/rules/process | Processes the rules. |
GET/opt/api/v1/optimizer/recommendations/entities/{entity_id} | Retrieves the recommendations that are generated for a specific entity. |
POST/opt/api/v1/optimizer/recommendations/search | Returns the recommendations that match the search criteria. |
Simulation endpoints in the REST API
URL to access: https://<host name>/opt/api/simulation/openapi.yaml
This table lists the endpoints for What-if simulation.
API endpoint | Description |
|---|---|
POST /opt/api/v1/simulation/whatif/execute | Executes a what-if simulation. |
POST /opt/api/v1/simulation/whatif/data | Executes the what-if simulation for an entity and returns the series data. |
POST /opt/api/v1/simulation/whatif/simulations | Saves the simulation. |
GET/opt/api/v1/simulation/whatif/simulations/{id} | Retrieves the saved simulation for the specified ID. |
Data Provider endpoints in the REST API
The table lists the endpoints for data mart and view definition:
API endpoint | Description |
|---|---|
Endpoints for Data mart | |
GET/opt/api/datamarts/about | Status of the data mart service. |
GET/opt/api/v1/datamartservice/datamarts | Retrieves the list of data mart definitions according to the specified ownership. |
POST /opt/api/v1/datamartservice/datamarts/{erid}/data | Creates a data mart with data for the specified data mart ID. |
GET/opt/api/v1/datamartservice/datamarts/{erid}/metadata | Retrieves the list of data marts for the specific data mart ID. |
POST /opt/api/v1/datamartservice/datamarts/exports/excel | Exports the data marts to Excel. |
POST /opt/api/v1/datamartservice/datamarts/{erid}/aggregatedata | Creates a data mart with aggregated data for the specified data mart ID. |
POST /opt/api/v1/datamartservice/datamarts/{erid} | Creates a data mart for the specified data mart ID. |
POST /opt/api/v1/datamartservice/datamarts/{erid}/filters/{filtername} | Creates a data mart for the specified filter name. |
Endpoints for View definition | |
GET/opt/api/v1/viewdefinition/view | Retrieves a list of all capacity views in BMC Helix Continuous Optimization. |
GET/opt/api/v1/viewdefinition/view/{viewid}/export | Exports the configuration of the selected view in file format (.viewpkg). |
POST /opt/api/v1/viewdefinition/view/import | Imports a capacity view from another environment. The request includes the name of the export file in the format: <view name_date of export>.viewpkg. |
Pricing endpoints in the REST API
This table lists the endpoints for pricing.
API endpoint | Description |
|---|---|
Endpoints for AWS Reserved Price Controller | |
GET /api/about | Retrieves the status of the Pricing service. |
GET /api/v1/providers/1/regions/{region_code}/reserved_instance | Returns the on-demand and effective hourly rate for standard EC2 reserved instances. |
GET/api/v1/providers/1/ri_eligible_hours | Retrieves the eligible usage hours for AWS reserved instances. |
GET /api/v1/providers/1/ri_normalization_factors | Retrieves the normalization factors for reserved instances for a specific provider. |
GET /api/v1/providers/1/sku_os_map | Retrieves the SKU to OS mappings. |
Endpoint for Instances Size Pricing | |
GET /api/v1/providers/{providerid}/regions/{region_code}/instance_size/ | Retrieves the instances size for a specific instance type. |
Endpoints for Instances Pricing Controller | |
GET/api/v1/providers/{providerid}/regions/{region_code}/cheapest_instance | Retrieves the cheapest compute and storage instances in a specific region that matches the given resources. |
GET /api/v1/providers/{providerid}/regions/{region_code}/instance_families | Retrieves the available instance families for a specific provider within a region. |
GET /api/v1/providers/{providerid}/regions/{region_code}/instance_types | Retrieves a list of instance types for a specific provider within a region. |
GET/api/v1/providers/{providerid}/regions/{region_code}/instance_types/ | Retrieves the 30 days instance type price for a monthly usage on-demand and for each reservation period (1 year, 3 years) where reservation payment option is standard, All, Upfront. |
GET /api/v1/providers/{providerid}/regions/{region_code}/instance_types/ | Retrieves the list of license types available for a specific instance type within a region. |
Endpoint for License Types Pricing | |
GET /api/v1/providers/{providerid}/license_type | Retrieves a license type that matches either a list of SKUs or a product description. |
Endpoint for Normalization Factors Pricing | |
GET/api/v1/providers/{providerid}/normalization_factors | Retrieves the compute normalization factors for a specific provider for all the instance types. |
Endpoints for regions | |
GET/api/v1/providers/{providerid}/default_region | Retrieves the default region for the specified provider. |
GET /api/v1/providers/{providerid}/regions | Retrieves the available regions for the specified provider. |
GET /api/v1/providers/{providerid}/regions/{region_code} | Retrieves the details of a region for the specified provider. |
Endpoint for Simulation Pricing | |
POST/api/v1/simulation | Retrieves the cheapest compute and storage instances in a specific region that matches the given resources. |
Endpoints for Storage Pricing | |
GET/api/v1/providers/{providerid}/regions/{region_code}/storage_types | Retrieves the storage types for the specified provider ID and the region code. |
GET/api/v1/providers/{providerid}/regions/{region_code}/storage_types/ | Retrieves the storage types for the specified provider ID, region code, and storage ID. |
POST /api/v1/providers/{providerid}/regions/{region_code}/storage_types/ | Retrieves the 30 days cost for the specified storage type. |
GET/api/v1/providers/{providerid}/storage/default_transaction_units | Retrieves the default transaction units for the specified provider. |
Backend Control API
The Backend Control API enables you to remotely manage and control the interactions with the backend components of BMC Helix Continuous Optimization.