Using REST APIs
The Application Programming Interfaces (APIs) are provided as Representational State Transfer (RESTful) web services. You can access these services using clients implemented in any programming language that supports the HTTP protocol. BMC Helix Continuous Optimization provides REST API endpoints to perform all tasks that are currently supported by the application. These REST API endpoints are documented in the OpenAPI UI.
Accessing the OpenAPI host for APIs
- In BMC Helix Portal,
Create an API user
.
Use the secret key to authenticate yourself before you run an endpoint. - From a supported browser, enter the following URL to access the API documentation in OpenAPI:
https://<host name>/opt/api/<service-name>/openapi.yamlFor example, to access the catalog API, enter https://<host name>/opt/api/catalog/openapi.yaml - In the OpenAPI UI, you can access, test, and execute any APIs supported by the service.
To see example parameters for any of the following endpoints, click Try it out. Retain the example values for the parameters, or replace them with any valid value. Then click Execute to see the Curl command, request URL, and the response body for the request.
Agent Data endpoints
URL to access: https://<host name>/opt/api/agentdata/openapi.yaml
openapi: 3.0.2
info:
version: 1.0.1
title: Agent Data Service
paths:
/opt/api/agentdata/about:
get:
summary: About info
description: About info
operationId: about
tags:
- About
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AboutInfo'
/opt/api/v1/agentdata/gwsrequest:
post:
summary: Post GWS Request
description: Post GWS Request
operationId: postgwsrequest
tags:
- GWSRequest
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GWSSoapRequest'
responses:
'201':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GWSSoapResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
put:
summary: Put GWS Request
description: Put GWS Request
operationId: putgwsrequest
tags:
- GWSRequest
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GWSCompletionRequest'
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'/opt/api/v1/agentdata/gwsrequest/{gws_id}':
get:
summary: Get GWS Request
description: Get GWS Request
operationId: getgwsrequest
tags:
- GWSRequest
parameters:
- name: gws_id
description: The gws id
in: path
required: true
schema:
type: string
example: 'https:%2F%2Fgws1.company.com:port'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GWSGetItemsResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
Analysis endpoints
URL to access: https://<host name>/opt/api/analysis/openapi.yaml
openapi: 3.0.3
info:
version: 1.5.9
title: Analysis Service
tags:
- name: Analysis
description: Run analyses and check their status
- name: About
description: The status of the service
- name: Executions
description: Get execution status of asynchronous requests
- name: Results
description: Get details and assets produced by asynchronous executions
- name: Entity Filter
description: Resolve entity filters and get related entity ids
- name: Threshold
description: Extract thresholds for entites and metrics
- name: Queueing Network Model
description: Create Queueing Network model properties
- name: Time Filter
description: Resolve time filters
paths:
/opt/api/analysis/about:
get:
summary: About info
description: About info
operationId: about
tags:
- About
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AboutInfo'
deprecated: false
/opt/api/v1/analysis/execute:
post:
summary: Execute analysis
description: Executes an analysis and returns results synchronously
operationId: executeAnalysis
tags:
- Analysis
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnalysisExecutionRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/ChartResults'
'400':
$ref: '#/components/responses/BadRequest'
'500':
$ref: '#/components/responses/InternalServerError'
/opt/api/v1/analysis/execute_real_time:
post:
summary: Execute analysis for real time scenarios (user requests)
description: >-
Executes an analysis and returns results synchronously. Used for real
time scenarios (user requests)
operationId: executeAnalysisRealTime
tags:
- Analysis
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnalysisExecutionRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/ChartResults'
'400':
$ref: '#/components/responses/BadRequest'
'500':
$ref: '#/components/responses/InternalServerError'
/opt/api/v1/analysis/execute_async:
post:
summary: Execute analysis asynchronously
description: Executes an analysis asynchronously
operationId: executeAnalysisAsync
tags:
- Analysis
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnalysisExecutionAsyncRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AnalysisAsyncResponse'
'400':
$ref: '#/components/responses/BadRequest'
'500':
$ref: '#/components/responses/InternalServerError'
'/opt/api/v1/analysis/executions/{execution_id}':
get:
summary: Retrieve the status of an analysis execution
description: Retrieve the status of an analysis execution
operationId: getExecutionById
tags:
- Executions
parameters:
- name: execution_id
in: path
description: Id of the analysis execution
required: true
schema:
type: string
pattern: '^[\w-]+$'
responses:
'200':
description: The details of the requested execution
content:
application/json:
schema:
$ref: '#/components/schemas/ExecutionResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
delete:
summary: Cancel the analysis execution by execution id
description: Kill (if running) or cancel the analysis execution by execution id
operationId: cancelExecutionById
tags:
- Executions
parameters:
- name: execution_id
in: path
description: Id of the analysis execution
required: true
schema:
type: string
responses:
'202':
description: kill request accepted
content:
application/json:
schema:
$ref: '#/components/schemas/KillResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/BadRequest'
'410':
$ref: '#/components/responses/BadRequest'
'500':
$ref: '#/components/responses/InternalServerError'
/opt/api/v1/analysis/executions:
get:
summary: Retrieve recent execution results
description: Retrieve recent execution results for the current user
operationId: getExecutions
tags:
- Executions
parameters:
- name: all
in: query
description: >-
If true and the user has admin rights, it returns recent execution
results for all users
schema:
type: boolean
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/ExecutionsResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'/opt/api/v1/analysis/executions/tag/{external_group_id}':
get:
summary: Retrieve the list of all executions with a specific tag
description: Retrieve the list of all executions with a specific tag
operationId: getExecutionsByTag
tags:
- Executions
parameters:
- name: external_group_id
in: path
description: tag group id
required: true
schema:
type: string
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/ExecutionsResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
delete:
summary: Cancel all the executions with a specific tag
description: >-
Kill (if running) or cancel the execution of all the executions with a
specific tag
operationId: cancelExecutionsByTag
tags:
- Executions
parameters:
- name: external_group_id
in: path
description: tag group id
required: true
schema:
type: string
responses:
'202':
description: Cancellation request accepted
content:
application/json:
schema:
$ref: '#/components/schemas/ExecutionCancelResponse'
'400':
$ref: '#/components/responses/BadRequest'
'500':
$ref: '#/components/responses/InternalServerError'
'/opt/api/v1/analysis/results/{type}/{id}':
get:
summary: Retrieve execution details
description: Retrieve the details of the analysis/model with the selected plot id
operationId: getResults
tags:
- Results
parameters:
- name: type
in: path
required: true
schema:
$ref: '#/components/schemas/ExecutionType'
- name: id
in: path
required: true
schema:
type: integer
description: The id of the plot or model
example: 13834
- name: session_id
in: query
description: >-
The session id is used to avoid concurrent modification for multiple
executions for the same analysis. Pass the session id to retrieve
execution results related to a specific user session. Without
session id, results produced by the latest execution overall will be
returned.
schema:
type: string
pattern: '^[\w-]+$'
example: 312f30e7-28a2-4b7a-8c8a-cecff9894a19
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/ExecutionResults'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'/opt/api/v1/analysis/results/{type}/{id}/chart/{chart_id}':
get:
summary: Retrieve chart details
description: Retrieve chart details
operationId: getResultsByChart
tags:
- Results
parameters:
- name: type
in: path
required: true
schema:
$ref: '#/components/schemas/ExecutionType'
- name: id
in: path
description: The id of analysis or model
required: true
schema:
type: integer
- name: chart_id
in: path
description: The id of the chart
required: true
schema:
type: integer
- name: session_id
in: query
description: id of session
required: false
schema:
type: string
responses:
'200':
description: The details of the requested result
content:
application/json:
schema:
$ref: '#/components/schemas/ChartResults'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'/opt/api/v1/analysis/entity_filter/{id}':
get:
summary: Resolve entity filter
description: >-
Resolves an existing entity filter and returns the list of corresponding
entities.
operationId: resolveEntityFilter
tags:
- Entity Filter
parameters:
- name: id
in: path
required: true
schema:
type: integer
description: The id of the entity filter
example: 13
- name: current_app_id
in: query
required: false
schema:
type: integer
description: The id of the current domain
example: 13
- name: last_activity_since
in: query
required: false
schema:
type: string
description: >-
Filter entities based on metrics last activity timestamp,
expressed in ISO 8601 format.
example: 2020-01-01T00:15:00.000Z
- name: include_administrative_domains
in: query
required: false
schema:
type: boolean
description: >-
Determines if administrative domains should be included in the
resolved entities. Defaults to false.
example: false
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/EntityFilterResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/opt/api/v1/analysis/entity_filter:
post:
summary: Resolve dynamic entity filter
description: >-
Resolves the entity filter defined in the request and returns the list
of corresponding entities.
operationId: resolveDynamicEntityFilter
tags:
- Entity Filter
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EntityFilterRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/EntityFilterResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'/opt/api/v1/analysis/threshold/{structure_id}':
post:
summary: Extract threshold for entities and metrics
description: Extracts thresholds given entity ids and metrics.
operationId: extractThreshold
tags:
- Threshold
parameters:
- name: structure_id
in: path
description: requested entities structure id
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ThresholdExtractionRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/ThresholdExtractionResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/opt/api/v1/analysis/time_filter:
post:
summary: >-
Evaluates the since-to time period using the global time filter or the
lastex parameter
description: >-
Based on global time filter or on lastex parameter evaluates and returns
the since-to time period.
operationId: evaluateTimePeriod
tags:
- Time Filter
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TimeFilterRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/TimeFilterResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/opt/api/v1/analysis/correlation:
post:
summary: Analyze correlation of systems/metrics
description: Evaluates correlation coefficients among systems/metrics
operationId: correlation
x-permissions:
- analysis.read
- analysis.edit
tags:
- Analysis
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CorrelationRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/CorrelationResults'
'400':
$ref: '#/components/responses/BadRequest'
'500':
$ref: '#/components/responses/InternalServerError'
/opt/api/v1/analysis/qnmodel:
post:
summary: Creates Queueing Network model properties
description: Creates Queueing Network model properties
operationId: createQNetworkModelProperties
x-permissions:
- models.edit
tags:
- Queueing Network Model
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QNetworkModelRequest'
responses:
'200':
description: Returns Queueing Network model property map
content:
application/json:
schema:
$ref: '#/components/schemas/QNetworkModelResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'/opt/api/v1/analysis/qnmodel/{tcid}':
post:
summary: Evaluates the queuing network model and returns updated model properties
description: >-
Evaluates the queuing network model, applies object model updates if
they exist, and returns the updated model properties
operationId: evaluateAndGetQNetworkModelProperties
x-permissions:
- models.edit
tags:
- Queueing Network Model
parameters:
- name: tcid
in: path
description: the id of the Test Condition scenario
required: true
schema:
type: integer
responses:
'200':
description: Returns Queueing Network model property map
content:
application/json:
schema:
$ref: '#/components/schemas/QNetworkModelResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
Catalog endpoints
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 | Creates the required index and index mapping for the tenant activation. |
DELETE | 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 | Adds the specified set of lookup fields. |
DELETE | Deletes the specified set of lookup fields |
POST | Creates a shared lookup catalog with filtering options by provider_id. |
POST | Creates an entity in the catalog, if the entity does not exist. |
POST | Searches for lookup sequences based on the specified set of mandatory filters on entity IDs and lookup sequences. |
| Endpoints for Entities | |
POST | Creates a new entity. |
GET/opt/api/v1/catalog/entities/{entityId} | Retrieves all entities by their entity ID. |
PUT | Updates an entity for the specified entity ID. |
DELETE | Deletes the entity for the specified ID. |
POST | Creates a resource for the specified entity ID. |
PATCH | Adds a resource. |
GET /opt/api/v1/catalog/entities/{entityId}/resources | Retrieves all resources for the entity ID. |
DELETE | Deletes all resources and metrics for the specified entity ID. |
POST | Updates the resources. |
GET /opt/api/v1/catalog/entities/{entityId}/resources/{resourceId} | Retrieves all resources for the resource ID. |
PUT | Updates the resource by ID. |
DELETE | Deletes all resources for a resource ID. |
POST | Retrieves the metric activity details for the specified set of metrics. |
POST | Updates the metric activity for a resource. |
POST | Updates the metric activity for a resource in bulk. |
POST | Retrieves the parent/child relations linked to a set of entities. |
POST | Creates a relation. |
GET /opt/api/v1/catalog/entities/{entityId}/relations | Retrieves all relations for an entity ID. |
DELETE | 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 | Explores entities relations for a specific domain by applying filters. |
| Endpoints for Metrics | |
POST | Retrieves configuration data for last (current) values. |
DELETE | Deletes configuration data for last (current) values. |
POST | Deletes configuration data for last (current) values in bulk. |
| Search API | |
POST | Searches the catalog resources. |
POST | Searches the catalog resources with free search text capabilities. |
POST | Searches the catalog resources and lists IDs associated with a given search. |
POST | Searches the catalog resources with free search text capabilities and lists IDs associated with a given search. |
| Endpoints for RBAC | |
| Updates the groups for the specified domains. |
PUT | Adds the groups to the specified domains. |
DELETE | 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}/status | 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 | Retrieves the list of available tag types by entity ID. |
POST | Retrieves the list of available tag types and entity IDs. |
POST/ | Adds tags to the specified entities |
PATCH/ | Updates the specified set of tags for given entity. |
DELETE/ | Deletes the specified set of tags for given entity. |
Forecast endpoints
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
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
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
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
https://<host name>/openapi/datamart
https://<host name>//openapi/view
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 datamart 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 datamart with data for the specified datamart ID. |
GET/opt/api/v1/datamartservice/datamarts/{erid}/metadata | Retrieves the list of data marts for the specific datamart 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 datamart with aggregated data for the specified datamart ID. |
POST /opt/api/v1/datamartservice/datamarts/{erid} | Creates a datamart for the specified datamart ID. |
POST /opt/api/v1/datamartservice/datamarts/{erid}/filters/{filtername} | Creates a datamart 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 | 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
https://<host name>/openapi/pricing
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/{instance_type} | 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/{instance_type_id} | 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/{instance_type_id}/license_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/{storage_id} | Retrieves the storage types for the specified provider ID, region code, and storage ID. |
POST /api/v1/providers/{providerid}/regions/{region_code}/storage_types/{storage_id}/cost | 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.
Was this page helpful? Yes No
Submitting...
Thank you
Comments
Log in or register to comment.