Search service catalog items with pricing

1 min

GET

https://app.amberflo.io/business-unit/service-catalog/search

List available service catalog items and their prices

Query Parameters

visibilitystring
providersstring[]
categoriesstring[]
servicesstring[]
meterApiNamesstring[]
regionsstring[]
pricingUnitsstring[]
descriptionLikestring
timeInSecondsinteger<int64>
Description
When looking for Amberflo catalog items, this indicates the time (in {unixEpochSeconds} when the item was active. Defaults to 'now'.
limitinteger<int32>
pageinteger<int32>

Responses

200Successful request

business_unit.service_catalog.query.ServiceCatalogItemPage.out
- metadatabusiness_unit.service_catalog.query.ServiceCatalogItemPageMetadata.out
  - visibilitybusiness_unit.service_catalog.CatalogVisibility.out
    Description
    Service catalog item visibility level controlling access and discovery within business unit service catalogs. **Values:** - **PUBLIC:** Service visible to all business units and users in account - **PRIVATE:** Service restricted to specific business units or authorized users only
  - providersbusiness_unit.common.DataProvider.out[]
    Description
    Cloud provider identifier for cost data and service catalog filtering. Supported values include AWS (Amazon Web Services), AZURE (Microsoft Azure), GOOGLE_CLOUD (Google Cloud Platform), and AMBERFLO (internal Amberflo services for meter-based billing).
  - categoriesstring[]
  - servicesstring[]
  - meterApiNamesstring[]
  - regionsstring[]
  - pricingUnitsstring[]
  - descriptionLikestring
  - timeInSecondsinteger<int64>
    Description
    When looking for Amberflo catalog items, this indicates the time (in {unixEpochSeconds} when the item was active. Defaults to 'now'.
  - limitinteger<int32>
  - pageinteger<int32>
  - filteredRowCountinteger<int32>
  - totalFilteredPagesinteger<int32>
- itemsbusiness_unit.service_catalog.ServiceCatalogItem.out[]
  - providerbusiness_unit.common.DataProvider.out
    Description
    Name of the cloud provider
  - categorystring
    Description
    Category of the service
  - servicestring
    Description
    Name of the cloud service, or the meter label when `provider = amberflo`
  - meterApiNamestring
    Description
    `meterApiName` as defined in [Meter API](ref:post_meters) when `provider = amberflo`, otherwise not set.
  - dimensionsmap<string, string>
    Description
    Usage dimensions when `provider = amberflo`, otherwise not set.
  - pricingUnitstring
    Description
    Unit of measurement for the pricing
  - regionstring
    Description
    Region of the service
  - descriptionstring
    Description
    Description of the resource
  - currencystring
    Example
    USD
    Description
    Currency of the price
  - listUnitPricenumber
    Description
    List price per unit
  - contractedUnitPricenumber
    Description
    Contracted price per unit

curl

curl --request GET \
     --url https://app.amberflo.io/business-unit/service-catalog/search \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://app.amberflo.io/business-unit/service-catalog/search", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://app.amberflo.io/business-unit/service-catalog/search")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://app.amberflo.io/business-unit/service-catalog/search"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Successful request
{
  "metadata": {
    "visibility": "",
    "providers": [
      ""
    ],
    "categories": [
      ""
    ],
    "services": [
      ""
    ],
    "meterApiNames": [
      ""
    ],
    "regions": [
      ""
    ],
    "pricingUnits": [
      ""
    ],
    "descriptionLike": "",
    "timeInSeconds": "",
    "limit": "",
    "page": "",
    "filteredRowCount": "",
    "totalFilteredPages": ""
  },
  "items": [
    {
      "provider": "",
      "category": "",
      "service": "",
      "meterApiName": "",
      "dimensions": "",
      "pricingUnit": "",
      "region": "",
      "description": "",
      "currency": "USD",
      "listUnitPrice": 0,
      "contractedUnitPrice": 0
    }
  ]
}