Authenticated unlisted Product Catalog API

Other endpoints

Download schema

Estimates the environmental impact of using a elastic metal server for a given amount of time.

POST

https://api.scaleway.com

/product-catalog/v2alpha1/estimate-elastic-metal-usage

Estimates the environmental impact of using a elastic metal server for a given amount of time. › Request Body

offer_id

string[]

Offer ID of the Elastic Metal server, if not specified default is all offers.

zone

string

Zone in which the Elastic Metal server is, if not specified default is all zones.

duration

string

Amount of time the given service is used for, e.g. '2d3h15m', if not specified default is 1 month. (in seconds)

Estimates the environmental impact of using a elastic metal server for a given amount of time. › Responses

200

scaleway.product_catalog.v2alpha1.EstimateElasticMetalUsageImpactResponse

object · required

Total environmental impact of the usage.

scaleway.product_catalog.v2alpha1.ElasticMetalUsageImpactDetail[] · required

Breakdown of the environmental impact of each specific Elastic Metal usage.

POST/product-catalog/v2alpha1/estimate-elastic-metal-usage

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"zone":"string"}' \
  "https://api.scaleway.com/product-catalog/v2alpha1/estimate-elastic-metal-usage"

Example Request Body

{
  "offer_id": [
    "string"
  ],
  "zone": "zone",
  "duration": "2.5s"
}

json

Example Responses

{
  "total_impact": {
    "kg_co2_equivalent": 0,
    "m3_water_usage": 0
  },
  "details": [
    {
      "usage": {
        "offer_id": "offer_id",
        "zone": "zone",
        "duration": "2.5s"
      },
      "total_impact": {
        "kg_co2_equivalent": 0,
        "m3_water_usage": 0
      },
      "manufacture_impact": {
        "kg_co2_equivalent": 0,
        "m3_water_usage": 0
      },
      "usage_impact": {
        "kg_co2_equivalent": 0,
        "m3_water_usage": 0
      },
      "base_impact": {
        "kg_co2_equivalent": 0,
        "m3_water_usage": 0
      },
      "green_score": 0
    }
  ]
}

json

application/json

Estimates the environmental impact using the server's offer information for a given amount of time.

POST

https://api.scaleway.com

/product-catalog/v2alpha1/estimate-offer-usage-impact

Estimates the environmental impact using the server's offer information for a given amount of time. › Request Body

scaleway.product_catalog.v2alpha1.OfferUsage[] · required

One or more usages of Scaleway products for given durations and offer ID.

Estimates the environmental impact using the server's offer information for a given amount of time. › Responses

200

scaleway.product_catalog.v2alpha1.EstimateOfferUsageImpactResponse

object · required

Total environmental impact of the usage.

scaleway.product_catalog.v2alpha1.OfferUsageImpactDetail[] · required

Breakdown of the environmental impact of each specific usage.

POST/product-catalog/v2alpha1/estimate-offer-usage-impact

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"usages":[""]}' \
  "https://api.scaleway.com/product-catalog/v2alpha1/estimate-offer-usage-impact"

Example Request Body

{
  "usages": [
    {
      "dedibox": {
        "offer_id": 0,
        "data_center": "data_center"
      },
      "duration": "2.5s"
    }
  ]
}

json

Example Responses

{
  "total_impact": {
    "kg_co2_equivalent": 0,
    "m3_water_usage": 0
  },
  "details": [
    {
      "usage": {
        "dedibox": {
          "offer_id": 0,
          "data_center": "data_center"
        },
        "duration": "2.5s"
      },
      "total_impact": {
        "kg_co2_equivalent": 0,
        "m3_water_usage": 0
      },
      "manufacture_impact": {
        "kg_co2_equivalent": 0,
        "m3_water_usage": 0
      },
      "usage_impact": {
        "kg_co2_equivalent": 0,
        "m3_water_usage": 0
      },
      "base_impact": {
        "kg_co2_equivalent": 0,
        "m3_water_usage": 0
      },
      "green_score": 0
    }
  ]
}

json

application/json

Product catalog

Estimates the environmental impact of using a elastic metal server for a given amount of time.

POST

https://api.scaleway.com

/product-catalog/v2alpha1/estimate-elastic-metal-usage

Estimates the environmental impact of using a elastic metal server for a given amount of time. › Request Body

offer_id

string[]

Offer ID of the Elastic Metal server, if not specified default is all offers.

zone

string

Zone in which the Elastic Metal server is, if not specified default is all zones.

duration

string

Amount of time the given service is used for, e.g. '2d3h15m', if not specified default is 1 month. (in seconds)

Estimates the environmental impact of using a elastic metal server for a given amount of time. › Responses

200

scaleway.product_catalog.v2alpha1.EstimateElasticMetalUsageImpactResponse

object · required

Total environmental impact of the usage.

scaleway.product_catalog.v2alpha1.ElasticMetalUsageImpactDetail[] · required

Breakdown of the environmental impact of each specific Elastic Metal usage.

Estimates the environmental impact using the server's offer information for a given amount of time.

POST

https://api.scaleway.com

/product-catalog/v2alpha1/estimate-offer-usage-impact

Estimates the environmental impact using the server's offer information for a given amount of time. › Request Body

scaleway.product_catalog.v2alpha1.OfferUsage[] · required

One or more usages of Scaleway products for given durations and offer ID.

Estimates the environmental impact using the server's offer information for a given amount of time. › Responses

200

scaleway.product_catalog.v2alpha1.EstimateOfferUsageImpactResponse

object · required

Total environmental impact of the usage.

scaleway.product_catalog.v2alpha1.OfferUsageImpactDetail[] · required

Breakdown of the environmental impact of each specific usage.