Update Bundle

Details

API Details
Name

Update Bundle

Description
MethodPUT
URIv1/tenants/tenantId/bundles/bundleID
CloudCenter ReleaseIntroduced in CloudCenter 4.0.
Notes

For additional context on <PORT> usage in the following example(s), see Base URI Format.

ESB Headeraction: update.tenants.tenantId.bundles.bundleID

Example

curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/bundles/7"

Request Body

This request is to change the name (from Dollar15 Bundle to 15-Dollar Bundle), expirationMonths (from null to 12 months), and showOnlyToAdmin (from false to true) settings:

{
  "name": "15-Dollar Bundle",
  "type": "BUDGET_BUNDLE",
  "expirationMonths": 12,
  "showOnlyToAdmin": true
}

Response

The updated settings are displayed in the response:

{
  "id": "7",
  "resource": null,
  "perms": [],
  "name": "15-Dollar Bundle",
  "description": "",
  "tenantId": "1",
  "type": "BUDGET_BUNDLE",
  "limit": 200,
  "price": 15,
  "expirationDate": 1434006000000,
  "expirationMonths": 12,
  "publishedAppIds": [],
  "disabled": false,
  "showOnlyToAdmin": true,
  "numberOfUsers": 0
}

Request Attributes

tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • Type: String

Required

bundleId
  • Description: Unique, system-generated identifier for the bundle belonging to this tenant.
  • Type: String

Required

name
  • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

  • Type: String

type
  • DescriptionThe type of resource
  • Type: String
expirationMonths
  • Description: Number of months that a plan is active
  • Type: Integer
showOnlyToAdmin
  • Description: Indicates whether this resource is visible only to an administrator.
    • true = visibility of the resource is restricted to an administrator
    • false = visibility of the resource is not restricted to an administrator
  • Type: Boolean

Response Attributes

id
  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String
resource
  • Description: Unique URL to access this resource
  • Type: String
perms (click for additional details)

name
  • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

  • Type: String

Required

description
  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String

tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • Type: String

Required

bundleType
  • Description: Type type of bundle for this user or tenant. See Financial Overview and Permission Control for additional content. 
  • Type: Enumeration

    EnumerationDescription
    TIME_BUNDLETime-based VM hours bundle example: Default. The 250 hours sign up offered through the CloudCenter Marketplace that includes the management fee at no additional cost. Typically, new users try out this bundle before their admin assigns them to a plan or before the user converts to a subscription plan.
    BUDGET_BUNDLEBudget-based $ limit bundle example: With a budget limit of $100, you can run applications until this amount is consumed. If your tenant admins set a management fee (for example, $0.10 per hour), then this amount is deducted from the $100 limit. Any additional cloud cost is also deducted from the $100 limit.

Required

limit

price
  • DescriptionThe base price for this bundle or plan. Required in the request only for the monthlyLimit plans:
    • UNLIMITED_PLAN
    • VM_HOUR_SUBSCRIPTION_PLAN
    • VM_SUBSCRIPTION_PLAN
    • For the remaining prepaid plan type (TIME_BUNDLE_PREPAID_PLAN and BUDGET_BUNDLE_PREPAID_PLAN), the value defaults to 0
  • Type: Float

Required

expirationDate
  • DescriptionA period starting from the date of purchase or a fixed expiration date.
  • Type: Long

Required

expirationMonths
  • Description: Number of months that a plan is active
  • Type: Integer

publishedAppIds
  • DescriptionUnique, system-generated identifier for applications published to the Marketplace
  • Type: Array of strings

disabled
  • Description: Indicates whether this resource is disabled.
    • True = resource is disabled
    • false = resource is not disabled
  • Type: Boolean
showOnlyToAdmin
  • Description: Indicates whether this resource is visible only to an administrator.
    • true = visibility of the resource is restricted to an administrator
    • false = visibility of the resource is not restricted to an administrator
  • Type: Boolean
numberOfUsers
  • Description: Number of users that are currently using this resource
  • Type: Long