Retrieves a monitored asset by id.

GET

/api/v1/provision/admin/monitored-assets/{assetId}

curl --request GET \
  --url https://example.com/api/v1/provision/admin/monitored-assets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Parameters

Path Parameters

assetId

required

string format: uuid

Monitored asset id.

Responses

200

OK

A usage-tracked metric on a product or entitlement. Depending on how it is charged, either AssetMeteredUsageDto? MonitoredAssetDto.MeteredUsage (tiered, period-based metering) or AssetBalanceUsageDto? MonitoredAssetDto.BalanceUsage (prepaid credit balance) is attached.

object

id

string format: uuid

entitlementId

null | string format: uuid

productId

null | string format: uuid

metricName

string

name

string

description

string

unit

string

category

string

tags

Array<string>

numberFormat

string

metricType

How reported usage values are interpreted and aggregated by the monitoring pipeline.

Allowed values: CumulativeCounter TotalCounter Gauge UpDownCounter

meteredUsageId

null | string format: uuid

meteredUsage

One of:

null

null

object

Admin view of tiered, period-based metering on a monitored asset: the usage tiers, the consumption period they reset on, and how usage accumulates across tiers.

object

id

string format: uuid

suspendedUntilAt

Consumption is suspended until this time (e.g. after an overage); null when not suspended.

null | string format: date-time

lastReportedOverageSeverityStatus

Severity of consumption relative to the configured usage tiers.

Allowed values: None Normal Warning Critical OverUsage

usageTiers

Array<object>

Represents a tier of usage with associated credits and severity status.

object

startUsage

Gets or sets the start usage for the tier.

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

startPercentage

Tier start as a percentage of the feature value (percentage-based enforcement).

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

endUsage

Gets or sets the end usage for the tier. Nullable.

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

endPercentage

Tier end as a percentage of the feature value (percentage-based enforcement).

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

baseCredits

Gets or sets the flat fee credits for the tier.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

creditsPerUnitOfConsumption

Gets or sets the credits per unit of consumption for the tier.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

name

Gets or sets the name of the usage tier.

string

quotaUsageLevel

Gets or sets the overage severity status for the tier.

Allowed values: None Normal Warning Critical OverUsage

quotaUsagePolicy

Defines the enforcement behavior applied by the resource controller or interceptor when a specific usage tier threshold is reached. Ordered from least to most restrictive.

Allowed values: None NotifyOnly AllowWithOverage AllowWithGrace RateLimit Deny SuspendUsage

fundingBalanceMetric

Metric name of the credit balance, on the same entitlement, that pays for consumption in this tier. Only meaningful on a tier whose policy is AllowWithOverage: name a balance and every unit past the tier’s start is priced and charged to it on commit, refusing the commit when it cannot be paid for; leave it empty and the overage is allowed and merely reported.

string

consumptionPeriod

Name of the consumption period the tiers reset on (see ConsumptionPeriodType), e.g. "Monthly".

string

accumulationMethod

How periodic consumption is attributed across usage tiers for charging.

Allowed values: Sliced HighestTierReached

balanceUsageId

null | string format: uuid

balanceUsage

One of:

null

null

object

Admin view of a prepaid credit balance on a monitored asset: credits available, consumed, quota thresholds, and the automatic re-balance (top-up) schedule.

object

id

string format: uuid

name

string

description

string

creditsUsed

Consumed credits since last deposit. Remaining credits are calculated as TotalCredits - CreditsUsed.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

totalCredits

Total available credits.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

cumulativeCreditsUsed

The total of all credits used over time.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

unfundedCredits

Consumption this balance was asked to pay for and could not: usage the vendor is owed and has not been paid for. Cumulative, and not reduced by a later top-up.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

lastUnfundedAt

When this balance last failed to cover consumption that had already happened.

null | string format: date-time

unit

string

numberFormat

string

lastDeposit

string format: date-time

usageQuota

Array<object>

A named quota threshold on a credit balance and the severity level it maps to.

object

endUsage

Remaining-balance threshold for this band: the band applies while the credit balance is below this value, and when several bands match the lowest threshold wins. A matching band at Critical severity blocks further deductions.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

name

string

quotaUsageLevel

Severity of consumption relative to the configured quotas.

Allowed values: None Normal Warning Critical OverUsage

suspendedUntilAt

Consumption is suspended until this time (e.g. after an overage); null when not suspended.

null | string format: date-time

overageSeverityStatus

Severity of consumption relative to the configured quotas.

Allowed values: None Normal Warning Critical OverUsage

initialCreditAmount

The credits available when the entitlement is created.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

isUnlimitedCredits

Indicates if the resource has unlimited credits.

boolean

autoBalanceCronSchedule

Cron schedule for automatic credit balance. The cron syntax consists of five fields separated by spaces:

• Minute (0-59)
• Hour (0-23)
• Day of the Month (1-31)
• Month (1-12 or Jan-Dec)
• Day of the Week (0-6 or Sun-Sat) Special characters:
• • (asterisk): Represents any value for the field.
• , (comma): Separates multiple values.
• • (hyphen): Specifies a range of values.
• / (slash): Specifies increments. Example: “0 0 * * *” means “at midnight every day.”

null | string

lastAutoBalanceDate

Date and time of the last automatic credit balance.

string format: date-time

shouldAutoBalanceTransferCurrentCredits

Indicates if the current credits should be transferred.

boolean

maxAutoBalanceCreditTransferAmount

Maximum amount of credits that can be transferred automatically.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

autoBalanceCreditAmount

Amount of credits to balance automatically.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

allowedBackDatingTolerance

How far in the past a reported usage value’s timestamp may lie and still be accepted.

string

/^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$/

A usage-tracked metric on a product or entitlement. Depending on how it is charged, either AssetMeteredUsageDto? MonitoredAssetDto.MeteredUsage (tiered, period-based metering) or AssetBalanceUsageDto? MonitoredAssetDto.BalanceUsage (prepaid credit balance) is attached.

object

id

string format: uuid

entitlementId

null | string format: uuid

productId

null | string format: uuid

metricName

string

name

string

description

string

unit

string

category

string

tags

Array<string>

numberFormat

string

metricType

How reported usage values are interpreted and aggregated by the monitoring pipeline.

Allowed values: CumulativeCounter TotalCounter Gauge UpDownCounter

meteredUsageId

null | string format: uuid

meteredUsage

One of:

null

null

object

Admin view of tiered, period-based metering on a monitored asset: the usage tiers, the consumption period they reset on, and how usage accumulates across tiers.

object

id

string format: uuid

suspendedUntilAt

Consumption is suspended until this time (e.g. after an overage); null when not suspended.

null | string format: date-time

lastReportedOverageSeverityStatus

Severity of consumption relative to the configured usage tiers.

Allowed values: None Normal Warning Critical OverUsage

usageTiers

Array<object>

Represents a tier of usage with associated credits and severity status.

object

startUsage

Gets or sets the start usage for the tier.

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

startPercentage

Tier start as a percentage of the feature value (percentage-based enforcement).

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

endUsage

Gets or sets the end usage for the tier. Nullable.

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

endPercentage

Tier end as a percentage of the feature value (percentage-based enforcement).

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

baseCredits

Gets or sets the flat fee credits for the tier.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

creditsPerUnitOfConsumption

Gets or sets the credits per unit of consumption for the tier.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

name

Gets or sets the name of the usage tier.

string

quotaUsageLevel

Gets or sets the overage severity status for the tier.

Allowed values: None Normal Warning Critical OverUsage

quotaUsagePolicy

Defines the enforcement behavior applied by the resource controller or interceptor when a specific usage tier threshold is reached. Ordered from least to most restrictive.

Allowed values: None NotifyOnly AllowWithOverage AllowWithGrace RateLimit Deny SuspendUsage

fundingBalanceMetric

Metric name of the credit balance, on the same entitlement, that pays for consumption in this tier. Only meaningful on a tier whose policy is AllowWithOverage: name a balance and every unit past the tier’s start is priced and charged to it on commit, refusing the commit when it cannot be paid for; leave it empty and the overage is allowed and merely reported.

string

consumptionPeriod

Name of the consumption period the tiers reset on (see ConsumptionPeriodType), e.g. "Monthly".

string

accumulationMethod

How periodic consumption is attributed across usage tiers for charging.

Allowed values: Sliced HighestTierReached

balanceUsageId

null | string format: uuid

balanceUsage

One of:

null

null

object

Admin view of a prepaid credit balance on a monitored asset: credits available, consumed, quota thresholds, and the automatic re-balance (top-up) schedule.

object

id

string format: uuid

name

string

description

string

creditsUsed

Consumed credits since last deposit. Remaining credits are calculated as TotalCredits - CreditsUsed.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

totalCredits

Total available credits.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

cumulativeCreditsUsed

The total of all credits used over time.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

unfundedCredits

Consumption this balance was asked to pay for and could not: usage the vendor is owed and has not been paid for. Cumulative, and not reduced by a later top-up.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

lastUnfundedAt

When this balance last failed to cover consumption that had already happened.

null | string format: date-time

unit

string

numberFormat

string

lastDeposit

string format: date-time

usageQuota

Array<object>

A named quota threshold on a credit balance and the severity level it maps to.

object

endUsage

Remaining-balance threshold for this band: the band applies while the credit balance is below this value, and when several bands match the lowest threshold wins. A matching band at Critical severity blocks further deductions.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

name

string

quotaUsageLevel

Severity of consumption relative to the configured quotas.

Allowed values: None Normal Warning Critical OverUsage

suspendedUntilAt

Consumption is suspended until this time (e.g. after an overage); null when not suspended.

null | string format: date-time

overageSeverityStatus

Severity of consumption relative to the configured quotas.

Allowed values: None Normal Warning Critical OverUsage

initialCreditAmount

The credits available when the entitlement is created.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

isUnlimitedCredits

Indicates if the resource has unlimited credits.

boolean

autoBalanceCronSchedule

Cron schedule for automatic credit balance. The cron syntax consists of five fields separated by spaces:

• Minute (0-59)
• Hour (0-23)
• Day of the Month (1-31)
• Month (1-12 or Jan-Dec)
• Day of the Week (0-6 or Sun-Sat) Special characters:
• • (asterisk): Represents any value for the field.
• , (comma): Separates multiple values.
• • (hyphen): Specifies a range of values.
• / (slash): Specifies increments. Example: “0 0 * * *” means “at midnight every day.”

null | string

lastAutoBalanceDate

Date and time of the last automatic credit balance.

string format: date-time

shouldAutoBalanceTransferCurrentCredits

Indicates if the current credits should be transferred.

boolean

maxAutoBalanceCreditTransferAmount

Maximum amount of credits that can be transferred automatically.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

autoBalanceCreditAmount

Amount of credits to balance automatically.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

allowedBackDatingTolerance

How far in the past a reported usage value’s timestamp may lie and still be accepted.

string

/^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$/

Example

{
  "metricType": "CumulativeCounter",
  "meteredUsage": {
    "lastReportedOverageSeverityStatus": "None",
    "usageTiers": [
      {
        "quotaUsageLevel": "None",
        "quotaUsagePolicy": "None"
      }
    ],
    "accumulationMethod": "Sliced"
  },
  "balanceUsage": {
    "usageQuota": [
      {
        "quotaUsageLevel": "None"
      }
    ],
    "overageSeverityStatus": "None"
  }
}

A usage-tracked metric on a product or entitlement. Depending on how it is charged, either AssetMeteredUsageDto? MonitoredAssetDto.MeteredUsage (tiered, period-based metering) or AssetBalanceUsageDto? MonitoredAssetDto.BalanceUsage (prepaid credit balance) is attached.

object

id

string format: uuid

entitlementId

null | string format: uuid

productId

null | string format: uuid

metricName

string

name

string

description

string

unit

string

category

string

tags

Array<string>

numberFormat

string

metricType

How reported usage values are interpreted and aggregated by the monitoring pipeline.

Allowed values: CumulativeCounter TotalCounter Gauge UpDownCounter

meteredUsageId

null | string format: uuid

meteredUsage

One of:

null

null

object

Admin view of tiered, period-based metering on a monitored asset: the usage tiers, the consumption period they reset on, and how usage accumulates across tiers.

object

id

string format: uuid

suspendedUntilAt

Consumption is suspended until this time (e.g. after an overage); null when not suspended.

null | string format: date-time

lastReportedOverageSeverityStatus

Severity of consumption relative to the configured usage tiers.

Allowed values: None Normal Warning Critical OverUsage

usageTiers

Array<object>

Represents a tier of usage with associated credits and severity status.

object

startUsage

Gets or sets the start usage for the tier.

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

startPercentage

Tier start as a percentage of the feature value (percentage-based enforcement).

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

endUsage

Gets or sets the end usage for the tier. Nullable.

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

endPercentage

Tier end as a percentage of the feature value (percentage-based enforcement).

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

baseCredits

Gets or sets the flat fee credits for the tier.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

creditsPerUnitOfConsumption

Gets or sets the credits per unit of consumption for the tier.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

name

Gets or sets the name of the usage tier.

string

quotaUsageLevel

Gets or sets the overage severity status for the tier.

Allowed values: None Normal Warning Critical OverUsage

quotaUsagePolicy

Defines the enforcement behavior applied by the resource controller or interceptor when a specific usage tier threshold is reached. Ordered from least to most restrictive.

Allowed values: None NotifyOnly AllowWithOverage AllowWithGrace RateLimit Deny SuspendUsage

fundingBalanceMetric

Metric name of the credit balance, on the same entitlement, that pays for consumption in this tier. Only meaningful on a tier whose policy is AllowWithOverage: name a balance and every unit past the tier’s start is priced and charged to it on commit, refusing the commit when it cannot be paid for; leave it empty and the overage is allowed and merely reported.

string

consumptionPeriod

Name of the consumption period the tiers reset on (see ConsumptionPeriodType), e.g. "Monthly".

string

accumulationMethod

How periodic consumption is attributed across usage tiers for charging.

Allowed values: Sliced HighestTierReached

balanceUsageId

null | string format: uuid

balanceUsage

One of:

null

null

object

Admin view of a prepaid credit balance on a monitored asset: credits available, consumed, quota thresholds, and the automatic re-balance (top-up) schedule.

object

id

string format: uuid

name

string

description

string

creditsUsed

Consumed credits since last deposit. Remaining credits are calculated as TotalCredits - CreditsUsed.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

totalCredits

Total available credits.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

cumulativeCreditsUsed

The total of all credits used over time.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

unfundedCredits

Consumption this balance was asked to pay for and could not: usage the vendor is owed and has not been paid for. Cumulative, and not reduced by a later top-up.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

lastUnfundedAt

When this balance last failed to cover consumption that had already happened.

null | string format: date-time

unit

string

numberFormat

string

lastDeposit

string format: date-time

usageQuota

Array<object>

A named quota threshold on a credit balance and the severity level it maps to.

object

endUsage

Remaining-balance threshold for this band: the band applies while the credit balance is below this value, and when several bands match the lowest threshold wins. A matching band at Critical severity blocks further deductions.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

name

string

quotaUsageLevel

Severity of consumption relative to the configured quotas.

Allowed values: None Normal Warning Critical OverUsage

suspendedUntilAt

Consumption is suspended until this time (e.g. after an overage); null when not suspended.

null | string format: date-time

overageSeverityStatus

Severity of consumption relative to the configured quotas.

Allowed values: None Normal Warning Critical OverUsage

initialCreditAmount

The credits available when the entitlement is created.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

isUnlimitedCredits

Indicates if the resource has unlimited credits.

boolean

autoBalanceCronSchedule

Cron schedule for automatic credit balance. The cron syntax consists of five fields separated by spaces:

• Minute (0-59)
• Hour (0-23)
• Day of the Month (1-31)
• Month (1-12 or Jan-Dec)
• Day of the Week (0-6 or Sun-Sat) Special characters:
• • (asterisk): Represents any value for the field.
• , (comma): Separates multiple values.
• • (hyphen): Specifies a range of values.
• / (slash): Specifies increments. Example: “0 0 * * *” means “at midnight every day.”

null | string

lastAutoBalanceDate

Date and time of the last automatic credit balance.

string format: date-time

shouldAutoBalanceTransferCurrentCredits

Indicates if the current credits should be transferred.

boolean

maxAutoBalanceCreditTransferAmount

Maximum amount of credits that can be transferred automatically.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

autoBalanceCreditAmount

Amount of credits to balance automatically.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

allowedBackDatingTolerance

How far in the past a reported usage value’s timestamp may lie and still be accepted.

string

/^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$/

Example

{
  "metricType": "CumulativeCounter",
  "meteredUsage": {
    "lastReportedOverageSeverityStatus": "None",
    "usageTiers": [
      {
        "quotaUsageLevel": "None",
        "quotaUsagePolicy": "None"
      }
    ],
    "accumulationMethod": "Sliced"
  },
  "balanceUsage": {
    "usageQuota": [
      {
        "quotaUsageLevel": "None"
      }
    ],
    "overageSeverityStatus": "None"
  }
}

404

Not Found

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}