NodeRings Docs

List Addons

List available addons

GET
/v1/addons

Authorization

Authorization<token>

Bearer token

In: header

X-Organization-ID<token>

Tenant or organization identifier

In: header

Query Parameters

page?integer
Formatint32
pageSize?integer
Formatint32
subscriptionId?string

Filter by compatible with subscription

addonType?string

Filter by type

Value in"ADDON_TYPE_UNSPECIFIED" | "ADDON_TYPE_BACKUP" | "ADDON_TYPE_SNAPSHOT" | "ADDON_TYPE_ADDITIONAL_IP"
isTemplate?boolean

Filter by template status

billingType?string

Filter by billing type (usage-based or fixed/subscription)

  • BILLING_TYPE_PERCENTAGE: Percentage-based pricing (e.g., 30% of parent plan)
Value in"BILLING_TYPE_UNSPECIFIED" | "BILLING_TYPE_SUBSCRIPTION" | "BILLING_TYPE_USAGE" | "BILLING_TYPE_FREE" | "BILLING_TYPE_PERCENTAGE"
search?string

Search filter for addon name, code, or description

Response Body

application/json

curl -X GET "https://api.nrings.io/v1/addons?page&pageSize&subscriptionId&addonType&isTemplate&billingType&search" \  -H "Authorization: Bearer {your_token}" \  -H "X-Organization-ID: {your_org_id}"
{
  "addons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "description": "string",
      "addonType": "ADDON_TYPE_UNSPECIFIED",
      "addonCategory": "ASSET_CATEGORY_UNSPECIFIED",
      "isTemplate": true,
      "isPublic": true,
      "requiresApproval": true,
      "autoAttach": true,
      "compatiblePlanCodes": [
        "string"
      ],
      "compatibleAssetTypes": [
        "string"
      ],
      "tenantId": "string",
      "externalId": "string",
      "metadata": {},
      "status": "STATUS_UNSPECIFIED",
      "timestamps": {
        "createTime": "2019-08-24T14:15:22Z",
        "updateTime": "2019-08-24T14:15:22Z"
      },
      "addonPrices": [
        {
          "id": "string",
          "addonId": "string",
          "kind": "ADDON_PRICE_KIND_UNSPECIFIED",
          "currency": "string",
          "unitAmount": "string",
          "unitName": "string",
          "billingPeriod": "BILLING_PERIOD_UNSPECIFIED",
          "billingInterval": 0,
          "metricName": "string",
          "metricAggregation": "METRIC_AGGREGATION_UNSPECIFIED",
          "minQuantity": 0,
          "maxQuantity": 0,
          "prorate": true,
          "minimumCharge": "string",
          "maximumCharge": "string",
          "pricingFormula": {},
          "pricingModel": "PRICING_MODEL_UNSPECIFIED",
          "chargeTiming": "CHARGE_TIMING_UNSPECIFIED",
          "effectiveFrom": "2019-08-24T14:15:22Z",
          "effectiveUntil": "2019-08-24T14:15:22Z",
          "externalId": "string",
          "metadata": {},
          "status": "STATUS_UNSPECIFIED",
          "timestamps": {
            "createTime": "2019-08-24T14:15:22Z",
            "updateTime": "2019-08-24T14:15:22Z"
          }
        }
      ]
    }
  ],
  "totalCount": 0
}

List Addon Subscriptions GET

List addon subscriptions for a subscription

Remove Addon DELETE

Remove an addon from a subscription