Get enterprise settings

GET /enterprises/{enterprise_identifier}

Get the enterprise settings for the specified enterprise ID

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Response

200 - Successful response. Your permissions determine what you can see

id

string

Enterprise identification

_rev

string

Cloudant revision

account_filters

Filters

Filters for account and catalog filters

account_groups

object

Map of account group ids to AccountGroup objects

region_filters

array

401 - Unauthorized

403 - No Permissions

Update enterprise settings

PUT /enterprises/{enterprise_identifier}

Update the settings for an enterprise

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Request Body

Enterprise

id

string

Enterprise identification

_rev

string

Cloudant revision

account_filters

Filters

Filters for account and catalog filters

include_all

boolean

-> true - Include all of the public catalog when filtering. Further settings will specifically exclude some offerings. false - Exclude all of the public catalog when filtering. Further settings will specifically include some offerings.

category_filters

object

Filter against offering properties

id_filters

object

Filter on offering ID's. There is an include filter and an exclule filter. Both can be set.

account_groups

object

Map of account group ids to AccountGroup objects

keys

object

Filters for an Account Group

region_filters

array

Response

200 - Successful update. Your permissions determine if can update or not.

401 - Unauthorized

403 - No Permissions

Get catalog account settings

GET /catalogaccount

Get the account level settings for the account for private catalog

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Response

200 - Successful response. Your permissions determine what you can see

id

string

Account identification

_rev

string

Cloudant revision

hide_IBM_cloud_catalog

boolean

Hide the public catalog in this account

account_filters

Filters

Filters for account and catalog filters

region_filter

string

Region filter string

terraform_engines

array

List of terraform engines configured for this account

401 - Unauthorized

403 - No Permissions

Get catalog account filters

GET /catalogaccount/filters

Get the accumulated filters of the account and of the catalogs you have access to.

Request

Path Parameters

Query Parameters

catalog

string

catalog id. Narrow down filters to the account and just the one catalog.

Response

200 - Successful response. Your permissions determine what you can see

hide_IBM_cloud_catalog

boolean

Hide the public catalog in this account

account_filters

array

Filters for accounts (at this time this will always be just one item array)

catalog_filters

array

The filters for all of the accessible catalogs.

region_filters

array

filtered_regions

array

filter_regions

boolean

401 - Unauthorized

403 - No Permissions

Get list of catalogs

GET /catalogs

Retrieves the available catalogs for a given account. This can be used by an unauthenticated user to retrieve the public catalog.

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Response

200 - Successful response. Your permissions determine what you can see

offset

integer

The offset (origin 0) of the first resource in this page of search results.

limit

integer

The maximum number of resources returned in each page of search results.

total_count

integer

The overall total number of resources in the search result set.

resource_count

integer

The number of resources returned in this page of search results.

first

string

A URL for retrieving the first page of search results.

last

string

A URL for retrieving the last page of search results.

prev

string

A URL for retrieving the previous page of search results.

next

string

A URL for retrieving the next page of search results.

resources

array

Resulting objects

Create a catalog

POST /catalogs

Create a catalog for a given account

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Request Body

Response

201 - New catalog created successfully

id

string

Unique ID

_rev

string

Cloudant revision

label

string

Display Name in the requested language

label_i18n

I18n

Translated display name, by language code

short_description

string

Description in the requested language

short_description_i18n

I18n

Translated description, by language code

catalog_icon_url

string

URL for an icon associated with this catalog

catalog_banner_url

string

URL for a banner image for this catalog

tags

array

List of tags associated with this catalog

url

string

The url for this specific catalog

crn

string

CRN associated with the catalog

offerings_url

string

URL path to offerings

features

array

List of features associated with this catalog

disabled

boolean

Denotes whether a catalog is disabled

created

string

The date-time this catalog was created

updated

string

The date-time this catalog was last updated

resource_group_id

string

Resource group id the catalog is owned by

owning_account

string

Account that owns catalog

catalog_filters

Filters

Filters for account and catalog filters

kind

string

Kind of catalog. Supported kinds are offering and vpe

metadata

object

Catalog specific metadata

target_account_contexts

array

List of target accounts contexts on this catalog

401 - Unauthorized

403 - No Permissions

Get catalog

GET /catalogs/{catalog_identifier}

Get a catalog. This can also be used by an unauthenticated user to get the public catalog.

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Response

200 - Successful Result

id

string

Unique ID

_rev

string

Cloudant revision

label

string

Display Name in the requested language

label_i18n

I18n

Translated display name, by language code

short_description

string

Description in the requested language

short_description_i18n

I18n

Translated description, by language code

catalog_icon_url

string

URL for an icon associated with this catalog

catalog_banner_url

string

URL for a banner image for this catalog

tags

array

List of tags associated with this catalog

url

string

The url for this specific catalog

crn

string

CRN associated with the catalog

offerings_url

string

URL path to offerings

features

array

List of features associated with this catalog

disabled

boolean

Denotes whether a catalog is disabled

created

string

The date-time this catalog was created

updated

string

The date-time this catalog was last updated

resource_group_id

string

Resource group id the catalog is owned by

owning_account

string

Account that owns catalog

catalog_filters

Filters

Filters for account and catalog filters

kind

string

Kind of catalog. Supported kinds are offering and vpe

metadata

object

Catalog specific metadata

target_account_contexts

array

List of target accounts contexts on this catalog

401 - Unauthorized

403 - No Permissions

404 - No such catalog id

Delete catalog

DELETE /catalogs/{catalog_identifier}

Delete a catalog

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Response

200 - Successful Result

401 - Unauthorized

403 - No Permissions

Get consumption offerings

GET /offerings

Retrieve the available offerings from both public and from the account that currently scoped for consumption. These copies cannot be used for updating. They are not complete and only return what is visible to the caller. This can be used by an unauthenticated user to retreive publicly available offerings.

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Path Parameters

Query Parameters

digest

boolean

true - Strip down the content of what is returned. For example don't return the readme. Makes the result much smaller. Defaults to false.

catalog

string

catalog id. Narrow search down to just a particular catalog. It will apply the catalog's public filters to the public catalog offerings on the result.

select

string

What should be selected. Default is 'all' which will return both public and private offerings. 'public' returns only the public offerings and 'private' returns only the private offerings.

includeHidden

boolean

true - include offerings which have been marked as hidden. The default is false and hidden offerings are not returned.

limit

integer

number or results to return

offset

integer

number of results to skip before returning values

Response

200 - Successful response. Your permissions determine what you can see

offset

integer

The offset (origin 0) of the first resource in this page of search results.

limit

integer

The maximum number of resources returned in each page of search results.

total_count

integer

The overall total number of resources in the search result set.

resource_count

integer

The number of resources returned in this page of search results.

first

string

A URL for retrieving the first page of search results.

last

string

A URL for retrieving the last page of search results.

prev

string

A URL for retrieving the previous page of search results.

next

string

A URL for retrieving the next page of search results.

resources

array

Resulting objects

Get list of offerings

GET /catalogs/{catalog_identifier}/offerings

Retrieve the available offerings in the specified catalog. This can also be used by an unauthenticated user to retreive publicly available offerings.

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Path Parameters

Query Parameters

digest

boolean

true - Strip down the content of what is returned. For example don't return the readme. Makes the result much smaller. Defaults to false.

limit

integer

The maximum number of results to return

offset

integer

The number of results to skip before returning values

name

string

Only return results that contain the specified string

sort

string

The field on which the output is sorted. Sorts by default by label property. Available fields are name, label, created, and updated. By adding - (i.e. -label) in front of the query string, you can specify descending order. Default is ascending order.

includeHidden

boolean

true - include offerings which have been marked as hidden. The default is true. To not return hidden offerings false must be explicitly set

Response

200 - Successful response. Your permissions determine what you can see

offset

integer

The offset (origin 0) of the first resource in this page of search results.

limit

integer

The maximum number of resources returned in each page of search results.

total_count

integer

The overall total number of resources in the search result set.

resource_count

integer

The number of resources returned in this page of search results.

first

string

A URL for retrieving the first page of search results.

last

string

A URL for retrieving the last page of search results.

prev

string

A URL for retrieving the previous page of search results.

next

string

A URL for retrieving the next page of search results.

resources

array

Resulting objects

Create offering

POST /catalogs/{catalog_identifier}/offerings

Create an offering

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Request Body

Response

201 - New offering created successfully

id

string

unique id

_rev

string

Cloudant revision

url

string

The url for this specific offering

crn

string

The crn for this specific offering

label

string

Display Name in the requested language

label_i18n

I18n

Translated display Name, by language code

name

string

The programmatic name of this offering

offering_icon_url

string

URL for an icon associated with this offering

offering_docs_url

string

URL for an additional docs with this offering

offering_support_url

string

[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering

tags

array

List of tags associated with this catalog

keywords

array

List of keywords associated with offering, typically used to search for it

rating

Rating

Repository info for offerings

created

string

The date and time this catalog was created

updated

string

The date and time this catalog was last updated

short_description

string

Short description in the requested language

short_description_i18n

I18n

Translated short description, by language code

long_description

string

Long description in the requested language

long_description_i18n

I18n

Translated long description, by language code

features

array

list of features associated with this offering

kinds

array

Array of kind

publish

PublishObject

Publish information

pc_managed

boolean

Offering is managed by Partner Center

publish_approved

boolean

Offering has been approved to publish to permitted to IBM or Public Catalog

share_with_all

boolean

Denotes public availability of an Offering

share_with_ibm

boolean

Denotes IBM employee availability of an Offering - if share_enabled is true

share_enabled

boolean

Denotes sharing including access list availability of an Offering is enabled

public_original_crn

string

The original offering CRN that this publish entry came from

publish_public_crn

string

The crn of the public catalog entry of this offering

portal_approval_record

string

The portal's approval record ID

portal_ui_url

string

The portal UI URL

catalog_id

string

The id of the catalog containing this offering

catalog_name

string

The name of the catalog

metadata

object

Map of metadata values for this offering

disclaimer

string

A disclaimer for this offering

hidden

boolean

Determine if this offering should be displayed in the Consumption UI

provider

string

Deprecated - Provider of this offering

provider_info

ProviderInfo

Information on the provider for this offering, or omitted if no provider information is given.

repo_info

RepoInfo

Repository info for offerings

image_pull_keys

array

Image pull keys for this offering

support

Support

Offering Support information

media

array

A list of media items related to this offering

deprecate_pending

DeprecatePending

Deprecation information for this offering.

product_kind

string

The product kind. Valid values are module, solution, or empty string

badges

array

A list of badges for this offering

plans

array

A list of plans for this offering

401 - Unauthorized

403 - No Permissions

Import offering version

POST /catalogs/{catalog_identifier}/offerings/{offering_id}/version

Import new version to an offering

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Request Body

Path Parameters

Query Parameters

zipurl

string

URL path to zip location. If not specified, must provide content in the body of this call.

targetVersion

string

The semver value for this new version, if not found in the zip url package content

includeConfig

boolean

Add all possible configuration values to this version when importing

isVSI

boolean

Indicates that the current terraform template is used to install a virtual server image

repotype

string

The type of repository containing this version. Valid values are 'public_git' or 'enterprise_git'

Response

201 - New version created successfully

id

string

unique id

_rev

string

Cloudant revision

url

string

The url for this specific offering

crn

string

The crn for this specific offering

label

string

Display Name in the requested language

label_i18n

I18n

Translated display Name, by language code

name

string

The programmatic name of this offering

offering_icon_url

string

URL for an icon associated with this offering

offering_docs_url

string

URL for an additional docs with this offering

offering_support_url

string

[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering

tags

array

List of tags associated with this catalog

keywords

array

List of keywords associated with offering, typically used to search for it

rating

Rating

Repository info for offerings

created

string

The date and time this catalog was created

updated

string

The date and time this catalog was last updated

short_description

string

Short description in the requested language

short_description_i18n

I18n

Translated short description, by language code

long_description

string

Long description in the requested language

long_description_i18n

I18n

Translated long description, by language code

features

array

list of features associated with this offering

kinds

array

Array of kind

publish

PublishObject

Publish information

pc_managed

boolean

Offering is managed by Partner Center

publish_approved

boolean

Offering has been approved to publish to permitted to IBM or Public Catalog

share_with_all

boolean

Denotes public availability of an Offering

share_with_ibm

boolean

Denotes IBM employee availability of an Offering - if share_enabled is true

share_enabled

boolean

Denotes sharing including access list availability of an Offering is enabled

public_original_crn

string

The original offering CRN that this publish entry came from

publish_public_crn

string

The crn of the public catalog entry of this offering

portal_approval_record

string

The portal's approval record ID

portal_ui_url

string

The portal UI URL

catalog_id

string

The id of the catalog containing this offering

catalog_name

string

The name of the catalog

metadata

object

Map of metadata values for this offering

disclaimer

string

A disclaimer for this offering

hidden

boolean

Determine if this offering should be displayed in the Consumption UI

provider

string

Deprecated - Provider of this offering

provider_info

ProviderInfo

Information on the provider for this offering, or omitted if no provider information is given.

repo_info

RepoInfo

Repository info for offerings

image_pull_keys

array

Image pull keys for this offering

support

Support

Offering Support information

media

array

A list of media items related to this offering

deprecate_pending

DeprecatePending

Deprecation information for this offering.

product_kind

string

The product kind. Valid values are module, solution, or empty string

badges

array

A list of badges for this offering

plans

array

A list of plans for this offering

401 - Unauthorized

403 - No Permissions

Import offering

POST /catalogs/{catalog_identifier}/import/offerings

Import a new offering

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Request Body

Path Parameters

Query Parameters

zipurl

string

URL path to zip location. If not specified, must provide content in this post body.

offeringID

string

Re-use the specified offeringID during import

targetVersion

string

The semver value for this new version

includeConfig

boolean

Add all possible configuration items when creating this version

isVSI

boolean

Indicates that the current terraform template is used to install a virtual server image

repotype

string

The type of repository containing this version. Valid values are 'public_git' or 'enterprise_git'

Response

201 - New offering created successfully

id

string

unique id

_rev

string

Cloudant revision

url

string

The url for this specific offering

crn

string

The crn for this specific offering

label

string

Display Name in the requested language

label_i18n

I18n

Translated display Name, by language code

name

string

The programmatic name of this offering

offering_icon_url

string

URL for an icon associated with this offering

offering_docs_url

string

URL for an additional docs with this offering

offering_support_url

string

[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering

tags

array

List of tags associated with this catalog

keywords

array

List of keywords associated with offering, typically used to search for it

rating

Rating

Repository info for offerings

created

string

The date and time this catalog was created

updated

string

The date and time this catalog was last updated

short_description

string

Short description in the requested language

short_description_i18n

I18n

Translated short description, by language code

long_description

string

Long description in the requested language

long_description_i18n

I18n

Translated long description, by language code

features

array

list of features associated with this offering

kinds

array

Array of kind

publish

PublishObject

Publish information

pc_managed

boolean

Offering is managed by Partner Center

publish_approved

boolean

Offering has been approved to publish to permitted to IBM or Public Catalog

share_with_all

boolean

Denotes public availability of an Offering

share_with_ibm

boolean

Denotes IBM employee availability of an Offering - if share_enabled is true

share_enabled

boolean

Denotes sharing including access list availability of an Offering is enabled

public_original_crn

string

The original offering CRN that this publish entry came from

publish_public_crn

string

The crn of the public catalog entry of this offering

portal_approval_record

string

The portal's approval record ID

portal_ui_url

string

The portal UI URL

catalog_id

string

The id of the catalog containing this offering

catalog_name

string

The name of the catalog

metadata

object

Map of metadata values for this offering

disclaimer

string

A disclaimer for this offering

hidden

boolean

Determine if this offering should be displayed in the Consumption UI

provider

string

Deprecated - Provider of this offering

provider_info

ProviderInfo

Information on the provider for this offering, or omitted if no provider information is given.

repo_info

RepoInfo

Repository info for offerings

image_pull_keys

array

Image pull keys for this offering

support

Support

Offering Support information

media

array

A list of media items related to this offering

deprecate_pending

DeprecatePending

Deprecation information for this offering.

product_kind

string

The product kind. Valid values are module, solution, or empty string

badges

array

A list of badges for this offering

plans

array

A list of plans for this offering

401 - Unauthorized

403 - No Permissions

Reload offering

PUT /catalogs/{catalog_identifier}/offerings/{offering_id}/reload

Reload an existing version in offering from a tgz

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Request Body

Path Parameters

Query Parameters

targetVersion

Required *

string

The semver value for this new version

zipurl

string

URL path to zip location. If not specified, must provide content in this post body.

repoType

string

The type of repository containing this version. Valid values are 'public_git' or 'enterprise_git'

Response

200 - New version created successfully

id

string

unique id

_rev

string

Cloudant revision

url

string

The url for this specific offering

crn

string

The crn for this specific offering

label

string

Display Name in the requested language

label_i18n

I18n

Translated display Name, by language code

name

string

The programmatic name of this offering

offering_icon_url

string

URL for an icon associated with this offering

offering_docs_url

string

URL for an additional docs with this offering

offering_support_url

string

[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering

tags

array

List of tags associated with this catalog

keywords

array

List of keywords associated with offering, typically used to search for it

rating

Rating

Repository info for offerings

created

string

The date and time this catalog was created

updated

string

The date and time this catalog was last updated

short_description

string

Short description in the requested language

short_description_i18n

I18n

Translated short description, by language code

long_description

string

Long description in the requested language

long_description_i18n

I18n

Translated long description, by language code

features

array

list of features associated with this offering

kinds

array

Array of kind

publish

PublishObject

Publish information

pc_managed

boolean

Offering is managed by Partner Center

publish_approved

boolean

Offering has been approved to publish to permitted to IBM or Public Catalog

share_with_all

boolean

Denotes public availability of an Offering

share_with_ibm

boolean

Denotes IBM employee availability of an Offering - if share_enabled is true

share_enabled

boolean

Denotes sharing including access list availability of an Offering is enabled

public_original_crn

string

The original offering CRN that this publish entry came from

publish_public_crn

string

The crn of the public catalog entry of this offering

portal_approval_record

string

The portal's approval record ID

portal_ui_url

string

The portal UI URL

catalog_id

string

The id of the catalog containing this offering

catalog_name

string

The name of the catalog

metadata

object

Map of metadata values for this offering

disclaimer

string

A disclaimer for this offering

hidden

boolean

Determine if this offering should be displayed in the Consumption UI

provider

string

Deprecated - Provider of this offering

provider_info

ProviderInfo

Information on the provider for this offering, or omitted if no provider information is given.

repo_info

RepoInfo

Repository info for offerings

image_pull_keys

array

Image pull keys for this offering

support

Support

Offering Support information

media

array

A list of media items related to this offering

deprecate_pending

DeprecatePending

Deprecation information for this offering.

product_kind

string

The product kind. Valid values are module, solution, or empty string

badges

array

A list of badges for this offering

plans

array

A list of plans for this offering

401 - Unauthorized

403 - No Permissions

Get offering

GET /catalogs/{catalog_identifier}/offerings/{offering_id}

Get an offering. This can be used by an unauthenticated user for publicly available offerings.

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Path Parameters

Query Parameters

type

string

Offering Parameter Type. Valid values are 'name' or 'id'. Default is 'id'.

digest

boolean

Return the digest format of the specified offering. Default is false.

Response

200 - Successful Result

id

string

unique id

_rev

string

Cloudant revision

url

string

The url for this specific offering

crn

string

The crn for this specific offering

label

string

Display Name in the requested language

label_i18n

I18n

Translated display Name, by language code

name

string

The programmatic name of this offering

offering_icon_url

string

URL for an icon associated with this offering

offering_docs_url

string

URL for an additional docs with this offering

offering_support_url

string

[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering

tags

array

List of tags associated with this catalog

keywords

array

List of keywords associated with offering, typically used to search for it

rating

Rating

Repository info for offerings

created

string

The date and time this catalog was created

updated

string

The date and time this catalog was last updated

short_description

string

Short description in the requested language

short_description_i18n

I18n

Translated short description, by language code

long_description

string

Long description in the requested language

long_description_i18n

I18n

Translated long description, by language code

features

array

list of features associated with this offering

kinds

array

Array of kind

publish

PublishObject

Publish information

pc_managed

boolean

Offering is managed by Partner Center

publish_approved

boolean

Offering has been approved to publish to permitted to IBM or Public Catalog

share_with_all

boolean

Denotes public availability of an Offering

share_with_ibm

boolean

Denotes IBM employee availability of an Offering - if share_enabled is true

share_enabled

boolean

Denotes sharing including access list availability of an Offering is enabled

public_original_crn

string

The original offering CRN that this publish entry came from

publish_public_crn

string

The crn of the public catalog entry of this offering

portal_approval_record

string

The portal's approval record ID

portal_ui_url

string

The portal UI URL

catalog_id

string

The id of the catalog containing this offering

catalog_name

string

The name of the catalog

metadata

object

Map of metadata values for this offering

disclaimer

string

A disclaimer for this offering

hidden

boolean

Determine if this offering should be displayed in the Consumption UI

provider

string

Deprecated - Provider of this offering

provider_info

ProviderInfo

Information on the provider for this offering, or omitted if no provider information is given.

repo_info

RepoInfo

Repository info for offerings

image_pull_keys

array

Image pull keys for this offering

support

Support

Offering Support information

media

array

A list of media items related to this offering

deprecate_pending

DeprecatePending

Deprecation information for this offering.

product_kind

string

The product kind. Valid values are module, solution, or empty string

badges

array

A list of badges for this offering

plans

array

A list of plans for this offering

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering

Update offering

PUT /catalogs/{catalog_identifier}/offerings/{offering_id}

Update an offering

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Request Body

Response

200 - Offering was updated successfully

id

string

unique id

_rev

string

Cloudant revision

url

string

The url for this specific offering

crn

string

The crn for this specific offering

label

string

Display Name in the requested language

label_i18n

I18n

Translated display Name, by language code

name

string

The programmatic name of this offering

offering_icon_url

string

URL for an icon associated with this offering

offering_docs_url

string

URL for an additional docs with this offering

offering_support_url

string

[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering

tags

array

List of tags associated with this catalog

keywords

array

List of keywords associated with offering, typically used to search for it

rating

Rating

Repository info for offerings

created

string

The date and time this catalog was created

updated

string

The date and time this catalog was last updated

short_description

string

Short description in the requested language

short_description_i18n

I18n

Translated short description, by language code

long_description

string

Long description in the requested language

long_description_i18n

I18n

Translated long description, by language code

features

array

list of features associated with this offering

kinds

array

Array of kind

publish

PublishObject

Publish information

pc_managed

boolean

Offering is managed by Partner Center

publish_approved

boolean

Offering has been approved to publish to permitted to IBM or Public Catalog

share_with_all

boolean

Denotes public availability of an Offering

share_with_ibm

boolean

Denotes IBM employee availability of an Offering - if share_enabled is true

share_enabled

boolean

Denotes sharing including access list availability of an Offering is enabled

public_original_crn

string

The original offering CRN that this publish entry came from

publish_public_crn

string

The crn of the public catalog entry of this offering

portal_approval_record

string

The portal's approval record ID

portal_ui_url

string

The portal UI URL

catalog_id

string

The id of the catalog containing this offering

catalog_name

string

The name of the catalog

metadata

object

Map of metadata values for this offering

disclaimer

string

A disclaimer for this offering

hidden

boolean

Determine if this offering should be displayed in the Consumption UI

provider

string

Deprecated - Provider of this offering

provider_info

ProviderInfo

Information on the provider for this offering, or omitted if no provider information is given.

repo_info

RepoInfo

Repository info for offerings

image_pull_keys

array

Image pull keys for this offering

support

Support

Offering Support information

media

array

A list of media items related to this offering

deprecate_pending

DeprecatePending

Deprecation information for this offering.

product_kind

string

The product kind. Valid values are module, solution, or empty string

badges

array

A list of badges for this offering

plans

array

A list of plans for this offering

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering

Delete offering

DELETE /catalogs/{catalog_identifier}/offerings/{offering_id}

Delete an offering

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Path Parameters

catalog_identifier

Required *

string

Catalog identifier

offering_id

Required *

string

Offering identification

Query Parameters

Response

200 - Offering was deleted successfully

401 - Unauthorized

403 - No Permissions

404 - No such catalogg

Set offering publish approval settings

POST /catalogs/{catalog_identifier}/offerings/{offering_id}/publish/{approval_type}/{approved}

Approve or disapprove the offering to be allowed to publish to a particular public catalog based on the approval type. Approvers should use the catalog and offering id from the public catalog since they wouldn't have access to the private offering.

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Path Parameters

catalog_identifier

Required *

string

Catalog identifier

offering_id

Required *

string

Offering identification

approval_type

Required *

string

Type of approval.

  • `pc_managed` - Partner Center is managing this offering
  • `ibm_module_repo` - Offering is from an approved repository can be published into the module registry.
  • `ibm_community` - Offering is from an approved repository can be published into the Community registry.
  • `publish_approved` - Publishing approved, offering owners can now set who sees the offering in public catalog
  • `approval_required` - Offering will be removed from public catalog when this flag is set to true, regardless of the approval and visibility settings.

approved

Required *

string

Approve (true) or disapprove (false)

Query Parameters

portal_record

string

Partner Center identifier for this offering

portal_url

string

Partner Center url for this offering

Response

200 - Successful Result

shared

boolean

Shared - object is shared using access list - not set when using PC Managed objects

ibm

boolean

Shared with IBM only - access list is also applicable - not set when using PC Managed objects

public

boolean

Shared with everyone - not set when using PC Managed objects

allow_request

boolean

Published to Partner Center (pc_managed) or for objects, allowed to request publishing

approved

boolean

Approvers have approved publishing to public catalog

portal_record

string

Partner Center document ID

portal_url

string

Partner Center URL for this product

changed

boolean

Denotes whether approvals have changed

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering

Get version updates

GET /catalogs/{catalog_identifier}/offerings/{offering_id}/updates

Get available updates for the specified version

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Path Parameters

Query Parameters

kind

Required *

string

The kind of offering (e.g, helm, ova, terraform ...)

target

string

The target kind of the currently installed version (e.g. iks, roks, etc)

version

string

optionaly provide an existing version to check updates for if one is not given, all version will be returned.

cluster_id

string

The id of the cluster where this version was installed

region

string

The region of the cluster where this version was installed

resource_group_id

string

The resource group id of the cluster where this version was installed

namespace

string

The namespace of the cluster where this version was installed

sha

string

The sha value of the currently installed version

channel

string

Optionally provide the channel value of the currently installed version

namespaces

array

Optionally provide a list of namespaces used for the currently installed version

all_namespaces

boolean

Optionally indicate that the current version was installed in all namespaces

flavor

string

The programmatic flavor name of the version that was installed

install_type

string

The install type of the version that was installed

Response

200 - Version Descriptors, sorted newest first

400 - Bad request

401 - Unauthorized

403 - No Permissions

Get version about information

GET /versions/{version_loc_id}/about

Get the about information, in markdown, for the current version

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Response

200 - Successful response. Your permissions determine what you can see

400 - Bad request

401 - Unauthorized

403 - No Permissions

Get version license content

GET /versions/{version_loc_id}/licenses/{license_id}

Get the license content for the specified license ID in the specified version

Request

Response

200 - Successful response. Your permissions determine what you can see

400 - Bad request

401 - Unauthorized

403 - No Permissions

Get version's container images

GET /versions/{version_loc_id}/containerImages

Get the list of container images associated with the specified version. The "image_manifest_url" property of the version should be the URL for the image manifest, and the operation will return that content

Request

Response

200 - Successful response. A list of images

description

string

Image manifest description

images

array

List of images

Archive version immediately

POST /versions/{version_loc_id}/archive

Archive the specified version

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Response

202 - Request accepted.

400 - Bad request

401 - Unauthorized

403 - No Permissions

Commit version

POST /versions/{version_loc_id}/commit

Commit a working copy of the specified version

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Response

200 - Working copy was committed successfully

400 - Bad request

401 - Unauthorized

403 - No Permissions

Create working copy of version

POST /versions/{version_loc_id}/workingcopy

Create a working copy of the specified version

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Response

200 - Working copy created successfully

id

string

Unique ID

_rev

string

Cloudant revision

crn

string

Version's CRN

version

string

Version of content type

flavor

Flavor

Optional flavor information for this version. Only supported for Product kind Solution.

sha

string

hash of the content

created

string

The date and time this version was created

updated

string

The date and time this version was last updated

offering_id

string

Offering ID

catalog_id

string

Catalog ID

kind_id

string

Kind ID

tags

array

List of tags associated with this catalog

repo_url

string

Content's repo URL

source_url

string

Content's source URL (e.g git repo)

tgz_url

string

File used to on-board this version

configuration

array

List of user solicited overrides

outputs

array

List of output values for this version

iam_permissions

array

List of IAM permissions that are required to consume this version

metadata

object

Open ended metadata information

validation

Validation

Validation response

required_resources

array

Resource requirments for installation

single_instance

boolean

Denotes if single instance can be deployed to a given cluster

schematics_env_values

SchematicsEnvValues

Environment values to be passed to Schematics Workspace on creation

install

Script

Script information

pre_install

array

Optional pre-install instructions

scripts

object

A map of scripts to be run by a Project during a particular stage of a specified action. Each key in the map must match the format "action"_"stage" in the specified ScriptRef.

entitlement

object

Entitlement license info

licenses

array

List of licenses the product was built with

image_manifest_url

string

If set, denotes a url to a YAML file with list of container images used by this version

deprecated

boolean

read only field, indicating if this version is deprecated

package_version

string

Version of the package used to create this version

state

State

Offering state

version_locator

string

A dotted value of `catalogID`.`versionID`

long_description

string

Long description for version

long_description_i18n

I18n

Translated long description for version, by language code

short_description

string

Short description for version

short_description_i18n

I18n

Translated short description for version, by language code

whitelisted_accounts

array

Whitelisted accounts for version

image_pull_key_name

string

ID of the image pull key to use from Offering.ImagePullKeys

deprecate_pending

DeprecatePending

Deprecation information for this version

solution_info

SolutionInfo

Solution information for version. Only supported for Product kind Solution.

is_consumable

boolean

Is the version able to be shared

compliance_v3

Compliance

Compliance info for a version

change_notices

ChangeNotices

Change notices for a version

plan_ids

array

A list of plan ids that are applicable for this version

stack

object

Optional. Stack definition that was used to create this version

minimum_compatible_version

string

The lowest version (semver) that can upgrade to this version

400 - Bad request

401 - Unauthorized

403 - No Permissions

409 - Working Copy already exists

Copy values from a previous version

POST /versions/{version_loc_id}/copy/{type}/{version_loc_id_to_copy_from}

Copy values from a specified previous version

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Response

200 - Values copied successfully

400 - Bad request

401 - Unauthorized

403 - No Permissions

404 - Catalog not found from specified version locator.

Get offering/kind/version 'branch'

GET /versions/{version_loc_id}

Get the Offering/Kind/Version 'branch' for the specified locator ID

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Response

200 - Successful response. Your permissions determine what you can see

id

string

unique id

_rev

string

Cloudant revision

url

string

The url for this specific offering

crn

string

The crn for this specific offering

label

string

Display Name in the requested language

label_i18n

I18n

Translated display Name, by language code

name

string

The programmatic name of this offering

offering_icon_url

string

URL for an icon associated with this offering

offering_docs_url

string

URL for an additional docs with this offering

offering_support_url

string

[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering

tags

array

List of tags associated with this catalog

keywords

array

List of keywords associated with offering, typically used to search for it

rating

Rating

Repository info for offerings

created

string

The date and time this catalog was created

updated

string

The date and time this catalog was last updated

short_description

string

Short description in the requested language

short_description_i18n

I18n

Translated short description, by language code

long_description

string

Long description in the requested language

long_description_i18n

I18n

Translated long description, by language code

features

array

list of features associated with this offering

kinds

array

Array of kind

publish

PublishObject

Publish information

pc_managed

boolean

Offering is managed by Partner Center

publish_approved

boolean

Offering has been approved to publish to permitted to IBM or Public Catalog

share_with_all

boolean

Denotes public availability of an Offering

share_with_ibm

boolean

Denotes IBM employee availability of an Offering - if share_enabled is true

share_enabled

boolean

Denotes sharing including access list availability of an Offering is enabled

public_original_crn

string

The original offering CRN that this publish entry came from

publish_public_crn

string

The crn of the public catalog entry of this offering

portal_approval_record

string

The portal's approval record ID

portal_ui_url

string

The portal UI URL

catalog_id

string

The id of the catalog containing this offering

catalog_name

string

The name of the catalog

metadata

object

Map of metadata values for this offering

disclaimer

string

A disclaimer for this offering

hidden

boolean

Determine if this offering should be displayed in the Consumption UI

provider

string

Deprecated - Provider of this offering

provider_info

ProviderInfo

Information on the provider for this offering, or omitted if no provider information is given.

repo_info

RepoInfo

Repository info for offerings

image_pull_keys

array

Image pull keys for this offering

support

Support

Offering Support information

media

array

A list of media items related to this offering

deprecate_pending

DeprecatePending

Deprecation information for this offering.

product_kind

string

The product kind. Valid values are module, solution, or empty string

badges

array

A list of badges for this offering

plans

array

A list of plans for this offering

Delete version

DELETE /versions/{version_loc_id}

Delete the specified version. If the version is an active version with a working copy, the working copy will be deleted as well.

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Response

200 - Version deleted successfully

400 - Bad request

401 - Unauthorized

403 - No Permissions

Get offering/kind/version 'dependencies'

GET /versions/{version_loc_id}/dependencies

Get the latest version of all offerings/variations that depends on this version locator

Request

Response

200 - Successful response. Your permissions determine what you can see

start

string

The start token used for this response

limit

integer

The limit that was applied to this response. It may be smaller than in the request because that was too large

total_count

integer

The total count of resources in the system that matches the request

resource_count

integer

The number of resources returned in this response

version

object

first

PaginationTokenLink

Link response on a token paginated query

next

PaginationTokenLink

Link response on a token paginated query

prev

PaginationTokenLink

Link response on a token paginated query

last

PaginationTokenLink

Link response on a token paginated query

Deprecate version immediately - use /archive instead

POST /versions/{version_loc_id}/deprecate

Deprecate the specified version

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Response

202 - Request accepted.

400 - Bad request

401 - Unauthorized

403 - No Permissions

List a repository's entries

GET /repo/{type}/entries

List the available entries from a given repository

Request

Path Parameters

Query Parameters

repourl

Required *

string

The URL for the repository's root (e.g https://kubernetes-charts-incubator.storage.googleapis.com)

Response

200 - Successful response.

chart

object

A chart entry in the repo. This response will contain many chart names.

Get repository contents

GET /repo/{type}

Get the contents of a given repo

Request

Path Parameters

Query Parameters

charturl

Required *

string

The URL for the repository's chart zip file (e.g https://registry.bluemix.net/helm/ibm-charts/charts/ibm-redis-ha-dev-1.0.0.tgz)

Response

200 - Successful response.

chart

object

The name of the requested chart, or the name of a nested chart within the requested chart.

Get kubernetes cluster

GET /deploy/kubernetes/clusters/{cluster_id}

Get the contents of the specified kubernetes cluster

Request

Path Parameters

Query Parameters

region

Required *

string

Region of the cluster

Response

200 - Successful Result

resource_group_id

string

Resource Group ID

resource_group_name

string

Resource Group name

id

string

Cluster ID

name

string

Cluster name

region

string

Cluster region

ingress_hostname

string

Cluster Ingress hostname

provider

string

Cluster provider

status

string

Cluster status

401 - Unauthorized

403 - No Permissions

404 - No such cluster

Get cluster namespaces

GET /deploy/kubernetes/clusters/{cluster_id}/namespaces

Get the namespaces associated with the specified kubernetes cluster

Request

Path Parameters

Query Parameters

region

Required *

string

Cluster region

limit

integer

The maximum number of results to return

offset

integer

The number of results to skip before returning values

Response

200 - List of namespaces on the cluster that are visible by the current user

offset

integer

The offset (origin 0) of the first resource in this page of search results.

limit

integer

The maximum number of resources returned in each page of search results.

total_count

integer

The overall total number of resources in the search result set.

resource_count

integer

The number of resources returned in this page of search results.

first

string

A URL for retrieving the first page of search results.

last

string

A URL for retrieving the last page of search results.

prev

string

A URL for retrieving the previous page of search results.

next

string

A URL for retrieving the next page of search results.

resources

array

Resulting objects

401 - Unauthorized

403 - No Permissions

404 - No such cluster

Deploy operators

POST /deploy/kubernetes/olm/operator

Deploy operators on a kubernetes cluster

Request

Request Body

Response

200 - Successful Result

401 - Unauthorized

403 - No Permissions

List operators

GET /deploy/kubernetes/olm/operator

List the operators from a kubernetes cluster

Request

Path Parameters

Query Parameters

cluster_id

Required *

string

Cluster identification

region

Required *

string

Cluster region

version_locator_id

Required *

string

A dotted value of `catalogID`.`versionID`

Response

200 - Successful Result

401 - Unauthorized

403 - No Permissions

Update operators

PUT /deploy/kubernetes/olm/operator

Update the operators on a kubernetes cluster

Request

Request Body

Response

200 - Successful Result

401 - Unauthorized

403 - No Permissions

Delete operators

DELETE /deploy/kubernetes/olm/operator

Delete operators from a kubernetes cluster

Request

Path Parameters

Query Parameters

cluster_id

Required *

string

Cluster identification

region

Required *

string

Cluster region

version_locator_id

Required *

string

A dotted value of `catalogID`.`versionID`

Response

200 - Successful Result

401 - Unauthorized

403 - No Permissions

Install version

POST /versions/{version_loc_id}/install

Create an install for the specified version

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Request Body

Path Parameters

Query Parameters

Response

202 - Request accepted

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering

Pre-install version

POST /versions/{version_loc_id}/preinstall

Create a pre-install for the specified version

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Request Body

Response

202 - Request accepted

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering

Get version pre-install status

GET /versions/{version_loc_id}/preinstall

Get the pre-install status for the specified version

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Path Parameters

Query Parameters

cluster_id

string

ID of the cluster

region

string

Cluster region

namespace

string

Required if the version's pre-install scope is `namespace`

Response

200 - Preinstall status

metadata

object

Installation status metadata

release

object

Release information

content_mgmt

object

Content management information

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering

Validate offering

POST /versions/{version_loc_id}/validation/install

Validate the offering associated with the specified version

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Request Body

Response

202 - Request accepted

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering

Get offering install status

GET /versions/{version_loc_id}/validation/install

Returns the install status for the specified offering version

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Response

200 - Successful Result

validated

string

Date and time of last successful validation

requested

string

Date and time of last validation was requested

state

string

Current validation state - <empty>, in_progress, valid, invalid, expired

last_operation

string

Last operation (e.g. submit_deployment, generate_installer, install_offering

target

object

Validation target information (e.g. cluster_id, region, namespace, etc). Values will vary by Content type

message

string

Any message needing to be conveyed as part of the validation job

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering

Get schematics workspaces

GET /versions/{version_loc_id}/workspaces

Returns the schematics workspaces for the specified offering version

Request

Response

200 - Successful Result

offset

integer

The offset (origin 0) of the first resource in this page of search results.

limit

integer

The maximum number of resources returned in each page of search results.

total_count

integer

The overall total number of resources in the search result set.

resource_count

integer

The number of resources returned in this page of search results.

first

string

A URL for retrieving the first page of search results.

last

string

A URL for retrieving the last page of search results.

prev

string

A URL for retrieving the previous page of search results.

next

string

A URL for retrieving the next page of search results.

resources

array

Resulting objects

401 - Unauthorized

403 - No Permissions

404 - No such catalog/offering/kind/version

Get resource groups

GET /deploy/schematics/resourcegroups

Returns all active resource groups in the current account, where the current user has permission to create schematics workspaces.

Request

Response

200 - Successful Result

offset

integer

The offset (origin 0) of the first resource in this page of search results.

limit

integer

The maximum number of resources returned in each page of search results.

total_count

integer

The overall total number of resources in the search result set.

resource_count

integer

The number of resources returned in this page of search results.

first

string

A URL for retrieving the first page of search results.

last

string

A URL for retrieving the last page of search results.

prev

string

A URL for retrieving the previous page of search results.

next

string

A URL for retrieving the next page of search results.

resources

array

Resulting Resource Group objects

401 - Unauthorized

403 - No Permissions

Get license providers

GET /license/license_providers

Get license providers

Request

Response

200 - Successful response.

total_results

integer

Total number of results

total_pages

integer

Total number of pages

prev_url

string

Previous URL

next_url

string

Next URL

resources

array

Resulting License Provider objects

List license entitlements

GET /license/entitlements

Returns the license entitlements bound to an account

Request

Path Parameters

Query Parameters

account_id

string

The account ID to query for the entitlement. Default is the account from the user's token.

license_product_id

string

The license product ID. If from PPA (Passport Advantage) this is the product Part number(s) which can be one or more IDs, eg. D1YGZLL,5737L09

version_id

string

The GC ID of the specific offering version.

state

string

The state of the license entitlement. eg. usually 'active', or if it's been deleted will show as 'removed'.

Response

200 - Successful response.

total_results

integer

Total number of results

total_pages

integer

Total number of pages

prev_url

string

Previous URL

next_url

string

Next URL

resources

array

Resulting Entitlement objects

Create license entitlement

POST /license/entitlements

Create an entitlement for a Cloud account. This is used to give an account an entitlement to a license.

Request

Request Body

LicenseEntitlementBody

name

string

Entitlement name

effective_from

string

Entitlement is good from this starting date. eg. '2019-07-17T21:21:47.6794935Z'

effective_until

string

Entitlement is good until this ending date. eg. '2019-07-17T21:21:47.6794935Z'

version_id

string

Global Catalog ID of the version

license_id

string

Specific license entitlement ID from the license provider, eg. D1W3R4

license_owner_id

string

IBM ID of the owner of this license entitlement

license_provider_id

string

License provider ID

license_product_id

string

License product ID

Path Parameters

Query Parameters

account_id

string

if not specified the token's account will be used

Response

200 - Successful creation

name

string

Entitlement name

id

string

Entitlement ID

crn

string

Entitlement CRN

url

string

URL for the BSS entitlement, e.g. /v1/licensing/entitlements/:id

offering_type

string

Entitlement offering type

state

string

State of the BSS entitlement, e.g. 'active' or if it's been deleted, 'removed'.

effective_from

string

Entitlement is good from this starting date. eg. '2019-07-17T21:21:47.6794935Z'

effective_until

string

Entitlement is good until this ending date. eg. '2019-07-17T21:21:47.6794935Z'

account_id

string

Account ID where this entitlement is bound to

owner_id

string

Account ID of owner

version_id

string

GC ID of the specific offering version

license_offering_id

string

Marketplace offering ID for this license entitlement

license_id

string

Specific license entitlement ID from the license provider, eg. D1W3R4

license_owner_id

string

IBM ID of the owner of this license entitlement

license_type

string

Type of license entitlement, e.g. ibm-ppa

license_provider_id

string

ID of the license provider

license_provider_url

string

URL for the BSS license provider, e.g. /v1/licensing/license_providers/:license_provider_id

license_product_id

string

Specific license entitlement ID from the license provider, eg. D1W3R4

namespace_repository

string

Location of the registry images, eg. cp/cp4d

apikey

string

API key for access to the license entitlement

create_by

string

IBM ID

update_by

string

IBM ID

create_at

string

Creation date, eg. '2019-07-17T21:21:47.6794935Z'

updated_at

string

Date last updated, eg. '2019-07-17T21:21:47.6794935Z'

history

array

Entitlement history

offering_list

array

Array of license offering references

401 - Unauthorized

403 - No Permissions

Get license entitlements for license product ID

GET /license/entitlements/productID/{license_product_id}

Get the license entitlements for a specific license product ID bound to an account

Request

Path Parameters

Query Parameters

account_id

string

The account ID to query for the entitlement. Default is the account from the user's token.

version_id

string

The GC ID of the specific offering version.

Response

200 - Successful response.

total_results

integer

Total number of results

total_pages

integer

Total number of pages

prev_url

string

Previous URL

next_url

string

Next URL

resources

array

Resulting Entitlement objects

Delete license entitlement

DELETE /license/entitlements/{entitlement_id}

Delete a license entitlement that is bound to an account. Note that BSS will mark the entitlement field "state": "removed".

Request

Path Parameters

Query Parameters

account_id

string

The account ID to query for the entitlement. Default is the account from the user's token.

Response

200 - Successful response.

401 - Unauthorized

403 - No Permissions

Get licenses

GET /license/licenses

Retrieve available licenses from supported license subsystems. This is used to get the list of available licenses that the user has

Request

Path Parameters

Query Parameters

license_provider_id

Required *

string

ID of the license provider, ie. retrieved from GET license_providers

account_id

string

If not specified the token's account will be used

name

string

License name

license_type

string

Type of license, if not specified, default is ibm-ppa

license_product_id

string

The license product ID. If from PPA (Passport Advantage) this is the product Part number, eg. D1YGZLL

Response

200 - Successful response.

total_results

integer

Total number of results

total_pages

integer

Total number of pages

prev_url

string

Previous URL

next_url

string

Next URL

resources

array

Resulting License objects

Create an offering resource instance

POST /instances/offerings

Provision a new offering in a given account, and return its resource instance

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Request Body

Path Parameters

Query Parameters

Response

201 - New instance created successfully

id

string

provisioned instance ID (part of the CRN).

_rev

string

Cloudant revision

url

string

url reference to this object.

crn

string

platform CRN for this instance.

label

string

the label for this instance.

catalog_id

string

Catalog ID this instance was created from.

offering_id

string

Offering ID this instance was created from.

kind_format

string

the format this instance has (helm, operator, ova...).

kind_format_label

string

Display value for the format this instance has (helm, operator, ova...).

version

string

The version this instance was installed from (semver - not version id)

version_id

string

The version id this instance was installed from (version id - not semver)

cluster_id

string

Cluster ID

cluster_region

string

Cluster region (e.g., us-south)

cluster_namespaces

array

List of target namespaces to install into

cluster_all_namespaces

boolean

designate to install into all namespaces

schematics_workspace_id

string

Id of the schematics workspace, for offering instances provisioned through schematics

install_plan

string

Type of install plan (also known as approval strategy) for operator subscriptions. Can be either automatic, which automatically upgrades operators to the latest in a channel, or manual, which requires approval on the cluster

channel

string

Channel to pin the operator subscription to

created

string

date and time create

updated

string

date and time updated

metadata

object

Map of metadata values for this offering instance

resource_group_id

string

Id of the resource group to provision the offering instance into

location

string

String location of OfferingInstance deployment

disabled

boolean

Indicates if Resource Controller has disabled this instance

account

string

The account this instance is owned by

last_operation

object

the last operation performed and status

kind_target

string

The target kind for the installed software version

kind_target_label

string

Display value for the target kind for the installed software version

sha

string

The digest value of the installed software version

plan_id

string

The software plan ID used when creating this software instance

parent_crn

string

The CRN of the resource that is considered a parent of this software instance

plan_entitlement

PlanEntitlement

Entitlement information for licenses provisioned from plan

401 - Unauthorized

403 - No Permissions

Get Offering Instance

GET /instances/offerings/{instance_identifier}

Get the resource associated with an installed offering instance.

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Response

200 - Successful Result

id

string

provisioned instance ID (part of the CRN).

_rev

string

Cloudant revision

url

string

url reference to this object.

crn

string

platform CRN for this instance.

label

string

the label for this instance.

catalog_id

string

Catalog ID this instance was created from.

offering_id

string

Offering ID this instance was created from.

kind_format

string

the format this instance has (helm, operator, ova...).

kind_format_label

string

Display value for the format this instance has (helm, operator, ova...).

version

string

The version this instance was installed from (semver - not version id)

version_id

string

The version id this instance was installed from (version id - not semver)

cluster_id

string

Cluster ID

cluster_region

string

Cluster region (e.g., us-south)

cluster_namespaces

array

List of target namespaces to install into

cluster_all_namespaces

boolean

designate to install into all namespaces

schematics_workspace_id

string

Id of the schematics workspace, for offering instances provisioned through schematics

install_plan

string

Type of install plan (also known as approval strategy) for operator subscriptions. Can be either automatic, which automatically upgrades operators to the latest in a channel, or manual, which requires approval on the cluster

channel

string

Channel to pin the operator subscription to

created

string

date and time create

updated

string

date and time updated

metadata

object

Map of metadata values for this offering instance

resource_group_id

string

Id of the resource group to provision the offering instance into

location

string

String location of OfferingInstance deployment

disabled

boolean

Indicates if Resource Controller has disabled this instance

account

string

The account this instance is owned by

last_operation

object

the last operation performed and status

kind_target

string

The target kind for the installed software version

kind_target_label

string

Display value for the target kind for the installed software version

sha

string

The digest value of the installed software version

plan_id

string

The software plan ID used when creating this software instance

parent_crn

string

The CRN of the resource that is considered a parent of this software instance

plan_entitlement

PlanEntitlement

Entitlement information for licenses provisioned from plan

401 - Unauthorized

403 - No Permissions

404 - No such catalog id

Update Offering Instance

PUT /instances/offerings/{instance_identifier}

Update an installed offering instance.

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Request Body

Path Parameters

Query Parameters

Response

200 - Successful Result

id

string

provisioned instance ID (part of the CRN).

_rev

string

Cloudant revision

url

string

url reference to this object.

crn

string

platform CRN for this instance.

label

string

the label for this instance.

catalog_id

string

Catalog ID this instance was created from.

offering_id

string

Offering ID this instance was created from.

kind_format

string

the format this instance has (helm, operator, ova...).

kind_format_label

string

Display value for the format this instance has (helm, operator, ova...).

version

string

The version this instance was installed from (semver - not version id)

version_id

string

The version id this instance was installed from (version id - not semver)

cluster_id

string

Cluster ID

cluster_region

string

Cluster region (e.g., us-south)

cluster_namespaces

array

List of target namespaces to install into

cluster_all_namespaces

boolean

designate to install into all namespaces

schematics_workspace_id

string

Id of the schematics workspace, for offering instances provisioned through schematics

install_plan

string

Type of install plan (also known as approval strategy) for operator subscriptions. Can be either automatic, which automatically upgrades operators to the latest in a channel, or manual, which requires approval on the cluster

channel

string

Channel to pin the operator subscription to

created

string

date and time create

updated

string

date and time updated

metadata

object

Map of metadata values for this offering instance

resource_group_id

string

Id of the resource group to provision the offering instance into

location

string

String location of OfferingInstance deployment

disabled

boolean

Indicates if Resource Controller has disabled this instance

account

string

The account this instance is owned by

last_operation

object

the last operation performed and status

kind_target

string

The target kind for the installed software version

kind_target_label

string

Display value for the target kind for the installed software version

sha

string

The digest value of the installed software version

plan_id

string

The software plan ID used when creating this software instance

parent_crn

string

The CRN of the resource that is considered a parent of this software instance

plan_entitlement

PlanEntitlement

Entitlement information for licenses provisioned from plan

401 - Unauthorized

403 - No Permissions

404 - No such catalog id

Delete a version instance

DELETE /instances/offerings/{instance_identifier}

Delete and instance deployed out of a product version

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Path Parameters

Query Parameters

Response

200 - Successful Result

401 - Unauthorized

403 - No Permissions

404 - No such catalog

Get offering/plan 'branch'

GET /plans/{plan_loc_id}

Get the Offering/Plan 'branch' for the specified locator ID

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Response

200 - Successful response. Your permissions determine what you can see

id

string

unique id

_rev

string

Cloudant revision

url

string

The url for this specific offering

crn

string

The crn for this specific offering

label

string

Display Name in the requested language

label_i18n

I18n

Translated display Name, by language code

name

string

The programmatic name of this offering

offering_icon_url

string

URL for an icon associated with this offering

offering_docs_url

string

URL for an additional docs with this offering

offering_support_url

string

[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering

tags

array

List of tags associated with this catalog

keywords

array

List of keywords associated with offering, typically used to search for it

rating

Rating

Repository info for offerings

created

string

The date and time this catalog was created

updated

string

The date and time this catalog was last updated

short_description

string

Short description in the requested language

short_description_i18n

I18n

Translated short description, by language code

long_description

string

Long description in the requested language

long_description_i18n

I18n

Translated long description, by language code

features

array

list of features associated with this offering

kinds

array

Array of kind

publish

PublishObject

Publish information

pc_managed

boolean

Offering is managed by Partner Center

publish_approved

boolean

Offering has been approved to publish to permitted to IBM or Public Catalog

share_with_all

boolean

Denotes public availability of an Offering

share_with_ibm

boolean

Denotes IBM employee availability of an Offering - if share_enabled is true

share_enabled

boolean

Denotes sharing including access list availability of an Offering is enabled

public_original_crn

string

The original offering CRN that this publish entry came from

publish_public_crn

string

The crn of the public catalog entry of this offering

portal_approval_record

string

The portal's approval record ID

portal_ui_url

string

The portal UI URL

catalog_id

string

The id of the catalog containing this offering

catalog_name

string

The name of the catalog

metadata

object

Map of metadata values for this offering

disclaimer

string

A disclaimer for this offering

hidden

boolean

Determine if this offering should be displayed in the Consumption UI

provider

string

Deprecated - Provider of this offering

provider_info

ProviderInfo

Information on the provider for this offering, or omitted if no provider information is given.

repo_info

RepoInfo

Repository info for offerings

image_pull_keys

array

Image pull keys for this offering

support

Support

Offering Support information

media

array

A list of media items related to this offering

deprecate_pending

DeprecatePending

Deprecation information for this offering.

product_kind

string

The product kind. Valid values are module, solution, or empty string

badges

array

A list of badges for this offering

plans

array

A list of plans for this offering

Delete plan

DELETE /plans/{plan_loc_id}

Delete the specified plan. A plan cannot be deleted if it published.

Auditing

Calling this method generates the following auditing event.

  • ``

Request

Response

200 - Plan deleted successfully

400 - Bad request

401 - Unauthorized

403 - No Permissions