Submit Upfront Price Request For Catalog Item

Returns upfront price response for a given catalog item.

Request

URI

POST

https://{api_host}/catalog/api/items/{id}/upfront-prices

COPY

Path Parameters

string

Required

Catalog Item ID

Request Body

CatalogItemRequest of type(s) application/json

Required

{
    "bulkRequestCount": 0,
    "deploymentName": "string",
    "inputs": {},
    "projectId": "string",
    "reason": "string",
    "version": "string"
}

integer As int32 As int32

bulkRequestCount

Optional

Deployment request count; defaults to 1 if not specified.

string

deploymentName

Optional

Constraints: maxLength: 900

Name of the requested deployment

object

inputs

Optional

inputs

string

projectId

Optional

Project to be used for the request

string

reason

Optional

Constraints: maxLength: 10240

Reason for request

string

version

Optional

Version of the catalog item. e.g. v2.0

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Returns CatalogItemUpfrontPriceResponse of type(s) application/json

"CatalogItemUpfrontPriceResponse Object"

number

dailyAdditionalPrice

Optional

Additional Price incurred for the catalog.

number

dailyComputePrice

Optional

Compute Price of the catalog.

number

dailyNetworkPrice

Optional

Network Price of the catalog.

number

dailyStoragePrice

Optional

Storage Price of the catalog.

number

dailyTotalPrice

Optional

Total Price of the catalog.

array of object

resourcePriceDetails

Optional

A response with upfront price for a resource in given catalog item

string

status

Optional

Upfront price sync status

Possible values are : STARTED, PREPARING_COST_ESTIMATION, IN_PROGRESS, SUCCESS, ERROR, DATA_NOT_AVAILABLE, CURRENCY_NOT_SET, PUBLIC_CLOUD_NOT_SUPPORTED,

string

statusDetails

Optional

Upfront price status detail.

string

unit

Optional

Monetary unit.

string

upfrontPriceId

Optional

401

Unauthorized

Returns CatalogItemUpfrontPriceResponse of type(s) application/json

"CatalogItemUpfrontPriceResponse Object"

number

dailyAdditionalPrice

Optional

Additional Price incurred for the catalog.

number

dailyComputePrice

Optional

Compute Price of the catalog.

number

dailyNetworkPrice

Optional

Network Price of the catalog.

number

dailyStoragePrice

Optional

Storage Price of the catalog.

number

dailyTotalPrice

Optional

Total Price of the catalog.

array of object

resourcePriceDetails

Optional

A response with upfront price for a resource in given catalog item

string

status

Optional

Upfront price sync status

Possible values are : STARTED, PREPARING_COST_ESTIMATION, IN_PROGRESS, SUCCESS, ERROR, DATA_NOT_AVAILABLE, CURRENCY_NOT_SET, PUBLIC_CLOUD_NOT_SUPPORTED,

string

statusDetails

Optional

Upfront price status detail.

string

unit

Optional

Monetary unit.

string

upfrontPriceId

Optional

404

Not Found

Returns CatalogItemUpfrontPriceResponse of type(s) application/json

"CatalogItemUpfrontPriceResponse Object"

number

dailyAdditionalPrice

Optional

Additional Price incurred for the catalog.

number

dailyComputePrice

Optional

Compute Price of the catalog.

number

dailyNetworkPrice

Optional

Network Price of the catalog.

number

dailyStoragePrice

Optional

Storage Price of the catalog.

number

dailyTotalPrice

Optional

Total Price of the catalog.

array of object

resourcePriceDetails

Optional

A response with upfront price for a resource in given catalog item

string

status

Optional

Upfront price sync status

Possible values are : STARTED, PREPARING_COST_ESTIMATION, IN_PROGRESS, SUCCESS, ERROR, DATA_NOT_AVAILABLE, CURRENCY_NOT_SET, PUBLIC_CLOUD_NOT_SUPPORTED,

string

statusDetails

Optional

Upfront price status detail.

string

unit

Optional

Monetary unit.

string

upfrontPriceId

Optional

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/catalog/api/items/{id}/upfront-prices

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Catalog Items Operations

GET

Get Catalog Items