About cookies on this site Our websites require some cookies to function properly (required). In addition, other cookies may be used with your consent to analyze site usage, improve the user experience and for advertising. For more information, please review your options. By visiting our website, you agree to our processing of information as described in IBM’sprivacy statement. To provide a smooth navigation, your cookie preferences will be shared across the IBM web domains listed here.
Introduction
Last updated: 2021-10-14
With the catalog management service, you can define the way users in your account can interact with the IBM Cloud® catalog and the private catalogs that you've created. You can use private catalogs to centrally manage access to products. For more information, see Customizing what's available in your private catalogs.
API endpoint
https://cm.globalcatalog.cloud.ibm.com/api/v1-beta
The code examples on this tab use the client library that is provided for Java.
Maven
<dependency>
<groupId>com.ibm.cloud</groupId>
<artifactId>platform-services</artifactId>
<version>0.8.0</version>
</dependency>
Gradle
'com.ibm.cloud:platform-services:0.8.0'
GitHub
API endpoint
https://cm.globalcatalog.cloud.ibm.com/api/v1-beta
Creating an instance of the Catalog Management service using the Java SDK is shown below.
Authentication can be specified via environment variables.
export CATALOG_MANAGEMENT_AUTH_TYPE=iam
export CATALOG_MANAGEMENT_APIKEY={apikey}
import com.ibm.cloud.platform_services.catalog_management.v1.*;
import com.ibm.cloud.sdk.core.http.Response;
CatalogManagement service = CatalogManagement.newInstance();
The code examples on this tab use the client library that is provided for Node.js.
Installation
npm i @ibm-cloud/platform-services
GitHub
API endpoint
https://cm.globalcatalog.cloud.ibm.com/api/v1-beta
Creating an instance of the Catalog Management service using the Node.js SDK is shown below.
Authentication can be specified via environment variables.
export CATALOG_MANAGEMENT_AUTH_TYPE=iam
export CATALOG_MANAGEMENT_APIKEY={apikey}
const CatalogManagementV1 = require('@ibm-cloud/platform-services/catalog-management/v1');
service = CatalogManagementV1.newInstance({});
The code examples on this tab use the client library that is provided for Python.
Installation
To install, use pip or easy_install:
pip install --upgrade ibm-platform-services
or
easy_install --upgrade ibm-platform-services
GitHub
API endpoint
https://cm.globalcatalog.cloud.ibm.com/api/v1-beta
Creating an instance of the Catalog Management service using the Node.js SDK is shown below.
Authentication can be specified via environment variables.
export CATALOG_MANAGEMENT_AUTH_TYPE=iam
export CATALOG_MANAGEMENT_APIKEY={apikey}
from ibm_platform_services.catalog_management_v1 import *
service = CatalogManagementV1.new_instance()
There are a few different ways to download and install the Platform Services Go SDK project for use by your Go application:
- Go get command
Use this command to download and install the Platform Services Go SDK project to allow your Go application to use it:
go get -u github.ibm.com/ibmcloud/platform-services-go-sdk
- Go modules
If your application is using Go modules, you can add a suitable import to your Go application, like this:
import (
"github.ibm.com/ibmcloud/platform-services-go-sdk/catalogmanagementv1"
)
Next, run go mod tidy to download and install the new dependency and update your Go application's go.mod file.
- Dep dependency manager
If your application is using the dep dependency management tool, you can add a dependency to your Gopkg.toml file. Here is an example:
[[constraint]]
name = "github.ibm.com/ibmcloud/platform-services-go-sdk/catalogmanagementv1"
version = "0.7.0"
then run
dep ensure
GitHub
API endpoint
https://cm.globalcatalog.cloud.ibm.com/api/v1-beta
Creating an instance of the Catalog Management service using the Go SDK is shown below.
Authentication can be specified via environment variables.
export CATALOG_MANAGEMENT_AUTH_TYPE=iam
export CATALOG_MANAGEMENT_APIKEY={apikey}
import (
"github.com/IBM/go-sdk-core/v3/core"
"github.com/IBM/platform-services-go-sdk/catalogmanagementv1"
)
service, _ := catalogmanagementv1.NewCatalogManagementV1UsingExternalConfig(
&catalogmanagementv1.CatalogManagementV1Options{},
)
Endpoint URLs
The Catalog Management API uses the following global endpoint URL for all regions. When you call the API, add the path for each method to form the complete API endpoint for your requests.
https://cm.globalcatalog.cloud.ibm.com
If you enabled service endpoints in your account, you can send API requests over the IBM Cloud® private network at the following base endpoint URLs. For more information, see Enabling VRF and service endpoints.
- Private endpoint URL for VPC infrastructure:
https://cm.private.globalcatalog.cloud.ibm.com - Private endpoint URLs for classic infrastructure:
- Dallas:
https://cm.private.us-south.globalcatalog.cloud.ibm.com - Washington DC:
https://cm.private.us-east.globalcatalog.cloud.ibm.com
- Dallas:
Example API request
curl -X {request_method} "https://cm.globalcatalog.cloud.ibm.com/{method_endpoint}"
Replace {request_method} and {method_endpoint} in this example with the values for your particular API call.
Methods
Get catalog account settings
Get the account level settings for the account for private catalog
GET /catalogaccount
Request
No Request Parameters
getOptions := service.NewGetCatalogAccountOptions() _, response, _ := service.GetCatalogAccount(getOptions) fmt.Println(response)
Response<Account> response = service.getCatalogAccount().execute(); System.out.println(response.getResult());
response = self.service.get_catalog_account() print(response)
response = await service.getCatalogAccount(); console.log(response);
Update account settings
Update the account level settings for the account for private catalog
PUT /catalogaccount
Request
Account information
Account identification
Cloudant revision
Hide the public catalog in this account
Filters for account and catalog filters
Region filter string
curl -X "PUT" "https://cm.globalcatalog.cloud.ibm.com/api/v1-beta/catalogaccount" -H "accept: */*" -H "Authorization: {iam-bearer-token}" -d '{"id":"string","hide_IBM_cloud_catalog":true,"account_filters":{"include_all":true,"category_filters":{"additionalProp1":{"include":true,"filter":{"filter_terms":["string"]}},"additionalProp2":{"include":true,"filter":{"filter_terms":["string"]}},"additionalProp3":{"include":true,"filter":{"filter_terms":["string"]}}},"id_filters":{"include":{"filter_terms":["string"]},"exclude":{"filter_terms":["string"]}}}}'
Get catalog account audit logs
Get the audit logs associated with a catalog account.
GET /catalogaccount/audits
Request
Query Parameters
Start token for a query
number or results to return in the query
Possible values: value ≤ 1000
Default:
100Auditlog Lookup Names - by default names are not returned in auditlog.
Response
A collection of audit records
The limit that was applied to this response. It may be smaller than in the request because that was too large
The number of resources returned in this response
Link response on a token paginated query
A list of audit records
The start token used for this response
The total count of resources in the system that matches the request
Link response on a token paginated query
Link response on a token paginated query
Link response on a token paginated query
Status Code
Successful response. Your permissions determine what you can see
Unauthorized
No Permissions
No Sample Response
Get a catalog account audit log entry
Get the full audit log entry associated with a catalog account.
GET /catalogaccount/audits/{auditlog_identifier}Request
Path Parameters
Auditlog ID
Query Parameters
Auditlog Lookup Names - by default names are not returned in auditlog.
Response
An audit log which describes a change made to a catalog or associated resource.
The identifier of the audit record.
Cloudant revision
The time at which the change was made.
The type of change described by the audit record.
The resource type associated with the change.
The identifier of the resource that was changed.
The email address of the user that made the change.
The email address of the delegate user that made the change. This happens when a service makes a change onbehalf of the user
A message which describes the change.
Transaction id for this change
IAM identifier of the user who made the change
Name of the user who made the change
IAM identifier of the delegate user who made the change
Name of the delegate user who made the change
Data about the change. Usually a change log of what was changed, both before and after. Can be of any type.
Status Code
Successful response. Your permissions determine what you can see
Unauthorized
No Permissions
No Sample Response
Get catalog account filters
Get the accumulated filters of the account and of the catalogs you have access to.
GET /catalogaccount/filters
Request
Query Parameters
catalog id. Narrow down filters to the account and just the one catalog.
getOptions := service.NewGetCatalogAccountFiltersOptions() _, response, _ := service.GetCatalogAccountFilters(getOptions) fmt.Println(response)
Response<AccumulatedFilters> response = service.getCatalogAccountFilters().execute(); System.out.println(response.getResult());
response = self.service.get_catalog_account_filters() print(response)
response = await service.getCatalogAccountFilters(); console.log(response);
Response
The accumulated filters for an account. This will return the account filters plus a filter for each catalog the user has access to.
Hide the public catalog in this account
Filters for accounts (at this time this will always be just one item array)
The filters for all of the accessible catalogs.
- catalog_filters
Filters for catalog
- catalog
The ID of the catalog
The name of the catalog
Filters for account and catalog filters
Status Code
Successful response. Your permissions determine what you can see
Unauthorized
No Permissions
No Sample Response
Get catalog account audit log
Get the audit log associated with a catalog account.
GET /catalogaccount/audit
Request
Query Parameters
Log identification.
curl -X "GET" \ "https://cm.globalcatalog.cloud.ibm.com/api/v1-beta/catalogs/{catalog-id}/audit" -H "accept: application/json" -H "Authorization: {iam-bearer-token}"
Response
A collection of audit records
The bookmark of the first resource in this page of search results. Omit for first entry.
The maximum number of resources returned in each page of search results.
The number of resources returned in this page of search results.
A URL for retrieving the first page of search results.
A URL for retrieving the last page of search results.
A URL for retrieving the previous page of search results.
A URL for retrieving the next page of search results.
A list of audit records
Status Code
Successful response. Your permissions determine what you can see
Unauthorized
No Permissions
No Sample Response
Get share approval access list
Get the share approval access list associated with the specified object type
GET /shareapproval/{object_type}/accessRequest
Path Parameters
The type for the object
Allowable values: [
offering,vpe,proxy_source,preset_configuration]
Query Parameters
Start token for a query
number or results to return in the query
Possible values: value ≤ 1000
Default:
100
Response
Paginated search result for share approval requests
The limit that was applied to this response. It may be smaller than in the request because that was too large
The number of resources returned in this response
Link response on a token paginated query
A list of access records
The start token used for this response
The total count of resources in the system that matches the request
Link response on a token paginated query
Link response on a token paginated query
Link response on a token paginated query
Status Code
Successful response
Bad request
Unauthorized
No Permissions
No Sample Response
Delete share approval access
Delete share approval accesses associated with the specified object type
DELETE /shareapproval/{object_type}/accessAdd accesses to share approval access list
Add one or more accesses to the share approval access list for a specific object type.
POST /shareapproval/{object_type}/accessGet share approval access list for requesting accounts
Get the share approval access list associated with the specified object type in a certain approval state for requesting accounts
GET /shareapproval/{object_type}/access/source/{approval_state_identifier}Request
Path Parameters
The type for the object
Allowable values: [
offering,vpe,proxy_source,preset_configuration]The different possible approval states for share requests or access request.
Allowable values: [
approved,pending,rejected]
Query Parameters
Start token for a query
number or results to return in the query
Possible values: value ≤ 1000
Default:
100Execute the request in the context of an enterprise or enterpise account group ID. Use '-ent-enterpriseid' for an enterprise and '-entgrp-enterprisegroupid for an enterprise group
Response
Paginated search result for share approval requests
The limit that was applied to this response. It may be smaller than in the request because that was too large
The number of resources returned in this response
Link response on a token paginated query
A list of access records
The start token used for this response
The total count of resources in the system that matches the request
Link response on a token paginated query
Link response on a token paginated query
Link response on a token paginated query
Status Code
Successful response
Bad request
Unauthorized
No Permissions
No Sample Response
Update approval states for share approval access list for requesting accounts
Update one or more access approval states from the share approval access list for a specific object type for requesting accounts.
POST /shareapproval/{object_type}/access/source/{approval_state_identifier}Request
Path Parameters
The type for the object
Allowable values: [
offering,vpe,proxy_source,preset_configuration]The different possible approval states for share requests or access request.
Allowable values: [
approved,pending,rejected]
Query Parameters
Execute the request in the context of an enterprise or enterpise account group ID. Use '-ent-enterpriseid' for an enterprise and '-entgrp-enterprisegroupid for an enterprise group
A list of accesses to update to the specified approval state.
Get list of catalogs
Retrieves the available catalogs for a given account. This can be used by an unauthenticated user to retrieve the public catalog.
GET /catalogs
Request
No Request Parameters
listOptions := service.NewListCatalogsOptions() _, response, _ := service.ListCatalogs(listOptions) fmt.Println(response)
Response<CatalogSearchResult> response = service.listCatalogs().execute(); System.out.println(response.getResult());
response = self.service.list_catalogs() print(response)
response = await service.listCatalogs(); console.log(response);
Response
Paginated catalog search result
The offset (origin 0) of the first resource in this page of search results.
The maximum number of resources returned in each page of search results.
The overall total number of resources in the search result set.
The number of resources returned in this page of search results.
A URL for retrieving the first page of search results.
A URL for retrieving the last page of search results.
A URL for retrieving the previous page of search results.
A URL for retrieving the next page of search results.
Resulting objects
Status Code
Successful response. Your permissions determine what you can see
No Sample Response
Request
Catalog information
Display Name in the requested language
Translated display name, by language code
- label_i18n
Description in the requested language
Translated description, by language code
- short_description_i18n
URL for an icon associated with this catalog
URL for a banner image for this catalog
List of tags associated with this catalog
List of features associated with this catalog
Denotes whether a catalog is disabled
Resource group id the catalog is owned by
Account that owns catalog
Filters for account and catalog filters
Kind of catalog. Supported kinds are offering and vpe
Catalog specific metadata
- metadata
List of target accounts contexts on this catalog
label := "{label}" shortDesc := "{shortDesc}" createOptions := service.NewCreateCatalogOptions() createOptions.SetLabel(label) createOptions.SetShortDescription(shortDesc) _, response, _ := service.CreateCatalog(createOptions) fmt.Println(response)
String label = "{label}"; String shortDesc = "{shortDesc}"; CreateCatalogOptions createOptions = new CreateCatalogOptions.Builder().label(label).shortDescription(shortDesc).build(); Response<Catalog> response = service.createCatalog(createOptions).execute(); System.out.println(response.getResult());
label = "{label}" shortDesc = "{shortDesc}" response = self.service.create_catalog(label=label, short_description=shortDesc) print(response)
label = "{label}"; shortDesc = "{shortDesc}"; response = await service.createCatalog({ 'label': label, 'shortDescription': shortDesc }); console.log(response);
Response
Catalog information
Unique ID
Cloudant revision
Display Name in the requested language
Translated display name, by language code
- label_i18n
Description in the requested language
Translated description, by language code
- short_description_i18n
URL for an icon associated with this catalog
URL for a banner image for this catalog
List of tags associated with this catalog
The url for this specific catalog
CRN associated with the catalog
URL path to offerings
List of features associated with this catalog
Denotes whether a catalog is disabled
The date-time this catalog was created
The date-time this catalog was last updated
Resource group id the catalog is owned by
Account that owns catalog
Filters for account and catalog filters
Kind of catalog. Supported kinds are offering and vpe
Catalog specific metadata
- metadata
List of target accounts contexts on this catalog
Status Code
New catalog created successfully
Unauthorized
No Permissions
No Sample Response
Get catalog
Get a catalog. This can also be used by an unauthenticated user to get the public catalog.
GET /catalogs/{catalog_identifier}Request
Path Parameters
Catalog identifier
id := "{id}" getOptions := service.NewGetCatalogOptions(id) _, response, _ := service.GetCatalog(getOptions) fmt.Println(response)
String id = "{id}"; GetCatalogOptions getOptions = new GetCatalogOptions.Builder().catalogIdentifier(id).build(); Response<Catalog> response = service.getCatalog(getOptions).execute(); System.out.println(response.getResult());
id = "{id}" response = self.service.get_catalog(catalog_identifier=id) print(response)
id = "{id}"; response = await service.getCatalog({ 'catalogIdentifier': id }); console.log(response);
Response
Catalog information
Unique ID
Cloudant revision
Display Name in the requested language
Translated display name, by language code
- label_i18n
Description in the requested language
Translated description, by language code
- short_description_i18n
URL for an icon associated with this catalog
URL for a banner image for this catalog
List of tags associated with this catalog
The url for this specific catalog
CRN associated with the catalog
URL path to offerings
List of features associated with this catalog
Denotes whether a catalog is disabled
The date-time this catalog was created
The date-time this catalog was last updated
Resource group id the catalog is owned by
Account that owns catalog
Filters for account and catalog filters
Kind of catalog. Supported kinds are offering and vpe
Catalog specific metadata
- metadata
List of target accounts contexts on this catalog
Status Code
Successful Result
Unauthorized
No Permissions
No such catalog id
No Sample Response
Request
Path Parameters
Catalog identifier
Catalog information
Unique ID
Cloudant revision
Display Name in the requested language
Translated display name, by language code
- label_i18n
Description in the requested language
Translated description, by language code
- short_description_i18n
URL for an icon associated with this catalog
URL for a banner image for this catalog
List of tags associated with this catalog
List of features associated with this catalog
Denotes whether a catalog is disabled
Resource group id the catalog is owned by
Account that owns catalog
Filters for account and catalog filters
Kind of catalog. Supported kinds are offering and vpe
Catalog specific metadata
- metadata
List of target accounts contexts on this catalog
curl -X "PUT" "https://cm.globalcatalog.cloud.ibm.com/api/v1-beta/catalogs/{catalog-id}" -H "accept: application/json" -H "Authorization: {iam-bearer-token}" -d '{"id":"string","_rev":"string","label":"string","short_description":"string","catalog_icon_url":"string","tags":["string"],"features":[{"title":"string","description":"string"}],"resource_group_id":"string","catalog_filters":{"include_all":true,"category_filters":{"additionalProp1":{"include":true,"filter":{"filter_terms":["string"]}},"additionalProp2":{"include":true,"filter":{"filter_terms":["string"]}},"additionalProp3":{"include":true,"filter":{"filter_terms":["string"]}}},"id_filters":{"include":{"filter_terms":["string"]},"exclude":{"filter_terms":["string"]}}},"kind":"string"}'
Response
Catalog information
Unique ID
Cloudant revision
Display Name in the requested language
Translated display name, by language code
- label_i18n
Description in the requested language
Translated description, by language code
- short_description_i18n
URL for an icon associated with this catalog
URL for a banner image for this catalog
List of tags associated with this catalog
The url for this specific catalog
CRN associated with the catalog
URL path to offerings
List of features associated with this catalog
Denotes whether a catalog is disabled
The date-time this catalog was created
The date-time this catalog was last updated
Resource group id the catalog is owned by
Account that owns catalog
Filters for account and catalog filters
Kind of catalog. Supported kinds are offering and vpe
Catalog specific metadata
- metadata
List of target accounts contexts on this catalog
Status Code
Successful Result
Unauthorized
No Permissions
No such catalog id
No Sample Response
Request
Path Parameters
Catalog identifier
id := "{id}" deleteOptions := service.NewDeleteCatalogOptions(id) response, _ := service.DeleteCatalog(deleteOptions) fmt.Println(response)
String id = "{id}"; DeleteCatalogOptions deleteOptions = new DeleteCatalogOptions.Builder().catalogIdentifier(id).build(); Response<Void> response = service.deleteCatalog(deleteOptions).execute(); System.out.println(response.getResult());
id = "{id}" response = self.service.delete_catalog(catalog_identifier=id, id=id) print(response)
id = "{id}"; response = await service.deleteCatalog({ 'catalogIdentifier': id, 'id': id }); console.log(response);
Get catalog audit logs
Get the audit logs associated with a catalog.
GET /catalogs/{catalog_identifier}/auditsRequest
Path Parameters
Catalog identifier
Query Parameters
Start token for a query
number or results to return in the query
Possible values: value ≤ 1000
Default:
100Auditlog Lookup Names - by default names are not returned in auditlog.
Response
A collection of audit records
The limit that was applied to this response. It may be smaller than in the request because that was too large
The number of resources returned in this response
Link response on a token paginated query
A list of audit records
The start token used for this response
The total count of resources in the system that matches the request
Link response on a token paginated query
Link response on a token paginated query
Link response on a token paginated query
Status Code
Successful response. Your permissions determine what you can see
Unauthorized
No Permissions
No Sample Response
Get a catalog audit log entry
Get the full audit log entry associated with a catalog.
GET /catalogs/{catalog_identifier}/audits/{auditlog_identifier}Request
Path Parameters
Catalog identifier
Auditlog ID
Query Parameters
Auditlog Lookup Names - by default names are not returned in auditlog.
Response
An audit log which describes a change made to a catalog or associated resource.
The identifier of the audit record.
Cloudant revision
The time at which the change was made.
The type of change described by the audit record.
The resource type associated with the change.
The identifier of the resource that was changed.
The email address of the user that made the change.
The email address of the delegate user that made the change. This happens when a service makes a change onbehalf of the user
A message which describes the change.
Transaction id for this change
IAM identifier of the user who made the change
Name of the user who made the change
IAM identifier of the delegate user who made the change
Name of the delegate user who made the change
Data about the change. Usually a change log of what was changed, both before and after. Can be of any type.
Status Code
Successful response. Your permissions determine what you can see
Unauthorized
No Permissions
No Sample Response
Get catalog audit log
Get the audit log associated with a catalog.
GET /catalogs/{catalog_identifier}/auditResponse
A collection of audit records
The bookmark of the first resource in this page of search results. Omit for first entry.
The maximum number of resources returned in each page of search results.
The number of resources returned in this page of search results.
A URL for retrieving the first page of search results.
A URL for retrieving the last page of search results.
A URL for retrieving the previous page of search results.
A URL for retrieving the next page of search results.
A list of audit records
Status Code
Successful response. Your permissions determine what you can see
Unauthorized
No Permissions
No Sample Response
Get enterprise settings
Get the enterprise settings for the specified enterprise ID
GET /enterprises/{enterprise_identifier}Request
Path Parameters
Enterprise ID
id := "{id}" getOptions := service.NewGetEnterpriseOptions(id) _, response, _ := service.GetEnterprise(getOptions) fmt.Println(response)
String id = "{id}"; GetEnterpriseOptions getOptions = new GetEnterpriseOptions.Builder().enterpriseId(id).build(); Response<Enterprise> response = service.getEnterprise(getOptions).execute(); System.out.println(response.getResult());
id = "{id}"; response = await service.getEnterprise({ 'enterpriseId': id }); console.log(response);
id = "{id}" response = self.service.get_enterprise(enterprise_id=id) print(response)
Response
Enterprise account information
Enterprise identification
Cloudant revision
Filters for account and catalog filters
Map of account group ids to AccountGroup objects
- account_groups
Filters for an Account Group
Status Code
Successful response. Your permissions determine what you can see
Unauthorized
No Permissions
No Sample Response
Update enterprise settings
Update the settings for an enterprise
PUT /enterprises/{enterprise_identifier}Request
Path Parameters
Enterprise ID
Enterprise account information
Enterprise identification
Cloudant revision
Filters for account and catalog filters
Map of account group ids to AccountGroup objects
- account_groups
Filters for an Account Group
id = "{id}" revision = "{revision}" accountFilters = "{accountFilters}" accountGroups = "{accountGroups}" response = self.service.replace_enterprise(enterprise_id=id, id=id, rev=revision, account_filters= accountFilters, account_groups=accountGroups) print(response)
id := "{id}" revision := "{revision}" accountFilters := {accountFilters} replaceOptions := {replaceOptions} replaceOptions := service.NewReplaceEnterpriseOptions(id) replaceOptions.SetID(id) replaceOptions.SetRev(revision) replaceOptions.SetAccountFilters(accountFilters) replaceOptions.SetAccountGroups(accountGroups) response, _ := service.ReplaceEnterprise(replaceOptions) fmt.Println(response)
String id = "{id}"; String revision = "{revision}"; String accountFilters = {accountFilters}; String accountGroups = {accountGroups}; ReplaceCatalogOptions replaceOptions = new ReplaceEnterpriseOptions.Builder().enterpriseId(id).id(id).rev(revision).accountFilters(accountFilters).accountGroups(accountGroups).build(); Response<Catalog> response = service.replaceEnterprise(replaceOptions).execute(); System.out.println(response.getResult());
id = "{id}"; revision = "{revision}"; accountFilters = {accountFilters}; accountGroups = {accountGroups}; response = await service.replaceEnterprise({ 'enterpriseId': id, 'id': id, 'rev': revision, 'accountFilters': accountFilters, 'accountGroups': accountGroups }); console.log(response);
Get enterprise audit logs
Get the audit logs associated with an enterprise.
GET /enterprises/{enterprise_identifier}/auditsRequest
Path Parameters
Enterprise ID
Query Parameters
Start token for a query
number or results to return in the query
Possible values: value ≤ 1000
Default:
100Auditlog Lookup Names - by default names are not returned in auditlog.
Response
A collection of audit records
The limit that was applied to this response. It may be smaller than in the request because that was too large
The number of resources returned in this response
Link response on a token paginated query
A list of audit records
The start token used for this response
The total count of resources in the system that matches the request
Link response on a token paginated query
Link response on a token paginated query
Link response on a token paginated query
Status Code
Successful response. Your permissions determine what you can see
Unauthorized
No Permissions
No Sample Response
Get an enterprise audit log entry
Get the full audit log entry associated with an enterprise.
GET /enterprises/{enterprise_identifier}/audits/{auditlog_identifier}Request
Path Parameters
Enterprise ID
Auditlog ID
Query Parameters
Auditlog Lookup Names - by default names are not returned in auditlog.
Response
An audit log which describes a change made to a catalog or associated resource.
The identifier of the audit record.
Cloudant revision
The time at which the change was made.
The type of change described by the audit record.
The resource type associated with the change.
The identifier of the resource that was changed.
The email address of the user that made the change.
The email address of the delegate user that made the change. This happens when a service makes a change onbehalf of the user
A message which describes the change.
Transaction id for this change
IAM identifier of the user who made the change
Name of the user who made the change
IAM identifier of the delegate user who made the change
Name of the delegate user who made the change
Data about the change. Usually a change log of what was changed, both before and after. Can be of any type.
Status Code
Successful response. Your permissions determine what you can see
Unauthorized
No Permissions
No Sample Response
Get enterprise audit log
Get the audit log associated with an enterprise.
GET /enterprises/{enterprise_identifier}/auditResponse
A collection of audit records
The bookmark of the first resource in this page of search results. Omit for first entry.
The maximum number of resources returned in each page of search results.
The number of resources returned in this page of search results.
A URL for retrieving the first page of search results.
A URL for retrieving the last page of search results.
A URL for retrieving the previous page of search results.
A URL for retrieving the next page of search results.
A list of audit records
Status Code
Successful response. Your permissions determine what you can see
Unauthorized
No Permissions
No Sample Response
Get consumption 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.
GET /offerings
Request
Query Parameters
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 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.
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.
Allowable values: [
all,public,private]true - include offerings which have been marked as hidden. The default is false and hidden offerings are not returned.
number or results to return
Possible values: value ≤ 1000
Default:
100number of results to skip before returning values
Default:
0
options := service.NewGetConsumptionOfferingsOptions() _, response, _ := service.GetConsumptionOfferings(options) fmt.Println(response)
Response<OfferingSearchResult> response = service.getConsumptionOfferings().execute(); System.out.println(response.getResult());
response = self.service.get_consumption_offerings() print(response)
response = await service.getConsumptionOfferings(); console.log(response);
Response
Paginated offering search result
The offset (origin 0) of the first resource in this page of search results.
The maximum number of resources returned in each page of search results.
The overall total number of resources in the search result set.
The number of resources returned in this page of search results.
A URL for retrieving the first page of search results.
A URL for retrieving the last page of search results.
A URL for retrieving the previous page of search results.
A URL for retrieving the next page of search results.
Resulting objects
Status Code
Successful response. Your permissions determine what you can see
No Sample Response
Get list of offerings
Retrieve the available offerings in the specified catalog. This can also be used by an unauthenticated user to retreive publicly available offerings.
GET /catalogs/{catalog_identifier}/offeringsRequest
Path Parameters
Catalog identifier
Query Parameters
true - Strip down the content of what is returned. For example don't return the readme. Makes the result much smaller. Defaults to false.
The maximum number of results to return
Possible values: value ≤ 1000
Default:
100The number of results to skip before returning values
Default:
0Only return results that contain the specified 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.
true - include offerings which have been marked as hidden. The default is true. To not return hidden offerings false must be explicitly set
Default:
true
id := "{id}" listOptions := service.NewListOfferingsOptions(id) _, response, _ := service.ListOfferings(listOptions) fmt.Println(response)
String id = "{id}"; ListOfferingsOptions listOptions = new ListOfferingsOptions.Builder().catalogIdentifier(id).build(); Response<OfferingSearchResult> response = service.listOfferings(listOptions).execute(); System.out.println(response.getResult());
id = "{id}" response = self.service.list_offerings(catalog_identifier=id) print(response)
id = "{id}"; name = "{name}"; label = "{label}"; response = await service.listOfferings({ 'catalogIdentifier': id, 'id': id, 'name': name, 'label': label }); console.log(response);
Response
Paginated offering search result
The offset (origin 0) of the first resource in this page of search results.
The maximum number of resources returned in each page of search results.
The overall total number of resources in the search result set.
The number of resources returned in this page of search results.
A URL for retrieving the first page of search results.
A URL for retrieving the last page of search results.
A URL for retrieving the previous page of search results.
A URL for retrieving the next page of search results.
Resulting objects
Status Code
Successful response. Your permissions determine what you can see
No Sample Response
Request
Path Parameters
Catalog identifier
Offering information
The url for this specific offering
The crn for this specific offering
Display Name in the requested language
Translated display Name, by language code
- label_i18n
The programmatic name of this offering
URL for an icon associated with this offering
URL for an additional docs with this offering
[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering
List of tags associated with this catalog
List of keywords associated with offering, typically used to search for it
Repository info for offerings
The date and time this catalog was created
The date and time this catalog was last updated
Short description in the requested language
Translated short description, by language code
- short_description_i18n
Long description in the requested language
Translated long description, by language code
- long_description_i18n
list of features associated with this offering
Array of kind
Publish information
Offering is managed by Partner Center
Offering has been approved to publish to permitted to IBM or Public Catalog
Denotes public availability of an Offering
Denotes IBM employee availability of an Offering - if share_enabled is true
Denotes sharing including access list availability of an Offering is enabled
The original offering CRN that this publish entry came from
The crn of the public catalog entry of this offering
The portal's approval record ID
The portal UI URL
The id of the catalog containing this offering
The name of the catalog
Map of metadata values for this offering
- metadata
A disclaimer for this offering
Determine if this offering should be displayed in the Consumption UI
Deprecated - Provider of this offering
Information on the provider for this offering, or omitted if no provider information is given.
Repository info for offerings
Image pull keys for this offering
Offering Support information
A list of media items related to this offering
Deprecation information for this offering.
The product kind. Valid values are module, solution, or empty string
A list of badges for this offering
A list of plans for this offering
id := "{id}" name := "{name}" label := "{label}" offeringOptions := service.NewCreateOfferingOptions(id) offeringOptions.SetName(name) offeringOptions.SetLabel(label) _, response, _ := service.CreateOffering(offeringOptions) fmt.Println(response)
String id = "{id}"; String name = "{name}"; String label = "{label}"; CreateOfferingOptions offeringOptions = new CreateOfferingOptions.Builder().catalogIdentifier(id).name(name).label(label).build(); Response<Offering> response = service.createOffering(offeringOptions).execute(); System.out.println(response.getResult());
id = "{id}" name = "{name}" label = "{label}" response = self.service.create_offering(catalog_identifier=id, name=name, label=label) print(response)
id = "{id}"; name = "{name}"; label = "{label}"; response = await service.createOffering({ 'catalogIdentifier': id, 'id': id, 'name': name, 'label': label }); console.log(response);
Response
Offering information
unique id
Cloudant revision
The url for this specific offering
The crn for this specific offering
Display Name in the requested language
Translated display Name, by language code
- label_i18n
The programmatic name of this offering
URL for an icon associated with this offering
URL for an additional docs with this offering
[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering
List of tags associated with this catalog
List of keywords associated with offering, typically used to search for it
Repository info for offerings
The date and time this catalog was created
The date and time this catalog was last updated
Short description in the requested language
Translated short description, by language code
- short_description_i18n
Long description in the requested language
Translated long description, by language code
- long_description_i18n
list of features associated with this offering
Array of kind
Publish information
Offering is managed by Partner Center
Offering has been approved to publish to permitted to IBM or Public Catalog
Denotes public availability of an Offering
Denotes IBM employee availability of an Offering - if share_enabled is true
Denotes sharing including access list availability of an Offering is enabled
The original offering CRN that this publish entry came from
The crn of the public catalog entry of this offering
The portal's approval record ID
The portal UI URL
The id of the catalog containing this offering
The name of the catalog
Map of metadata values for this offering
- metadata
A disclaimer for this offering
Determine if this offering should be displayed in the Consumption UI
Deprecated - Provider of this offering
Information on the provider for this offering, or omitted if no provider information is given.
Repository info for offerings
Image pull keys for this offering
Offering Support information
A list of media items related to this offering
Deprecation information for this offering.
The product kind. Valid values are module, solution, or empty string
A list of badges for this offering
A list of plans for this offering
Status Code
New offering created successfully
Unauthorized
No Permissions
No Sample Response
Import offering version
Import new version to an offering
POST /catalogs/{catalog_identifier}/offerings/{offering_id}/versionRequest
Custom Headers
Authentication token used to access the specified zip file
Path Parameters
Catalog identifier
Offering identification
Query Parameters
URL path to zip location. If not specified, must provide content in the body of this call.
The semver value for this new version, if not found in the zip url package content
Add all possible configuration values to this version when importing
Indicates that the current terraform template is used to install a virtual server image
The type of repository containing this version. Valid values are 'public_git' or 'enterprise_git'
Additional data to be used when importing an offering or version
Tags array.
Keywords array.
Byte array representing the content to be imported. Only supported for OVA images at this time.
Name of version. Required for virtual server image for VPC.
Display name of version. Required for virtual server image for VPC.
Install type. Example: instance. Required for virtual server image for VPC.
Deployment target of the content being onboarded. Current valid values are iks, roks, vcenter, power-iaas, terraform, and vpc-x86. Required for virtual server image for VPC.
Format of content being onboarded. Example: vsi-image. Required for virtual server image for VPC.
Optional product kind for the software being onboarded. Valid values are software, module, or solution. Default value is software.
Display value for optional product kind for the software being onboarded.
SHA256 fingerprint of the image file. Required for virtual server image for VPC.
Semantic version of the software being onboarded. Required for virtual server image for VPC.
The flavor of the current software being onboarded. Only valid if the Product kind is module or solution.
Generic data to be included with content being onboarded. Required for virtual server image for VPC.
- metadata
Operating system included in this image. Required for virtual server image for VPC.
- operating_system
Images with this operating system can only be used on dedicated hosts or dedicated host groups. Required for virtual server image for VPC.
Vendor of the operating system. Required for virtual server image for VPC.
Globally unique name for this operating system Required for virtual server image for VPC.
URL for this operating system. Required for virtual server image for VPC.
Unique, display-friendly name for the operating system. Required for virtual server image for VPC.
Software family for this operating system. Required for virtual server image for VPC.
Major release version of this operating system. Required for virtual server image for VPC.
Operating system architecture. Required for virtual server image for VPC.
Details for the stored image file. Required for virtual server image for VPC.
- file
Size of the stored image file rounded up to the next gigabyte. Required for virtual server image for VPC.
Minimum size (in gigabytes) of a volume onto which this image may be provisioned. Required for virtual server image for VPC.
Image operating system. Required for virtual server image for VPC.
- images
Programmatic ID of virtual server image. Required for virtual server image for VPC.
Programmatic name of virtual server image. Required for virtual server image for VPC.
Region the virtual server image is available in. Required for virtual server image for VPC.
Optional - The sub-folder within the specified tgz file that contains the software being onboarded
The install type of the variation. Specify extension or fullstack.
catalogID := "{catalogID}" offeringID := "{offeringID}" offeringURL := "{offeringURL}" importOptions := service.NewImportOfferingVersionOptions(catalogID, offeringID, offeringURL) _, response, _ := service.ImportOfferingVersion(importOptions) fmt.Println(response)
String catalogID = "{catalogID}"; String offeringID = "{offeringID}"; String offeringURL = "{offeringURL}"; ImportOfferingVersionOptions newOfferingOptions = new ImportOfferingVersionOptions.Builder().catalogIdentifier(catalogID).offeringId(offeringID).zipurl(offeringURL).build(); Response<Offering> response = service.importOfferingVersion(newOfferingOptions).execute(); System.out.println(response.getResult());
catalogID = "{catalogID}" offeringID = "{offeringID}" offeringURL = "{offeringURL}" response = self.service.import_offering_version(catalog_identifier=catalogID, offering_id=offeringID, zipurl=offeringURL) print(response)
catalogID = "{catalogID}"; offeringID = "{offeringID}"; offeringURL = "{offeringURL}"; response = await service.importOfferingVersion({ 'catalogIdentifier': catalogID, 'offeringId': offeringID, 'zipurl': offeringURL }); console.log(response);
Response
Offering information
unique id
Cloudant revision
The url for this specific offering
The crn for this specific offering
Display Name in the requested language
Translated display Name, by language code
- label_i18n
The programmatic name of this offering
URL for an icon associated with this offering
URL for an additional docs with this offering
[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering
List of tags associated with this catalog
List of keywords associated with offering, typically used to search for it
Repository info for offerings
The date and time this catalog was created
The date and time this catalog was last updated
Short description in the requested language
Translated short description, by language code
- short_description_i18n
Long description in the requested language
Translated long description, by language code
- long_description_i18n
list of features associated with this offering
Array of kind
Publish information
Offering is managed by Partner Center
Offering has been approved to publish to permitted to IBM or Public Catalog
Denotes public availability of an Offering
Denotes IBM employee availability of an Offering - if share_enabled is true
Denotes sharing including access list availability of an Offering is enabled
The original offering CRN that this publish entry came from
The crn of the public catalog entry of this offering
The portal's approval record ID
The portal UI URL
The id of the catalog containing this offering
The name of the catalog
Map of metadata values for this offering
- metadata
A disclaimer for this offering
Determine if this offering should be displayed in the Consumption UI
Deprecated - Provider of this offering
Information on the provider for this offering, or omitted if no provider information is given.
Repository info for offerings
Image pull keys for this offering
Offering Support information
A list of media items related to this offering
Deprecation information for this offering.
The product kind. Valid values are module, solution, or empty string
A list of badges for this offering
A list of plans for this offering
Status Code
New version created successfully
Unauthorized
No Permissions
No Sample Response
Request
Custom Headers
Authentication token used to access the specified zip file
Path Parameters
Catalog identifier
Query Parameters
URL path to zip location. If not specified, must provide content in this post body.
Re-use the specified offeringID during import
The semver value for this new version
Add all possible configuration items when creating this version
Indicates that the current terraform template is used to install a virtual server image
The type of repository containing this version. Valid values are 'public_git' or 'enterprise_git'
Additional data to be used when importing an offering or version
Tags array.
Keywords array.
Byte array representing the content to be imported. Only supported for OVA images at this time.
Name of version. Required for virtual server image for VPC.
Display name of version. Required for virtual server image for VPC.
Install type. Example: instance. Required for virtual server image for VPC.
Deployment target of the content being onboarded. Current valid values are iks, roks, vcenter, power-iaas, terraform, and vpc-x86. Required for virtual server image for VPC.
Format of content being onboarded. Example: vsi-image. Required for virtual server image for VPC.
Optional product kind for the software being onboarded. Valid values are software, module, or solution. Default value is software.
Display value for optional product kind for the software being onboarded.
SHA256 fingerprint of the image file. Required for virtual server image for VPC.
Semantic version of the software being onboarded. Required for virtual server image for VPC.
The flavor of the current software being onboarded. Only valid if the Product kind is module or solution.
Generic data to be included with content being onboarded. Required for virtual server image for VPC.
- metadata
Operating system included in this image. Required for virtual server image for VPC.
- operating_system
Images with this operating system can only be used on dedicated hosts or dedicated host groups. Required for virtual server image for VPC.
Vendor of the operating system. Required for virtual server image for VPC.
Globally unique name for this operating system Required for virtual server image for VPC.
URL for this operating system. Required for virtual server image for VPC.
Unique, display-friendly name for the operating system. Required for virtual server image for VPC.
Software family for this operating system. Required for virtual server image for VPC.
Major release version of this operating system. Required for virtual server image for VPC.
Operating system architecture. Required for virtual server image for VPC.
Details for the stored image file. Required for virtual server image for VPC.
- file
Size of the stored image file rounded up to the next gigabyte. Required for virtual server image for VPC.
Minimum size (in gigabytes) of a volume onto which this image may be provisioned. Required for virtual server image for VPC.
Image operating system. Required for virtual server image for VPC.
- images
Programmatic ID of virtual server image. Required for virtual server image for VPC.
Programmatic name of virtual server image. Required for virtual server image for VPC.
Region the virtual server image is available in. Required for virtual server image for VPC.
Optional - The sub-folder within the specified tgz file that contains the software being onboarded
The install type of the variation. Specify extension or fullstack.
id := "{id}" offeringURL := "{offeringURL}" offeringOptions := service.NewImportOfferingOptions(id, offeringURL) _, response, _ := service.ImportOffering(offeringOptions) fmt.Println(response)
id = "{id}"; offeringURL = "{offeringURL}"; ImportOfferingOptions offeringOptions = new ImportOfferingOptions.Builder().catalogIdentifier(id).zipurl(offeringURL).build(); Response<Offering> response = service.importOffering(offeringOptions).execute(); System.out.println(response.getResult());
id = "{id}" offeringURL = "{offeringURL}" response = self.service.import_offering(catalog_identifier=id, zipurl=offeringURL) print(response)
id = "{id}"; offeringURL = "{offeringURL}"; response = await service.importOffering({ 'catalogIdentifier': id, 'zipurl': offeringURL }); console.log(response);
Response
Offering information
unique id
Cloudant revision
The url for this specific offering
The crn for this specific offering
Display Name in the requested language
Translated display Name, by language code
- label_i18n
The programmatic name of this offering
URL for an icon associated with this offering
URL for an additional docs with this offering
[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering
List of tags associated with this catalog
List of keywords associated with offering, typically used to search for it
Repository info for offerings
The date and time this catalog was created
The date and time this catalog was last updated
Short description in the requested language
Translated short description, by language code
- short_description_i18n
Long description in the requested language
Translated long description, by language code
- long_description_i18n
list of features associated with this offering
Array of kind
Publish information
Offering is managed by Partner Center
Offering has been approved to publish to permitted to IBM or Public Catalog
Denotes public availability of an Offering
Denotes IBM employee availability of an Offering - if share_enabled is true
Denotes sharing including access list availability of an Offering is enabled
The original offering CRN that this publish entry came from
The crn of the public catalog entry of this offering
The portal's approval record ID
The portal UI URL
The id of the catalog containing this offering
The name of the catalog
Map of metadata values for this offering
- metadata
A disclaimer for this offering
Determine if this offering should be displayed in the Consumption UI
Deprecated - Provider of this offering
Information on the provider for this offering, or omitted if no provider information is given.
Repository info for offerings
Image pull keys for this offering
Offering Support information
A list of media items related to this offering
Deprecation information for this offering.
The product kind. Valid values are module, solution, or empty string
A list of badges for this offering
A list of plans for this offering
Status Code
New offering created successfully
Unauthorized
No Permissions
No Sample Response
Reload offering
Reload an existing version in offering from a tgz
PUT /catalogs/{catalog_identifier}/offerings/{offering_id}/reloadRequest
Path Parameters
Catalog identifier
Offering identification
Query Parameters
The semver value for this new version
URL path to zip location. If not specified, must provide content in this post body.
The type of repository containing this version. Valid values are 'public_git' or 'enterprise_git'
Additional data to be used when importing an offering or version
Tags array
byte array representing the content to be imported. Only supported for OVA images at this time.
Target kinds. Current valid values are 'iks', 'roks', 'vcenter', 'power-iaas', and 'terraform'
Format of content being onboarded. Example: vsi-image. Required for virtual server image for VPC.
The flavor of the current software being onboarded. Only valid if the Product kind is module or solution.
Optional - The sub-folder within the specified tgz file that contains the software being onboarded
The install type of the current software being onboarded.
catalogID := "{catalogID}" offeringID := "{offeringID}" offeringURL := "{offeringURL}" offeringVersion := "{offeringVersion}" reloadOptions := service.NewReloadOfferingOptions(catalogID, offeringID, offeringURL, offeringVersion) _, response, _ := service.ReloadOffering(reloadOptions) fmt.Println(response)
String catalogID = "{catalogID}"; String offeringID = "{offeringID}"; String version = "{version}"; ReloadOfferingOptions reloadOfferingOptions = new ReloadOfferingOptions.Builder().catalogIdentifier(catalogID).offeringId(offeringID).zipurl(offeringID).targetVersion(version).build(); Response<Offering> response = service.reloadOffering(reloadOfferingOptions).execute(); System.out.println(response.getResult());
catalogID = "{catalogID}" offeringID = "{offeringID}" offeringURL = "{offeringURL}" version = "{version}" response = self.service.reload_offering(catalog_identifier=catalogID, offering_id=offeringID, zipurl=offeringURL, target_version=version) print(response)
catalogID = "{catalogID}"; offeringID = "{offeringID}"; offeringURL = "{offeringURL}"; version = "{version}"; response = await service.reloadOffering({'catalogIdentifier': catalogID, 'offeringId': offeringID, 'zipurl': offeringURL, 'targetVersion': version}); console.log(response);
Response
Offering information
unique id
Cloudant revision
The url for this specific offering
The crn for this specific offering
Display Name in the requested language
Translated display Name, by language code
- label_i18n
The programmatic name of this offering
URL for an icon associated with this offering
URL for an additional docs with this offering
[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering
List of tags associated with this catalog
List of keywords associated with offering, typically used to search for it
Repository info for offerings
The date and time this catalog was created
The date and time this catalog was last updated
Short description in the requested language
Translated short description, by language code
- short_description_i18n
Long description in the requested language
Translated long description, by language code
- long_description_i18n
list of features associated with this offering
Array of kind
Publish information
Offering is managed by Partner Center
Offering has been approved to publish to permitted to IBM or Public Catalog
Denotes public availability of an Offering
Denotes IBM employee availability of an Offering - if share_enabled is true
Denotes sharing including access list availability of an Offering is enabled
The original offering CRN that this publish entry came from
The crn of the public catalog entry of this offering
The portal's approval record ID
The portal UI URL
The id of the catalog containing this offering
The name of the catalog
Map of metadata values for this offering
- metadata
A disclaimer for this offering
Determine if this offering should be displayed in the Consumption UI
Deprecated - Provider of this offering
Information on the provider for this offering, or omitted if no provider information is given.
Repository info for offerings
Image pull keys for this offering
Offering Support information
A list of media items related to this offering
Deprecation information for this offering.
The product kind. Valid values are module, solution, or empty string
A list of badges for this offering
A list of plans for this offering
Status Code
New version created successfully
Unauthorized
No Permissions
No Sample Response
Get offering
Get an offering. This can be used by an unauthenticated user for publicly available offerings.
GET /catalogs/{catalog_identifier}/offerings/{offering_id}Request
Path Parameters
Catalog identifier
Offering identification
Query Parameters
Offering Parameter Type. Valid values are 'name' or 'id'. Default is 'id'.
Return the digest format of the specified offering. Default is false.
catalogID := "{catalogID}" offeringID := "{offeringID}" getOptions := service.NewGetOfferingOptions(catalogID, offeringID) _, response, _ := service.GetOffering(getOptions) fmt.Println(response)
String catalogID = "{catalogID}"; String offeringID = "{offeringID}"; GetOfferingOptions getOptions = new GetOfferingOptions.Builder().catalogIdentifier(catalogID).offeringId(offeringID).build(); Response<Offering> response = service.getOffering(getOptions).execute(); System.out.println(response.getResult());
catalogID = "{catalogID}" offeringID = "{offeringID}" response = self.service.get_offering(catalog_identifier=catalogID, offering_id=offeringID) print(response)
catalogID = "{catalogID}"; offeringID = "{offeringID}"; response = await service.getOffering({ 'catalogIdentifier': catalogID, 'offeringId': offeringID }); console.print(response);
Response
Offering information
unique id
Cloudant revision
The url for this specific offering
The crn for this specific offering
Display Name in the requested language
Translated display Name, by language code
- label_i18n
The programmatic name of this offering
URL for an icon associated with this offering
URL for an additional docs with this offering
[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering
List of tags associated with this catalog
List of keywords associated with offering, typically used to search for it
Repository info for offerings
The date and time this catalog was created
The date and time this catalog was last updated
Short description in the requested language
Translated short description, by language code
- short_description_i18n
Long description in the requested language
Translated long description, by language code
- long_description_i18n
list of features associated with this offering
Array of kind
Publish information
Offering is managed by Partner Center
Offering has been approved to publish to permitted to IBM or Public Catalog
Denotes public availability of an Offering
Denotes IBM employee availability of an Offering - if share_enabled is true
Denotes sharing including access list availability of an Offering is enabled
The original offering CRN that this publish entry came from
The crn of the public catalog entry of this offering
The portal's approval record ID
The portal UI URL
The id of the catalog containing this offering
The name of the catalog
Map of metadata values for this offering
- metadata
A disclaimer for this offering
Determine if this offering should be displayed in the Consumption UI
Deprecated - Provider of this offering
Information on the provider for this offering, or omitted if no provider information is given.
Repository info for offerings
Image pull keys for this offering
Offering Support information
A list of media items related to this offering
Deprecation information for this offering.
The product kind. Valid values are module, solution, or empty string
A list of badges for this offering
A list of plans for this offering
Status Code
Successful Result
Unauthorized
No Permissions
No such catalog/offering
No Sample Response
Request
Path Parameters
Catalog identifier
Offering identification
Offering information
unique id
Cloudant revision
The url for this specific offering
The crn for this specific offering
Display Name in the requested language
Translated display Name, by language code
- label_i18n
The programmatic name of this offering
URL for an icon associated with this offering
URL for an additional docs with this offering
[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering
List of tags associated with this catalog
List of keywords associated with offering, typically used to search for it
Repository info for offerings
The date and time this catalog was created
The date and time this catalog was last updated
Short description in the requested language
Translated short description, by language code
- short_description_i18n
Long description in the requested language
Translated long description, by language code
- long_description_i18n
list of features associated with this offering
Array of kind
Publish information
Offering is managed by Partner Center
Offering has been approved to publish to permitted to IBM or Public Catalog
Denotes public availability of an Offering
Denotes IBM employee availability of an Offering - if share_enabled is true
Denotes sharing including access list availability of an Offering is enabled
The original offering CRN that this publish entry came from
The crn of the public catalog entry of this offering
The portal's approval record ID
The portal UI URL
The id of the catalog containing this offering
The name of the catalog
Map of metadata values for this offering
- metadata
A disclaimer for this offering
Determine if this offering should be displayed in the Consumption UI
Deprecated - Provider of this offering
Information on the provider for this offering, or omitted if no provider information is given.
Repository info for offerings
Image pull keys for this offering
Offering Support information
A list of media items related to this offering
Deprecation information for this offering.
The product kind. Valid values are module, solution, or empty string
A list of badges for this offering
A list of plans for this offering
catalogID := "{catalogID}" offeringID := "{offeringID}" label := "{label}" shortDesc := "{shortDesc}" revision := "{revision}" updateOptions := service.NewReplaceOfferingOptions(catalogID, offeringID) updateOptions.SetID(offeringID) updateOptions.SetLabel(label) updateOptions.SetShortDescription(shortDesc) updateOptions.SetRev(revision) _, response, _ := service.ReplaceOffering(updateOptions) fmt.Println(response)
String catalogID = "{catalogID}"; String offeringID = "{offeringID}"; String label = "{label}"; String shortDesc = "{shortDesc}"; ReplaceOfferingOptions replaceOptions = new ReplaceOfferingOptions.Builder().catalogIdentifier(catalogID).id(offeringID).offeringId(offeringID).label(label).shortDescription(shortDesc).rev(revision.rev()).build(); Response<Catalog> response = service.replaceOffering(replaceOptions).execute(); System.out.println(response.getResult());
catalogID = "{catalogID}" offeringID = "{offeringID}" revision = "{revision}" shortDesc = "{shortDesc}" response = self.service.replace_offering(catalog_identifier=catalogID, offering_id=offeringID, id=offeringID, rev=revision, label=label, short_description=shortDesc) print(response)
catalogID = "{catalogID}"; offeringID = "{offeringID}"; revision = "{revision}"; label = "{label}"; shortDesc = "{shortDesc}"; response = await service.replaceOffering({'catalogIdentifier': catalogID, 'offeringId': offeringID, 'id': offeringID, 'rev': revision, 'label': label, 'shortDescription': shortDesc}); console.log(response);
Response
Offering information
unique id
Cloudant revision
The url for this specific offering
The crn for this specific offering
Display Name in the requested language
Translated display Name, by language code
- label_i18n
The programmatic name of this offering
URL for an icon associated with this offering
URL for an additional docs with this offering
[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering
List of tags associated with this catalog
List of keywords associated with offering, typically used to search for it
Repository info for offerings
The date and time this catalog was created
The date and time this catalog was last updated
Short description in the requested language
Translated short description, by language code
- short_description_i18n
Long description in the requested language
Translated long description, by language code
- long_description_i18n
list of features associated with this offering
Array of kind
Publish information
Offering is managed by Partner Center
Offering has been approved to publish to permitted to IBM or Public Catalog
Denotes public availability of an Offering
Denotes IBM employee availability of an Offering - if share_enabled is true
Denotes sharing including access list availability of an Offering is enabled
The original offering CRN that this publish entry came from
The crn of the public catalog entry of this offering
The portal's approval record ID
The portal UI URL
The id of the catalog containing this offering
The name of the catalog
Map of metadata values for this offering
- metadata
A disclaimer for this offering
Determine if this offering should be displayed in the Consumption UI
Deprecated - Provider of this offering
Information on the provider for this offering, or omitted if no provider information is given.
Repository info for offerings
Image pull keys for this offering
Offering Support information
A list of media items related to this offering
Deprecation information for this offering.
The product kind. Valid values are module, solution, or empty string
A list of badges for this offering
A list of plans for this offering
Status Code
Offering was updated successfully
Unauthorized
No Permissions
No such catalog/offering
No Sample Response
Update offering
Update an offering using a JSONPatch document as defined by RFC 6902.
PATCH /catalogs/{catalog_identifier}/offerings/{offering_id}Request
Custom Headers
Offering etag contained in quotes.
Path Parameters
Catalog identifier
Offering identification
A JSONPatch document as defined by RFC 6902.
The operation to be performed.
Allowable values: [
add,remove,replace,move,copy,test]A JSON-Pointer.
The value to be used within the operations.
A string containing a JSON Pointer value
Response
Offering information
unique id
Cloudant revision
The url for this specific offering
The crn for this specific offering
Display Name in the requested language
Translated display Name, by language code
- label_i18n
The programmatic name of this offering
URL for an icon associated with this offering
URL for an additional docs with this offering
[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering
List of tags associated with this catalog
List of keywords associated with offering, typically used to search for it
Repository info for offerings
The date and time this catalog was created
The date and time this catalog was last updated
Short description in the requested language
Translated short description, by language code
- short_description_i18n
Long description in the requested language
Translated long description, by language code
- long_description_i18n
list of features associated with this offering
Array of kind
Publish information
Offering is managed by Partner Center
Offering has been approved to publish to permitted to IBM or Public Catalog
Denotes public availability of an Offering
Denotes IBM employee availability of an Offering - if share_enabled is true
Denotes sharing including access list availability of an Offering is enabled
The original offering CRN that this publish entry came from
The crn of the public catalog entry of this offering
The portal's approval record ID
The portal UI URL
The id of the catalog containing this offering
The name of the catalog
Map of metadata values for this offering
- metadata
A disclaimer for this offering
Determine if this offering should be displayed in the Consumption UI
Deprecated - Provider of this offering
Information on the provider for this offering, or omitted if no provider information is given.
Repository info for offerings
Image pull keys for this offering
Offering Support information
A list of media items related to this offering
Deprecation information for this offering.
The product kind. Valid values are module, solution, or empty string
A list of badges for this offering
A list of plans for this offering
Status Code
Offering was updated successfully
Unauthorized
No Permissions
No such catalog/offering
No Sample Response
Request
Custom Headers
IAM token of partner center. Only needed when Partner Center accessing the private catalog offering. When accessing the public offering Partner Center only needs to use their token in the authorization header.
IAM token (
Bearer <token>) for authorization. For private offerings must be token for offering owner to approve access by Partner Center. Partner Center would put its token inX-Approver-Token. For access to public offering Partner Center or authorized approvers would use their token here.
Path Parameters
Catalog identifier
Offering identification
catalogID := "{catalogID}" offeringID := "{offeringID}" deleteOptions := service.NewDeleteOfferingOptions(catalogID, offeringID) response, _ := service.DeleteOffering(deleteOptions) fmt.Println(response)
String catalogID = "{catalogID}"; String offeringID = "{offeringID}"; DeleteOfferingOptions deleteOfferingOptions = new DeleteOfferingOptions.Builder().catalogIdentifier(catalogID).offeringId(offeringID).build(); Response<Void> response = service.deleteOffering(deleteOfferingOptions).execute(); System.out.println(response.getResult());
catalogID = "{catalogID}" offeringID = "{offeringID}" response = self.service.delete_offering(catalog_identifier=catalogID, offering_id=offeringID) print(response)
catalogID = "{catalogID}"; offeringID = "{offeringID}"; response = await service.deleteOffering({ 'catalogIdentifier': catalogID, 'offeringId': offeringID }); console.log(response);
Get offering statistics
Get the usage statistics for the specified offering.
GET /catalogs/{catalog_identifier}/offerings/{offering_id}/statsResponse
Accumulated statistics for the specified target. Statistics are accumulated on a weekly basis for at most a year.
What these statistics are for (i.e. Offering, Object, Plan, etc)
Target ID
Statistics array. Sorted on YearWeekIdx. This array may have at most 52 entries, but may contain fewer if there are no statistics in a particular week
Total statistics for the specified target
Status Code
Successful response. Your permissions determine what you can see
Unauthorized
No Permissions
No Sample Response
Get offering audit logs
Get the audit logs associated with an offering.
GET /catalogs/{catalog_identifier}/offerings/{offering_id}/auditsRequest
Path Parameters
Catalog identifier
Offering identification
Query Parameters
Start token for a query
number or results to return in the query
Possible values: value ≤ 1000
Default:
100Auditlog Lookup Names - by default names are not returned in auditlog.
Response
A collection of audit records
The limit that was applied to this response. It may be smaller than in the request because that was too large
The number of resources returned in this response
Link response on a token paginated query
A list of audit records
The start token used for this response
The total count of resources in the system that matches the request
Link response on a token paginated query
Link response on a token paginated query
Link response on a token paginated query
Status Code
Successful response. Your permissions determine what you can see
Unauthorized
No Permissions
No Sample Response
Get an offering audit log entry
Get the full audit log entry associated with an offering.
GET /catalogs/{catalog_identifier}/offerings/{offering_id}/audits/{auditlog_identifier}Request
Path Parameters
Catalog identifier
Offering identification
Auditlog ID
Query Parameters
Auditlog Lookup Names - by default names are not returned in auditlog.
Response
An audit log which describes a change made to a catalog or associated resource.
The identifier of the audit record.
Cloudant revision
The time at which the change was made.
The type of change described by the audit record.
The resource type associated with the change.
The identifier of the resource that was changed.
The email address of the user that made the change.
The email address of the delegate user that made the change. This happens when a service makes a change onbehalf of the user
A message which describes the change.
Transaction id for this change
IAM identifier of the user who made the change
Name of the user who made the change
IAM identifier of the delegate user who made the change
Name of the delegate user who made the change
Data about the change. Usually a change log of what was changed, both before and after. Can be of any type.
Status Code
Successful response. Your permissions determine what you can see
Unauthorized
No Permissions
No Sample Response
Set offering publish approval settings
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.
POST /catalogs/{catalog_identifier}/offerings/{offering_id}/publish/{approval_type}/{approved}Request
Custom Headers
IAM token of partner center. Only needed when Partner Center accessing the private catalog offering. When accessing the public offering Partner Center only needs to use their token in the authorization header.
Authentication token used to verify if user is a collaborator of a repository as part of the checks to set the approval type as
ibm_module_repooribm_communityIAM token (
Bearer <token>) for authorization. For private offerings must be token for offering owner to approve access by Partner Center. Partner Center would put its token inX-Approver-Token. For access to public offering Partner Center or authorized approvers would use their token here.
Path Parameters
Catalog identifier
Offering identification
Type of approval.
pc_managed- Partner Center is managing this offeringibm_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 catalogapproval_required- Offering will be removed from public catalog when this flag is set to true, regardless of the approval and visibility settings.
Allowable values: [
pc_managed,publish_approved,ibm_module_repo,ibm_community,approval_required]Approve (true) or disapprove (false)
Allowable values: [
true,false]
Query Parameters
Partner Center identifier for this offering
Partner Center url for this offering
catalogID := "{catalogID}" offeringID := "{offeringID}" approvalType := "{approvalType}" approved := "{approved}" updateOptions := service.NewUpdateOfferingIbmOptions(catalogID, offeringID, approvalType, approved) _, response, _ := service.UpdateOfferingIbm(updateOptions) fmt.Println(response)
String catalogID = "{catalogID}"; String offeringID = "{offeringID}"; String approvalType = "{approvalType}"; String approved = "{approved}"; UpdateOfferingIbmOptions updateOptions = new UpdateOfferingIbmOptions.Builder().catalogIdentifier(catalogID).offeringId(offeringID).approvalType(approvalType).approved(approved).build(); Response<ApprovalResult> response = service.updateOfferingIbm(updateOptions).execute(); System.out.println(response.getResult());
catalogID = "{catalogID}"; offeringID = "{offeringID}"; approvalType = "{approvalType}"; approved = "{approved}"; response = await service.updateOfferingIbm({ 'catalogIdentifier': catalogID, 'offeringId': offeringID, 'approvalType': approvalType, 'approved': approved }); console.log(response);
catalogID = "{catalogID}" offeringID = "{offeringID}" approvalType = "{approvalType}" approved = "{approved}" response = self.service.update_offering_ibm(catalog_identifier=catalogID, offering_id=offeringID, approval_type=approvalType, approved=approved) print(response)
Response
Result of approval
Shared - object is shared using access list - not set when using PC Managed objects
Shared with IBM only - access list is also applicable - not set when using PC Managed objects
Shared with everyone - not set when using PC Managed objects
Published to Partner Center (pc_managed) or for objects, allowed to request publishing
Approvers have approved publishing to public catalog
Partner Center document ID
Partner Center URL for this product
Denotes whether approvals have changed
Status Code
Successful Result
Unauthorized
No Permissions
No such catalog/offering
No Sample Response
Allows offering to be deprecated
Approve or disapprove the offering to be deprecated.
POST /catalogs/{catalog_identifier}/offerings/{offering_id}/deprecate/{setting}Request
Path Parameters
Catalog identifier
Offering identification
Set deprecation (true) or cancel deprecation (false)
Allowable values: [
true,false]
Information for deprecation request
Additional information that users can provide to be displayed in deprecation notification
Specifies the amount of days until product is not available in catalog
Allows offering to be shared
Set the share options on an offering.
POST /catalogs/{catalog_identifier}/offerings/{offering_id}/shareCheck for account ID in offering access list
Determine if an account ID is in an offering's access list
GET /catalogs/{catalog_identifier}/offerings/{offering_id}/access/{access_identifier}Request
Path Parameters
Catalog identifier
Offering identification
Identifier for access. Use 'accountId' or '-acct-accountId' for an account, '-ent-enterpriseid' for an enterprise, and '-entgrp-enterprisegroupid' for an enterprise group.
Response
access
unique id
account id
Normal account or enterprise
unique id
object ID
object's owner's account
entity type
date and time create
Approval state for access. If this field is an empty string, then it means that it's approved
List of additional version states that this account can see. The default visible states are consumable and prerelease.
Status Code
Successful response
Bad request
Unauthorized
No Permissions
The specified account ID was not found in the offering's access list.
No Sample Response
Update the access list entry for a specific account
Update an access list entry for a specific account
PUT /catalogs/{catalog_identifier}/offerings/{offering_id}/access/{access_identifier}Request
Path Parameters
Catalog identifier
Offering identification
Identifier for access. Use 'accountId' or '-acct-accountId' for an account, '-ent-enterpriseid' for an enterprise, and '-entgrp-enterprisegroupid' for an enterprise group.
access
unique id
account id
Normal account or enterprise
unique id
object ID
object's owner's account
entity type
date and time create
Approval state for access. If this field is an empty string, then it means that it's approved
List of additional version states that this account can see. The default visible states are consumable and prerelease.
Response
access
unique id
account id
Normal account or enterprise
unique id
object ID
object's owner's account
entity type
date and time create
Approval state for access. If this field is an empty string, then it means that it's approved
List of additional version states that this account can see. The default visible states are consumable and prerelease.
Status Code
Access list entry was updated successsfully
Unauthorized
No Permissions
No such catalog/offering/access list entry
No Sample Response
Get offering access list
Get the access list associated with the specified offering
GET /catalogs/{catalog_identifier}/offerings/{offering_id}/accessRequest
Path Parameters
Catalog identifier
Offering identification
Query Parameters
Start token for a query
number or results to return in the query
Possible values: value ≤ 1000
Default:
100
Response
Paginated Offering search result
The limit that was applied to this response. It may be smaller than in the request because that was too large
The number of resources returned in this response
Link response on a token paginated query
A list of access records
The start token used for this response
The total count of resources in the system that matches the request
Link response on a token paginated query
Link response on a token paginated query
Link response on a token paginated query
Status Code
Successful response
Bad request
Unauthorized
No Permissions
No Sample Response
Delete accesses from offering access list
Delete all or a set of accesses from an offering's access list.
DELETE /catalogs/{catalog_identifier}/offerings/{offering_id}/accessAdd accesses to offering access list
Add one or more accesses to the specified offering's access list.
POST /catalogs/{catalog_identifier}/offerings/{offering_id}/accessResponse
Paginated Offering search result
The limit that was applied to this response. It may be smaller than in the request because that was too large
The number of resources returned in this response
Link response on a token paginated query
A list of access records
The start token used for this response
The total count of resources in the system that matches the request
Link response on a token paginated query
Link response on a token paginated query
Link response on a token paginated query
Status Code
Successful response, still need to look for errors for specific accesses
Bad request
Unauthorized
No Permissions
No Sample Response
Get version updates
Get available updates for the specified version
GET /catalogs/{catalog_identifier}/offerings/{offering_id}/updatesRequest
Custom Headers
IAM Refresh token
Path Parameters
Catalog identifier
Offering identification
Query Parameters
The kind of offering (e.g, helm, ova, terraform ...)
The target kind of the currently installed version (e.g. iks, roks, etc)
optionaly provide an existing version to check updates for if one is not given, all version will be returned.
The id of the cluster where this version was installed
The region of the cluster where this version was installed
The resource group id of the cluster where this version was installed
The namespace of the cluster where this version was installed
The sha value of the currently installed version
Optionally provide the channel value of the currently installed version
Optionally provide a list of namespaces used for the currently installed version
Optionally indicate that the current version was installed in all namespaces
The programmatic flavor name of the version that was installed
The install type of the version that was installed
versionLocator := "{versionLocator}" getOptions := service.NewGetVersionUpdatesOptions(versionLocator) _, response, _ := service.GetVersionUpdates(getOptions) fmt.Println(response)
String versionLocator = "{versionLocator}"; GetVersionUpdatesOptions getOptions = new GetVersionUpdatesOptions.Builder().versionLocId(versionLocator).build(); Response<List<VersionUpdateDescriptor>> response = service.getVersionUpdates(getOptions).execute(); System.out.println(response.getResult());
versionLocator = "{versionLocator}" response = self.service.get_offering_updates(version_loc_id=versionLocator) print(response)
versionLocator = "{versionLocator}"; response = await service.getVersionUpdates({ 'versionLocId': versionLocator}); console.log(response);
Response
Indicates if the current version can be upgraded to the version identified by the descriptor
A dotted value of
catalogID.versionIDthe version number of this version
Optional flavor information for this version. Only supported for Product kind Solution.
Offering state
Resource requirments for installation
Version of package
The SHA value of this version
true if the current version can be upgraded to this version, false otherwise
If can_update is false, this map will contain messages for each failed check, otherwise it will be omitted. Possible keys include nodes, cores, mem, disk, targetVersion, and install-permission-check
- messages
Status Code
Version Descriptors, sorted newest first
Bad request
Unauthorized
No Permissions
No Sample Response
Get version change notices
Get change notices for the specified version
GET /catalogs/{catalog_identifier}/offerings/{offering_id}/changeNoticesRequest
Path Parameters
Catalog identifier
Offering identification
Query Parameters
The kind of offering (e.g, helm, ova, terraform ...)
The target kind of the currently installed version (e.g. iks, roks, etc)
optionaly provide an existing version to check updates for if one is not given, all version will be returned.
The programmatic flavor name of the version that was installed
optionaly specify if change notices should be returned for all versions of this kind and flavor, or for all versions that are newer than the specified version, including the specified version
Allowable values: [
latest,all]
Response
Change notices response
Set to true if any of the included change notices contain a breaking change
Set to true if any of the included change notices contain a new change
Set to true if any of the included change notices contain an update
All changes notices for the requested versions
- change_notices
A dotted value of
catalogID.versionIDthe version number of this version
Optional flavor information for this version. Only supported for Product kind Solution.
Breaking changes for this version
New changes for this version
Updates for this version
Status Code
Change notices, sorted newest first
Bad request
Unauthorized
No Permissions
No Sample Response
Get offering source
Get an offering's source. This request requires authorization for private offerings.
GET /offering/source
Request
Custom Headers
Allowable values: [
application/yaml,application/json,application/x-gzip]
Query Parameters
The version being requested
Catalog ID. If not specified, this value will default to the public catalog.
Offering name. An offering name or ID must be specified.
Offering id. An offering name or ID must be specified.
The kind of offering (e.g. helm, ova, terraform...)
The channel value of the specified version
The programmatic flavor name of the specified version
If false (the default), the root folder from the original onboarded tgz file is removed. If true, the root folder is returned.
The install type of the specified version.
Get offering source
Get an offering's source. This request requires authorization for private offerings. Note that the URL can include an additional 'working directory' value (i.e. /offering/source/archive//solutions/standard), which allows this single URL to be used in a Terraform module statement as well.
GET /offering/source/archive
Request
Custom Headers
Allowable values: [
application/yaml,application/json,application/x-gzip]
Query Parameters
The version being requested
Catalog ID. If not specified, this value will default to the public catalog.
Offering name. An offering name or ID must be specified.
Offering id. An offering name or ID must be specified.
The kind of offering (e.g. helm, ova, terraform...)
The channel value of the specified version
The programmatic flavor name of the specified version
If false (the default), the root folder from the original onboarded tgz file is removed. If true, the root folder is returned.
The install type of the specified version.
Get offering source URL
Get an offering's private source image.
GET /offering/source/url/{key_identifier}Request
Custom Headers
Allowable values: [
application/yaml,application/json,application/x-gzip]
Path Parameters
Unique key identifying an image
Query Parameters
Catalog ID. If not specified, this value will default to the public catalog.
Offering name. An offering name or ID must be specified.
Offering id. An offering name or ID must be specified.
Get offering audit log
Get the audit log associated with an offering.
GET /catalogs/{catalog_identifier}/offerings/{offering_id}/auditRequest
Path Parameters
Catalog identifier
Offering identification
Query Parameters
Log identification.
Response
A collection of audit records
The bookmark of the first resource in this page of search results. Omit for first entry.
The maximum number of resources returned in each page of search results.
The number of resources returned in this page of search results.
A URL for retrieving the first page of search results.
A URL for retrieving the last page of search results.
A URL for retrieving the previous page of search results.
A URL for retrieving the next page of search results.
A list of audit records
Status Code
Successful response. Your permissions determine what you can see
Unauthorized
No Permissions
No Sample Response
Get versions
Get the versions of the specified kind in the specified offering. This can be used by an unauthenticated user for publicly available offerings.
GET /catalogs/{catalog_identifier}/offerings/{offering_id}/kinds/{kind_id}/versionsRequest
Path Parameters
Catalog identifier
Offering identification
Kind identification
Query Parameters
Return the digest format of the specified offering. Default is false.
Return consumable versions. Default is false.
Start token for a query
number or results to return in the query
Possible values: value ≤ 150
Default:
150
Response
Paginated search result for Versions
The limit that was applied to this response. It may be smaller than in the request because that was too large
The number of resources returned in this response
Link response on a token paginated query
A list of versions
The start token used for this response
The total count of resources in the system that matches the request
Link response on a token paginated query
Link response on a token paginated query
Link response on a token paginated query
Status Code
Successful Result
Unauthorized
No Permissions
No such catalog/offering
No Sample Response
Get version about information
Get the about information, in markdown, for the current version
GET /versions/{version_loc_id}/aboutRequest
Path Parameters
A dotted value of
catalogID.versionID
versionLocator := "{versionLocator}" getOptions := service.NewGetVersionAboutOptions(versionLocator) _, response, _ := service.GetVersionAbout(getOptions) fmt.Println(response)
String versionLocator = "{versionLocator}"; GetVersionAboutOptions getOptions = new GetVersionAboutOptions.Builder().versionLocId(versionLocator).build(); Response<String> response = service.getVersionAbout(getOptions).execute(); System.out.println(response.getResult());
versionLocator = "{versionLocator}" response = self.service.get_offering_about(version_loc_id=versionLocator) print(response)
versionLocator = "{versionLocator}"; response = await service.getVersionAbout({ 'versionLocId': versionLocator }); console.log(response);
Get version license content
Get the license content for the specified license ID in the specified version
GET /versions/{version_loc_id}/licenses/{license_id}Request
Path Parameters
A dotted value of
catalogID.versionIDThe ID of the license, which maps to the file name in the 'licenses' directory of this verions tgz file
versionLocator := "{versionLocator}" id := "{id}" getOptions := service.NewGetVersionLicenseOptions(versionLocator, id) response, _ := service.GetVersionLicense(getOptions) fmt.Println(response)
String versionLocator = "{versionLocator}"; GetVersionLicenseOptions getOption = new GetVersionLicenseOptions.Builder().versionLocId(versionLocator).build(); Response<Void> response = service.getVersionLicense(getOption).execute(); System.out.println(response.getResult());
versionLocator = "{versionLocator}"; id = "{id}"; response = await service.getVersionLicense({ 'versionLocId': versionLocator, 'licenseId': id }); console.log(response);
versionLocator = "{versionLocator}" id = "{id}" response = self.service.get_offering_license(version_loc_id=versionLocator, license_id=id) print(response)
Get version's container images
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
GET /versions/{version_loc_id}/containerImagesRequest
Path Parameters
A dotted value of
catalogID.versionID
versionLocator := "{versionLocator}" getOptions := service.NewGetVersionContainerImagesOptions(versionLocator) _, response, _ := service.GetVersionContainerImages(getOptions) fmt.Println(response)
String versionLocator = "{versionLocator}"; GetVersionContainerImagesOptions getOption = new GetVersionContainerImagesOptions.Builder().versionLocId(versionLocator).build(); Response<ImageManifest> response = service.getVersionContainerImages(getOption).execute(); System.out.println(response.getResult());
versionLocator = "{versionLocator}"; response = await service.getVersionContainerImages({ 'versionLocId': versionLocator}); console.log(response);
versionLocator = "{versionLocator}" response = self.service.get_offering_container_images(version_loc_id=versionLocator) print(response)
Request
Path Parameters
A dotted value of
catalogID.versionID
versionLocator := "{versionLocator}" arcOptions := service.NewArchiveVersionOptions(versionLocator) response, _ := service.ArchiveVersion(arcOptions) fmt.Println(response)
String versionLocator = "{versionLocator}"; ArchiveVersionOptions arcOptions = new ArchiveVersionOptions.Builder().versionLocId(versionLocator).build(); Response<Void> response = service.archiveVersion(arcOptions).execute(); System.out.println(response.getResult());
versionLocator = "{versionLocator}"; response = await service.archiveVersion({ 'versionLocId': versionLocator}); console.log(response);
versionLocator = "{versionLocator}" response = self.service.archive_version(version_loc_id=versionLocator) print(response)
Sets version to be deprecated in a certain time period
Set or cancel the version to be deprecated.
POST /versions/{version_loc_id}/deprecate/{setting}Request
Path Parameters
A dotted value of
catalogID.versionIDSet deprecation (true) or cancel deprecation (false)
Allowable values: [
true,false]
Information for deprecation request
Additional information that users can provide to be displayed in deprecation notification
Specifies the amount of days until product is not available in catalog
Request
Path Parameters
A dotted value of
catalogID.versionID
versionLocator := "{versionLocator}" commitOptions := service.NewCommitVersionOptions(versionLocator) response, _ := service.commitOptions(publishOptions) fmt.Println(response)
String versionLocator = "{versionLocator}"; CommitVersionOptions commitOptions = new CommitVersionOptions.Builder().versionLocId(versionLocator).build(); Response<Void> response = service.commitVersion(commitOptions).execute(); System.out.println(response.getResult());
versionLocator = "{versionLocator}"; response = await service.commitVersion({ 'versionLocId': versionLocator}); console.log(response);
versionLocator = "{versionLocator}" response = self.service.commit_version(version_loc_id=versionLocator) print(response)
Copy version to new target kind
Copy the specified version to a new target kind within the same offering
POST /versions/{version_loc_id}/copyRequest
Path Parameters
A dotted value of
catalogID.versionID
Additional data to be used when importing an offering or version
Tags array
byte array representing the content to be imported. Only supported for OVA images at this time.
Target kinds. Current valid values are 'iks', 'roks', 'vcenter', 'power-iaas', and 'terraform'
Format of content being onboarded. Example: vsi-image. Required for virtual server image for VPC.
The flavor of the current software being onboarded. Only valid if the Product kind is module or solution.
Optional - The sub-folder within the specified tgz file that contains the software being onboarded
The install type of the current software being onboarded.
Create working copy of version
Create a working copy of the specified version
POST /versions/{version_loc_id}/workingcopyRequest
Path Parameters
A dotted value of
catalogID.versionID
versionLocator := "{versionLocator}" getOptions := service.NewGetVersionWorkingCopyOptions(versionLocator) _, response, _ := service.GetVersionWorkingCopy(getOptions) fmt.Println(response)
String versionLocator = "{versionLocator}"; GetVersionWorkingCopyOptions getVersion = new GetVersionWorkingCopyOptions.Builder().versionLocId(versionLocator).build(); Response<Void> response = service.getVersionWorkingCopy(getVersion).execute(); System.out.println(response.getResult());
versionLocator = "{versionLocator}"; response = await service.getVersionWorkingCopy({ 'versionLocId': versionLocator}); console.log(response);
versionLocator = "{versionLocator}" response = self.service.get_offering_working_copy(version_loc_id=versionLocator) print(response)
Response
Offering version information
Unique ID
Cloudant revision
Version's CRN
Version of content type
Optional flavor information for this version. Only supported for Product kind Solution.
hash of the content
The date and time this version was created
The date and time this version was last updated
Offering ID
Catalog ID
Kind ID
List of tags associated with this catalog
Content's repo URL
Content's source URL (e.g git repo)
File used to on-board this version
List of user solicited overrides
List of output values for this version
List of IAM permissions that are required to consume this version
Open ended metadata information
- metadata
Validation response
Resource requirments for installation
Denotes if single instance can be deployed to a given cluster
Environment values to be passed to Schematics Workspace on creation
Script information
Optional pre-install instructions
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.
- scripts
A script to be run as part of a Project configuration, during the specified stage and action
Entitlement license info
- entitlement
Provider name
Provider ID
Product ID
list of license entitlement part numbers, eg. D1YGZLL,D1ZXILL
Image repository name
List of licenses the product was built with
If set, denotes a url to a YAML file with list of container images used by this version
read only field, indicating if this version is deprecated
Version of the package used to create this version
Offering state
A dotted value of
catalogID.versionIDLong description for version
Translated long description for version, by language code
- long_description_i18n
Whitelisted accounts for version
ID of the image pull key to use from Offering.ImagePullKeys
Deprecation information for this version
Solution information for version. Only supported for Product kind Solution.
Is the version able to be shared
Compliance info for a version
Change notices for a version
A list of plan ids that are applicable for this version
Optional. Stack definition that was used to create this version
- stack
The lowest version (semver) that can upgrade to this version
Status Code
Working copy created successfully
Bad request
Unauthorized
No Permissions
Working Copy already exists
No Sample Response
Copy values from a previous version
Copy values from a specified previous version
POST /versions/{version_loc_id}/copy/{type}/{version_loc_id_to_copy_from}Request
Path Parameters
A dotted value of
catalogID.versionIDThe type of data you would like to copy from a previous version. Valid values are 'configuration' or 'licenses'.
The version locator id of the version you wish to copy data from.
versionLocator := "{versionLocator}" type := "{type}" versionLocatorToCopyFrom := "{versionLocatorToCopyFrom}" copyOptions := service.NewCopyOptions(versionLocator, type, versionLocatorToCopyFrom) _, response, _ := service.Copy(copyOptions) fmt.Println(response)
String versionLocator = "{versionLocator}"; String type = "{type}"; String versionLocatorToCopyFrom = "{versionLocatorToCopyFrom}"; GetCopyOptions copyOptions = new GetCopyOptions.Builder().versionLocId(versionLocator).type(type).versionLocIdToCopyFrom(versionLocatorToCopyFrom).build(); Response<Void> response = service.copy(copyOptions).execute(); System.out.println(response.getResult());
versionLocator = "{versionLocator}"; type = "{type}"; versionLocatorToCopyFrom = "{versionLocatorToCopyFrom}"; response = await service.copy({ 'versionLocId': versionLocator, 'type': type, 'versionLocatorToCopyFrom': versionLocatorToCopyFrom }); console.log(response);
versionLocator = "{versionLocator}" type = "{type}" versionLocatorToCopyFrom = "{versionLocatorToCopyFrom}" response = self.service.copy(version_loc_id=versionLocator, type=type, version_loc_id_to_copy_from=versionLocatorToCopyFrom) print(response)
Validates deployment input variables
Validates deployment input variables
POST /versions/{version_loc_id}/validateInputsGet offering/kind/version 'branch'
Get the Offering/Kind/Version 'branch' for the specified locator ID
GET /versions/{version_loc_id}Request
Path Parameters
A dotted value of
catalogID.versionID
versionLocator := "{versionLocator}" versionOptions := service.NewGetVersionOptions(versionLocator) _, response, _ := service.GetVersion(versionOptions) fmt.Println(response)
String versionLocator = "{versionLocator}"; GetVersionOptions getOptions = new GetVersionOptions.Builder().versionLocId(versionLocator).build(); Response<Offering> response = service.getVersion(getOptions).execute(); System.out.println(response.getResult());
versionLocator = "{versionLocator}" response = self.service.get_version(version_loc_id=versionLocator) print(response)
versionLocator = "{versionLocator}"; response = await service.getVersion({ 'versionLocId': versionLocator }); console.log(response);
Response
Offering information
unique id
Cloudant revision
The url for this specific offering
The crn for this specific offering
Display Name in the requested language
Translated display Name, by language code
- label_i18n
The programmatic name of this offering
URL for an icon associated with this offering
URL for an additional docs with this offering
[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering
List of tags associated with this catalog
List of keywords associated with offering, typically used to search for it
Repository info for offerings
The date and time this catalog was created
The date and time this catalog was last updated
Short description in the requested language
Translated short description, by language code
- short_description_i18n
Long description in the requested language
Translated long description, by language code
- long_description_i18n
list of features associated with this offering
Array of kind
Publish information
Offering is managed by Partner Center
Offering has been approved to publish to permitted to IBM or Public Catalog
Denotes public availability of an Offering
Denotes IBM employee availability of an Offering - if share_enabled is true
Denotes sharing including access list availability of an Offering is enabled
The original offering CRN that this publish entry came from
The crn of the public catalog entry of this offering
The portal's approval record ID
The portal UI URL
The id of the catalog containing this offering
The name of the catalog
Map of metadata values for this offering
- metadata
A disclaimer for this offering
Determine if this offering should be displayed in the Consumption UI
Deprecated - Provider of this offering
Information on the provider for this offering, or omitted if no provider information is given.
Repository info for offerings
Image pull keys for this offering
Offering Support information
A list of media items related to this offering
Deprecation information for this offering.
The product kind. Valid values are module, solution, or empty string
A list of badges for this offering
A list of plans for this offering
Status Code
Successful response. Your permissions determine what you can see
No Sample Response
Update a version
Update the version for the specified locator ID using an offering 'branch'. Note that any changes to the Offering and Kind in the provided Offering 'branch' are discarded.
PUT /versions/{version_loc_id}Request
Path Parameters
A dotted value of
catalogID.versionID
Offering information
unique id
Cloudant revision
The url for this specific offering
The crn for this specific offering
Display Name in the requested language
Translated display Name, by language code
- label_i18n
The programmatic name of this offering
URL for an icon associated with this offering
URL for an additional docs with this offering
[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering
List of tags associated with this catalog
List of keywords associated with offering, typically used to search for it
Repository info for offerings
The date and time this catalog was created
The date and time this catalog was last updated
Short description in the requested language
Translated short description, by language code
- short_description_i18n
Long description in the requested language
Translated long description, by language code
- long_description_i18n
list of features associated with this offering
Array of kind
Publish information
Offering is managed by Partner Center
Offering has been approved to publish to permitted to IBM or Public Catalog
Denotes public availability of an Offering
Denotes IBM employee availability of an Offering - if share_enabled is true
Denotes sharing including access list availability of an Offering is enabled
The original offering CRN that this publish entry came from
The crn of the public catalog entry of this offering
The portal's approval record ID
The portal UI URL
The id of the catalog containing this offering
The name of the catalog
Map of metadata values for this offering
- metadata
A disclaimer for this offering
Determine if this offering should be displayed in the Consumption UI
Deprecated - Provider of this offering
Information on the provider for this offering, or omitted if no provider information is given.
Repository info for offerings
Image pull keys for this offering
Offering Support information
A list of media items related to this offering
Deprecation information for this offering.
The product kind. Valid values are module, solution, or empty string
A list of badges for this offering
A list of plans for this offering
Response
Offering information
unique id
Cloudant revision
The url for this specific offering
The crn for this specific offering
Display Name in the requested language
Translated display Name, by language code
- label_i18n
The programmatic name of this offering
URL for an icon associated with this offering
URL for an additional docs with this offering
[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering
List of tags associated with this catalog
List of keywords associated with offering, typically used to search for it
Repository info for offerings
The date and time this catalog was created
The date and time this catalog was last updated
Short description in the requested language
Translated short description, by language code
- short_description_i18n
Long description in the requested language
Translated long description, by language code
- long_description_i18n
list of features associated with this offering
Array of kind
Publish information
Offering is managed by Partner Center
Offering has been approved to publish to permitted to IBM or Public Catalog
Denotes public availability of an Offering
Denotes IBM employee availability of an Offering - if share_enabled is true
Denotes sharing including access list availability of an Offering is enabled
The original offering CRN that this publish entry came from
The crn of the public catalog entry of this offering
The portal's approval record ID
The portal UI URL
The id of the catalog containing this offering
The name of the catalog
Map of metadata values for this offering
- metadata
A disclaimer for this offering
Determine if this offering should be displayed in the Consumption UI
Deprecated - Provider of this offering
Information on the provider for this offering, or omitted if no provider information is given.
Repository info for offerings
Image pull keys for this offering
Offering Support information
A list of media items related to this offering
Deprecation information for this offering.
The product kind. Valid values are module, solution, or empty string
A list of badges for this offering
A list of plans for this offering
Status Code
Successful response. Your permissions determine what you can update
Unauthorized
No Permissions
No such catalog/offering
No Sample Response
Update a version
Update a version using a JSONPatch document as defined by RFC 6902. Note that the path must always reference '/kinds/0/versions/0/...'
PATCH /versions/{version_loc_id}Request
Custom Headers
Offering etag contained in quotes.
Path Parameters
A dotted value of
catalogID.versionID
A JSONPatch document as defined by RFC 6902.
The operation to be performed.
Allowable values: [
add,remove,replace,move,copy,test]A JSON-Pointer.
The value to be used within the operations.
A string containing a JSON Pointer value
Response
Offering information
unique id
Cloudant revision
The url for this specific offering
The crn for this specific offering
Display Name in the requested language
Translated display Name, by language code
- label_i18n
The programmatic name of this offering
URL for an icon associated with this offering
URL for an additional docs with this offering
[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering
List of tags associated with this catalog
List of keywords associated with offering, typically used to search for it
Repository info for offerings
The date and time this catalog was created
The date and time this catalog was last updated
Short description in the requested language
Translated short description, by language code
- short_description_i18n
Long description in the requested language
Translated long description, by language code
- long_description_i18n
list of features associated with this offering
Array of kind
Publish information
Offering is managed by Partner Center
Offering has been approved to publish to permitted to IBM or Public Catalog
Denotes public availability of an Offering
Denotes IBM employee availability of an Offering - if share_enabled is true
Denotes sharing including access list availability of an Offering is enabled
The original offering CRN that this publish entry came from
The crn of the public catalog entry of this offering
The portal's approval record ID
The portal UI URL
The id of the catalog containing this offering
The name of the catalog
Map of metadata values for this offering
- metadata
A disclaimer for this offering
Determine if this offering should be displayed in the Consumption UI
Deprecated - Provider of this offering
Information on the provider for this offering, or omitted if no provider information is given.
Repository info for offerings
Image pull keys for this offering
Offering Support information
A list of media items related to this offering
Deprecation information for this offering.
The product kind. Valid values are module, solution, or empty string
A list of badges for this offering
A list of plans for this offering
Status Code
Version was updated successfully
Unauthorized
No Permissions
No such catalog/offering
No Sample Response
Delete version
Delete the specified version. If the version is an active version with a working copy, the working copy will be deleted as well.
DELETE /versions/{version_loc_id}Request
Path Parameters
A dotted value of
catalogID.versionID
versionLocator := "{versionLocator}" deleteOptions := service.NewDeleteVersionOptions(versionLocator) response, _ := service.DeleteVersion(deleteOptions) fmt.Println(response)
String versionLocator = "{versionLocator}"; deleteOption = new DeleteVersionOptions.Builder().versionLocId(versionLocator).build(); Response<Void> response = service.deleteVersion(deleteOption).execute(); System.out.println(response.getResult());
versionLocator = "{versionLocator}" response = self.service.delete_version(version_loc_id=versionLocator) print(response)
versionLocator = "{versionLocator}"; response = await service.deleteVersion({ 'versionLocId': versionLocator }); console.log(response);
Get offering/kind/version 'dependencies'
Get the latest version of all offerings/variations that depends on this version locator
GET /versions/{version_loc_id}/dependenciesRequest
Path Parameters
A dotted value of
catalogID.versionID
versionLocator := "{versionLocator}" versionOptions := service.NewGetVersionOptions(versionLocator) _, response, _ := service.GetVersionDependencies(versionOptions) fmt.Println(response)
String versionLocator = "{versionLocator}"; GetVersionOptions getOptions = new GetVersionOptions.Builder().versionLocId(versionLocator).build(); Response<Offering> response = service.getVersionDependencies(getOptions).execute(); System.out.println(response.getResult());
versionLocator = "{versionLocator}" response = self.service.get_version_dependencies(version_loc_id=versionLocator) print(response)
versionLocator = "{versionLocator}"; response = await service.getVersionDependencies({ 'versionLocId': versionLocator }); console.log(response);
Response
Version dependency on a VersionLocator
The limit that was applied to this response. It may be smaller than in the request because that was too large
The number of resources returned in this response
Link response on a token paginated query
The start token used for this response
The total count of resources in the system that matches the request
- version
Dependant account
Dependant Catalog
Dependant Offering
Dependant Version
Dependant (semver) version
Dependant variation
Dependencies semver range
Link response on a token paginated query
Link response on a token paginated query
Link response on a token paginated query
Status Code
Successful response. Your permissions determine what you can see
No Sample Response
List versions
[deprecated] use 'search_license_versions' operation instead. Search across all accounts for versions, requires global admin permission.
GET /versions
Request
Query Parameters
query, for now only "q=entitlement_key:
" is supported
id := "{id}" getOptions := service.NewListVersionsOptions(id) response, _ := service.ListVersions(getOptions) fmt.Println(response)
String id = "{id}"; ListVersionsOptions getVersion = new ListVersionsOptions.Builder().q(id).build(); Response<Void> response = service.listVersions(getVersion).execute(); System.out.println(response.getResult());
id = "{id}"; response = await service.listVersions({ 'q': id }); console.log(response);
id = "{id}" response = self.service.list_versions(q=id) print(response)
Deprecate version immediately - use /archive instead
Deprecate the specified version
POST /versions/{version_loc_id}/deprecateRequest
Path Parameters
A dotted value of
catalogID.versionID
versionLocator := "{versionLocator}" depOptions := service.NewDeprecateVersionOptions(versionLocator) response, _ := service.DeprecateVersion(depOptions) fmt.Println(response)
String versionLocator = "{versionLocator}"; DeprecateVersionOptions depOptions = new DeprecateVersionOptions.Builder().versionLocId(versionLocator).build(); Response<Void> response = service.deprecateVersion(depOptions).execute(); System.out.println(response.getResult());
versionLocator = "{versionLocator}"; response = await service.deprecateVersion({ 'versionLocId': versionLocator}); console.log(response);
versionLocator = "{versionLocator}" response = self.service.deprecate_version(version_loc_id=versionLocator) print(response)
List a repository's entries
List the available entries from a given repository
GET /repo/{type}/entriesRequest
Path Parameters
The type of repository (valid repository types: helm)
Query Parameters
The URL for the repository's root (e.g https://kubernetes-charts-incubator.storage.googleapis.com)
repoType := "{repoType}" repoURL := "{repoURL}" getOptions := service.NewGetReposOptions(repoType, repoURL) _, response, _ := service.GetRepos(getOptions) fmt.Println(response)
String repoType = "{repoType}"; String repoURL = "{repoURL}"; GetReposOptions getOptions = new GetReposOptions.Builder().type(repoType).repourl(repoURL).build(); Response<HelmPackage> response = service.getRepos(getOptions).execute(); System.out.println(response.getResult());
repoType = "{repoType}"; repoURL = "{repoURL}"; response = await service.getRepos({ 'repoType': repoType, 'repourl': repoURL} ); console.log(response);
repoType = "{repoType}" repoURL = "{repoURL}" response = self.service.get_repos(type=repoType, repourl=repoURL) print(response)
Response
Helm repository metadata
A chart entry in the repo. This response will contain many chart names.
- chart
API version
Date and time created
Description of Helm repo entry
Denotes whether repo entry is deprecated
Digest of entry
Location of repo entry
Entry icon
List of keywords
Emails and names of repo maintainers
Entry name
Helm server version
Array of URLs
Array of sources
Entry version
Application version
Status Code
Successful response.
No Sample Response
Request
Path Parameters
The type of repository (valid repository types: helm)
Query Parameters
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)
repoType := "{repoType}" chartURL := "{chartURL}" getOptions := service.NewGetRepoOptions(repoType, chartURL) _, response, _ := service.GetRepo(getOptions) fmt.Println(response)
String repoType = "{repoType}"; String chartURL = "{chartURL}"; GetRepoOptions getOptions = new GetRepoOptions.Builder().type(repoType).charturl(chartURL).build(); Response<HelmPackage> response = service.getRepo(getOptions).execute(); System.out.println(response.getResult());
repoType = "{repoType}"; chartURL = "{chartURL}"; response = await service.getRepo({ 'repoType': repoType, 'charturl': chartURL } ); console.log(response);
repoType = "{repoType}" chartUrl = "{chartUrl}" response = self.service.get_repo(type=repoType, charturl=chartUrl) print(response)
Request
Query Parameters
The maximum number of results to return
Possible values: value ≤ 1000
Default:
100The number of results to skip before returning values
Kubernetes or OpenShift. Default is kubernetes.
listOptions := service.NewListClustersOptions() _, response, _ := service.ListClusters(listOptions) fmt.Println(response)
ListClustersOptions getOptions = new ListClustersOptions.Builder().build(); Response<ClusterSearchResult> response = service.listClusters(getOptions).execute(); System.out.println(response.getResult());
response = await service.listClusters(); console.log(response);
response = self.service.list_clusters() print(response)
Response
Paginated cluster search result
The offset (origin 0) of the first resource in this page of search results.
The maximum number of resources returned in each page of search results.
The overall total number of resources in the search result set.
The number of resources returned in this page of search results.
A URL for retrieving the first page of search results.
A URL for retrieving the last page of search results.
A URL for retrieving the previous page of search results.
A URL for retrieving the next page of search results.
Resulting objects
Status Code
Successful Result
Unauthorized
No Permissions
No Sample Response
Get kubernetes cluster
Get the contents of the specified kubernetes cluster
GET /deploy/kubernetes/clusters/{cluster_id}Request
Custom Headers
IAM Refresh token
Path Parameters
ID of the cluster
Query Parameters
Region of the cluster
clusterID := "{clusterID}" region := "{region}" authRefreshToken := "{authRefreshToken}" getOptions := service.NewGetClusterOptions(clusterID, region, authRefreshToken) _, response, _ := service.GetCluster(getOptions) fmt.Println(response)
String clusterID = "{clusterID}"; String region = "{region}"; String authRefreshToken = "{authRefreshToken}"; GetClusterOptions getOptions = new GetClusterOptions.Builder().clusterId(clusterID).region(region).xAuthRefreshToken(authRefreshToken).build(); Response<ClusterInfo> response = service.getCluster(getOptions).execute(); System.out.println(response.getResult());
clusterID = "{clusterID}"; region = "{region}"; authRefreshToken = "{authRefreshToken}"; response = await service.getCluster({ 'clusterId': clusterID, 'region': region, 'xAuthRefreshToken': authRefreshToken }); console.log(response);
clusterID = "{clusterID}" region = "{region}" authRefreshToken="{authRefreshToken}" response = self.service.get_cluster(cluster_id=clusterID, region=region, x_auth_refresh_token=authRefreshToken) print(response)
Get cluster namespaces
Get the namespaces associated with the specified kubernetes cluster
GET /deploy/kubernetes/clusters/{cluster_id}/namespacesRequest
Custom Headers
IAM Refresh token
Path Parameters
ID of the cluster
Query Parameters
Cluster region
The maximum number of results to return
Possible values: value ≤ 1000
Default:
100The number of results to skip before returning values
Default:
0
clusterID := "{clusterID}" region := "{region}" authRefreshToken := "{authRefreshToken}" getOptions := service.NewGetNamespacesOptions(clusterID, region, authRefreshToken) _, response, _ := service.GetNamespaces(getOptions) fmt.Println(response)
String clusterID = "{clusterID}"; String region = "{region}"; String authRefreshToken = "{authRefreshToken}"; GetNamespacesOptions getOptions = new GetNamespacesOptions.Builder().clusterId(clusterID).region(region).xAuthRefreshToken(authRefreshToken).build(); Response<NamespaceSearchResult> response = service.getNamespaces(getOptions).execute(); System.out.println(response.getResult());
clusterID = "{clusterID}"; region = "{region}"; authRefreshToken = "{authRefreshToken}"; response = await service.getNamespaces({ 'clusterId': clusterID, 'region': region, 'xAuthRefreshToken': authRefreshToken }); console.log(response);
clusterID = "{clusterID}" region = "{region}" authRefreshToken="{authRefreshToken}" response = self.service.get_namespaces(cluster_id=clusterID, region=region, x_auth_refresh_token=authRefreshToken) print(response)
Response
Paginated list of namespace search results
The offset (origin 0) of the first resource in this page of search results.
The maximum number of resources returned in each page of search results.
The overall total number of resources in the search result set.
The number of resources returned in this page of search results.
A URL for retrieving the first page of search results.
A URL for retrieving the last page of search results.
A URL for retrieving the previous page of search results.
A URL for retrieving the next page of search results.
Resulting objects
Status Code
List of namespaces on the cluster that are visible by the current user
Unauthorized
No Permissions
No such cluster
No Sample Response
Request
Custom Headers
IAM Refresh token
Cluster request data
Cluster ID
Cluster region
Kube namespaces to deploy Operator(s) to
Denotes whether to install Operator(s) globally
A dotted value of
catalogID.versionIDOperator channel
Plan
createOption := service.NewCreateOperatorOptions(authRefreshToken) createOption.SetNamespaces({namespaces}} createOption.SetClusterID("{clusterID}") createOption.SetRegion("{region}") createOption.SetVersionLocatorID("{versionLocator}") _, response, _ := service.CreateOperator(createOption) fmt.Println(response)
String namespaces = {namespaces}; String clusterID = "{clusterID}"; String region = "{region}"; String authRefreshToken = "{authRefreshToken}"; String versionLocator = "{versionLocator}"; CreateOperatorOptions createOptions = new CreateOperatorOptions.Builder().namespaces(namespaces).clusterId(clusterID).region(region).xAuthRefreshToken(authRefreshToken).versionLocatorId(versionLocator).build(); Response<List<OperatorDeployResult>> response = service.createOperator(createOptions).execute(); System.out.println(response.getResult());
clusterID = "{clusterID}"; region = "{region}"; namespaces = "{namespaces}"; versionLocator = "{versionLocator}"; authRefreshToken = "{authRefreshToken}"; response = await service.createOperator({ 'clusterId': clusterID, 'region': region, 'namespaces': namespaces, 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken }); console.log(response);
clusterID = "{clusterID}" region = "{region}" namespaces = {namespaces} authRefreshToken="{authRefreshToken}" versionLocator = "{versionLocator}" response = self.service.create_operator(version_locator_id=versionLocator, cluster_id=clusterID, region=region, namespaces=namespaces, x_auth_refresh_token=authRefreshToken) print(response)
Request
Custom Headers
IAM Refresh token
Query Parameters
Cluster identification
Cluster region
A dotted value of
catalogID.versionID
clusterID := "{clusterID}" region := "{region}" versionLocator := "{versionLocator}" authRefreshToken := "{authRefreshToken}" listOptions := service.NewListOperatorsOptions(authRefreshToken, clusterID, region, versionLocator) _, response, _ := service.ListOperators(listOptions) fmt.Println(response)
String clusterID = "{clusterID}"; String region = "{region}"; String authRefreshToken = "{authRefreshToken}"; String versionLocator = "{versionLocator}"; ListOperatorsOptions listOptions = new ListOperatorsOptions.Builder().clusterId(clusterID).region(region).xAuthRefreshToken(authRefreshToken).versionLocatorId(versionLocator).build(); Response<List<OperatorDeployResult>> response = service.listOperators(listOptions).execute(); System.out.println(response.getResult());
clusterID = "{clusterID}"; region = "{region}"; versionLocator = "{versionLocator}"; authRefreshToken = "{authRefreshToken}"; response = await service.listOperators({ 'clusterId': clusterID, 'region': region, 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken }); console.log(response);
clusterID = "{clusterID}" region = "{region}" authRefreshToken="{authRefreshToken}" versionLocator = "{versionLocator}" response = self.service.list_operators(version_locator_id=versionLocator, cluster_id=clusterID, region=region, x_auth_refresh_token=authRefreshToken) print(response)
Request
Custom Headers
IAM Refresh token
Cluster request data
Cluster ID
Cluster region
Kube namespaces to deploy Operator(s) to
Denotes whether to install Operator(s) globally
A dotted value of
catalogID.versionIDOperator channel
Plan
replaceOptions := service.NewReplaceOperatorOptions(authRefreshToken) replaceOptions.SetNamespaces({namespaces}} replaceOptions.SetClusterID("{clusterID}") replaceOptions.SetRegion("{region}") replaceOptions.SetVersionLocatorID("{versionLocator}") _, response, _ := service.ReplaceOperator(replaceOptions) fmt.Println(response)
String namespaces = {namespaces}; String clusterID = "{clusterID}"; String region = "{region}"; String authRefreshToken = "{authRefreshToken}"; String versionLocator = "{versionLocator}"; ReplaceOperatorOptions replaceOptions = new ReplaceOperatorOptions.Builder().namespaces(namespaces).clusterId(clusterID).region(region).xAuthRefreshToken(authRefreshToken).versionLocatorId(versionLocator).build(); Response<List<OperatorDeployResult>> response = service.replaceOperator(replaceOptions).execute(); System.out.println(response.getResult());
clusterID = "{clusterID}"; region = "{region}"; namespaces = "{namespaces}"; versionLocator = "{versionLocator}"; authRefreshToken = "{authRefreshToken}"; response = await service.replaceOperator({ 'clusterId': clusterID, 'region': region, 'namespaces': namespaces, 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken }); console.log(response);
clusterID = "{clusterID}" region = "{region}" namespaces = {namespaces} authRefreshToken="{authRefreshToken}" versionLocator = "{versionLocator}" response = self.service.replace_operator(version_locator_id=versionLocator, cluster_id=clusterID, region=region, namespaces=namespaces, x_auth_refresh_token=authRefreshToken) print(response)
Request
Custom Headers
IAM Refresh token
Query Parameters
Cluster identification
Cluster region
A dotted value of
catalogID.versionID
deleteOptions := service.NewDeleteOperatorOptions(authRefreshToken, clusterID, region, versionLocator) deleteOptions.SetNamespaces({namespaces}} deleteOptions.SetClusterID("{clusterID}") deleteOptions.SetRegion("{region}") deleteOptions.SetVersionLocatorID("{versionLocator}") _, response, _ := service.ReplaceOperator(deleteOptions) fmt.Println(response)
String clusterID = "{clusterID}"; String region = "{region}"; String authRefreshToken = "{authRefreshToken}"; String versionLocator = "{versionLocator}"; DeleteOperatorOptions deleteOptions = new DeleteOperatorOptions.Builder().clusterId(clusterID).region(region).xAuthRefreshToken(authRefreshToken).versionLocatorId(versionLocator).build(); Response<Void> response = service.deleteOperator(deleteOptions).execute(); System.out.println(response.getResult());
clusterID = "{clusterID}"; region = "{region}"; versionLocator = "{versionLocator}"; authRefreshToken = "{authRefreshToken}"; response = await service.deleteOperator({ 'clusterId': clusterID, 'region': region, 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken }); console.log(response);
clusterID = "{clusterID}" region = "{region}" authRefreshToken="{authRefreshToken}" versionLocator = "{versionLocator}" response = self.service.delete_operator(version_locator_id=versionLocator, cluster_id=clusterID, region=region, x_auth_refresh_token=authRefreshToken) print(response)
Request
Custom Headers
IAM Refresh token
Path Parameters
A dotted value of
catalogID.versionID
Cluster request data
Cluster ID
Cluster region
Kube namespace
Kube namespaces
Used when installing an operator, to indicate that it should be made avaiable in all namespaces on the target cluster
Validation override values. Required for virtual server image for VPC.
- override_values
Name of virtual server image instance to create. Required for virtual server image for VPC.
Profile to use when validating virtual server image. Required for virtual server image for VPC.
ID of subnet to use when validating virtual server image. Required for virtual server image for VPC.
ID of VPC to use when validating virtual server image. Required for virtual server image for VPC.
Zone of subnet to use when validating virtual server image. Required for virtual server image for VPC.
ID off SSH key to use when validating virtual server image. Required for virtual server image for VPC.
Region virtual server image exists in. Required for virtual server image for VPC.
Used when the product has required dependencies, to indicated existing dependencies to reuse during validation
Schematics environment variables to use with this workspace
- environment_variables
Variable name
Variable value
Does this variable contain a secure value
Environment variable is hidden
Entitlement API Key for this offering
Schematics workspace configuration
- schematics
Schematics workspace name
Schematics workspace description
Schematics workspace tags
Resource group to use when creating the schematics workspace
Terraform version override
Schematics workspace region
Script
Script ID
A dotted value of
catalogID.versionIDVCenter ID
VCenter Location
VCenter User
VCenter Password
VCenter Datastore
Software plan ID
Used when installing an operator, to indicate which channel to use
Used when installing an operator, to indicate which install plan to use
versionLocator := "{versionLocator}" authRefreshToken := "{authRefreshToken}" installOptions := service.NewInstallVersionOptions(versionLocator, authRefreshToken) response, _ := service.InstallVersion(installOptions) fmt.Println(response)
String authRefreshToken = "{authRefreshToken}"; String versionLocator = "{versionLocator}"; InstallVersionOptions installOptions = new InstallVersionOptions.Builder().xAuthRefreshToken(authRefreshToken).versionLocatorId(versionLocator).build(); Response<Void> response = service.installVersion(installOptions).execute(); System.out.println(response.getResult());
versionLocator = "{versionLocator}"; authRefreshToken = "{authRefreshToken}"; response = await service.installVersion({ 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken }); console.log(response);
authRefreshToken="{authRefreshToken}" versionLocator = "{versionLocator}" response = self.service.install_version(version_locator_id=versionLocator, x_auth_refresh_token=authRefreshToken) print(response)
Pre-install version
Create a pre-install for the specified version
POST /versions/{version_loc_id}/preinstallRequest
Custom Headers
IAM Refresh token
Path Parameters
A dotted value of
catalogID.versionID
Cluster request data
Cluster ID
Cluster region
Kube namespace
Kube namespaces
Used when installing an operator, to indicate that it should be made avaiable in all namespaces on the target cluster
Validation override values. Required for virtual server image for VPC.
- override_values
Name of virtual server image instance to create. Required for virtual server image for VPC.
Profile to use when validating virtual server image. Required for virtual server image for VPC.
ID of subnet to use when validating virtual server image. Required for virtual server image for VPC.
ID of VPC to use when validating virtual server image. Required for virtual server image for VPC.
Zone of subnet to use when validating virtual server image. Required for virtual server image for VPC.
ID off SSH key to use when validating virtual server image. Required for virtual server image for VPC.
Region virtual server image exists in. Required for virtual server image for VPC.
Used when the product has required dependencies, to indicated existing dependencies to reuse during validation
Schematics environment variables to use with this workspace
- environment_variables
Variable name
Variable value
Does this variable contain a secure value
Environment variable is hidden
Entitlement API Key for this offering
Schematics workspace configuration
- schematics
Schematics workspace name
Schematics workspace description
Schematics workspace tags
Resource group to use when creating the schematics workspace
Terraform version override
Schematics workspace region
Script
Script ID
A dotted value of
catalogID.versionIDVCenter ID
VCenter Location
VCenter User
VCenter Password
VCenter Datastore
Software plan ID
Used when installing an operator, to indicate which channel to use
Used when installing an operator, to indicate which install plan to use
versionLocator := "{versionLocator}" authRefreshToken := "{authRefreshToken}" installOptions := service.NewPreinstallVersionOptions(versionLocator, authRefreshToken) response, _ := service.PreinstallVersion(installOptions) fmt.Println(response)
String authRefreshToken = "{authRefreshToken}"; String versionLocator = "{versionLocator}"; PreinstallVersionOptions installOptions = new PreinstallVersionOptions.Builder().xAuthRefreshToken(authRefreshToken).versionLocatorId(versionLocator).build(); Response<Void> response = service.preinstallVersion(installOptions).execute(); System.out.println(response.getResult());
versionLocator = "{versionLocator}"; authRefreshToken = "{authRefreshToken}"; response = await service.preinstallVersion({ 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken }); console.log(response);
authRefreshToken="{authRefreshToken}" versionLocator = "{versionLocator}" response = self.service.preinstall_version(version_locator_id=versionLocator, x_auth_refresh_token=authRefreshToken) print(response)
Get version pre-install status
Get the pre-install status for the specified version
GET /versions/{version_loc_id}/preinstallRequest
Custom Headers
IAM Refresh token
Path Parameters
A dotted value of
catalogID.versionID
Query Parameters
ID of the cluster
Cluster region
Required if the version's pre-install scope is
namespace
versionLocator := "{versionLocator}" authRefreshToken := "{authRefreshToken}" getOptions := service.NewGetPreinstallOptions(versionLocator, authRefreshToken) _, response, _ := service.GetPreinstall(getOptions) fmt.Println(response)
String authRefreshToken = "{authRefreshToken}"; String versionLocator = "{versionLocator}"; GetPreinstallOptions installOptions = new GetPreinstallOptions.Builder().xAuthRefreshToken(authRefreshToken).versionLocId(versionLocator).build(); Response<Void> response = service.getPreinstall(installOptions).execute(); System.out.println(response.getResult());
versionLocator = "{versionLocator}"; authRefreshToken = "{authRefreshToken}"; response = await service.getPreinstall({ 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken }); console.log(response);
authRefreshToken="{authRefreshToken}" versionLocator = "{versionLocator}" response = self.service.get_preinstall(version_locator_id=versionLocator, x_auth_refresh_token=authRefreshToken) print(response)
Response
Installation status
Installation status metadata
- metadata
Cluster ID
Cluster region
Cluster namespace
Workspace ID
Workspace name
Release information
- release
Kube deployments
- deployments
Kube replica sets
- replicasets
Kube stateful sets
- statefulsets
Kube pods
- pods
Kube errors
- errors
Content management information
- content_mgmt
Pods
- pods
Errors
- errors
Status Code
Preinstall status
Unauthorized
No Permissions
No such catalog/offering
No Sample Response
Validate offering
Validate the offering associated with the specified version
POST /versions/{version_loc_id}/validation/installRequest
Custom Headers
IAM Refresh token
Path Parameters
A dotted value of
catalogID.versionID
Query Parameters
The name of a target account context on a catalog
Cluster request data
Cluster ID
Cluster region
Kube namespace
Kube namespaces
Used when installing an operator, to indicate that it should be made avaiable in all namespaces on the target cluster
Validation override values. Required for virtual server image for VPC.
- override_values
Name of virtual server image instance to create. Required for virtual server image for VPC.
Profile to use when validating virtual server image. Required for virtual server image for VPC.
ID of subnet to use when validating virtual server image. Required for virtual server image for VPC.
ID of VPC to use when validating virtual server image. Required for virtual server image for VPC.
Zone of subnet to use when validating virtual server image. Required for virtual server image for VPC.
ID off SSH key to use when validating virtual server image. Required for virtual server image for VPC.
Region virtual server image exists in. Required for virtual server image for VPC.
Used when the product has required dependencies, to indicated existing dependencies to reuse during validation
Schematics environment variables to use with this workspace
- environment_variables
Variable name
Variable value
Does this variable contain a secure value
Environment variable is hidden
Entitlement API Key for this offering
Schematics workspace configuration
- schematics
Schematics workspace name
Schematics workspace description
Schematics workspace tags
Resource group to use when creating the schematics workspace
Terraform version override
Schematics workspace region
Script
Script ID
A dotted value of
catalogID.versionIDVCenter ID
VCenter Location
VCenter User
VCenter Password
VCenter Datastore
Software plan ID
Used when installing an operator, to indicate which channel to use
Used when installing an operator, to indicate which install plan to use
versionLocator := "{versionLocator}" authRefreshToken := "{authRefreshToken}" installOptions := service.NewValidationInstallOptions(versionLocator, authRefreshToken) response, _ := service.ValidationInstall(installOptions) fmt.Println(response)
String authRefreshToken = "{authRefreshToken}"; String versionLocator = "{versionLocator}"; ValidationInstallOptions installOptions = new ValidationInstallOptions.Builder().xAuthRefreshToken(authRefreshToken).versionLocId(versionLocator).build(); Response<Void> response = service.validationInstall(installOptions).execute(); System.out.println(response.getResult());
versionLocator = "{versionLocator}"; authRefreshToken = "{authRefreshToken}"; response = await service.validationInstall({ 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken }); console.log(response);
authRefreshToken="{authRefreshToken}" versionLocator = "{versionLocator}" response = self.service.validation_install(version_locator_id=versionLocator, x_auth_refresh_token=authRefreshToken) print(response)
Get offering install status
Returns the install status for the specified offering version
GET /versions/{version_loc_id}/validation/installRequest
Custom Headers
IAM Refresh token
Path Parameters
A dotted value of
catalogID.versionID
Query Parameters
The name of a target account context on a catalog
versionLocator := "{versionLocator}" authRefreshToken := "{authRefreshToken}" getOptions := service.NewGetValidationStatusOptions(versionLocator, authRefreshToken) _, response, _ := service.GetValidationStatus(getOptions) fmt.Println(response)
String authRefreshToken = "{authRefreshToken}"; String versionLocator = "{versionLocator}"; GetValidationStatusOptions getOptions = new GetValidationStatusOptions.Builder().xAuthRefreshToken(authRefreshToken).versionLocId(versionLocator).build(); Response<Void> response = service.getValidationStatus(getOptions).execute(); System.out.println(response.getResult());
versionLocator = "{versionLocator}"; authRefreshToken = "{authRefreshToken}"; response = await service.getValidationStatus({ 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken }); console.log(response);
authRefreshToken="{authRefreshToken}" versionLocator = "{versionLocator}" response = self.service.get_validation_status(version_locator_id=versionLocator, x_auth_refresh_token=authRefreshToken) print(response)
Response
Validation response
Date and time of last successful validation
Date and time of last validation was requested
Current validation state -
, in_progress, valid, invalid, expired Last operation (e.g. submit_deployment, generate_installer, install_offering
Validation target information (e.g. cluster_id, region, namespace, etc). Values will vary by Content type
- target
Any message needing to be conveyed as part of the validation job
Status Code
Successful Result
Unauthorized
No Permissions
No such catalog/offering
No Sample Response
Get schematics workspaces
Returns the schematics workspaces for the specified offering version
GET /versions/{version_loc_id}/workspacesRequest
Path Parameters
A dotted value of
catalogID.versionID
Query Parameters
The name of a target account context on a catalog
versionLocator := "{versionLocator}" authRefreshToken := "{authRefreshToken}" getOptions := service.NewGetSchematicsWorkspacesOptions(versionLocator, authRefreshToken) _, response, _ := service.GetSchematicsWorkspaces(getOptions) fmt.Println(response)
String versionLocator = "{versionLocator}"; GetSchematicsWorkspacesOptions getOptions = new GetSchematicsWorkspacesOptions.Builder().versionLocId(versionLocator).build(); Response<SchematicsWorkspaceSearchResult> response = service.getSchematicsWorkspaces(getOptions).execute(); System.out.println(response.getResult());
versionLocator = "{versionLocator}"; authRefreshToken = "{authRefreshToken}"; response = await service.getSchematicsWorkspaces({ 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken }); console.log(response);
authRefreshToken="{authRefreshToken}" versionLocator = "{versionLocator}" response = self.service.get_schematics_workspaces(version_locator_id=versionLocator, x_auth_refresh_token=authRefreshToken) print(response)
Response
Result of schematics workspace search
The offset (origin 0) of the first resource in this page of search results.
The maximum number of resources returned in each page of search results.
The overall total number of resources in the search result set.
The number of resources returned in this page of search results.
A URL for retrieving the first page of search results.
A URL for retrieving the last page of search results.
A URL for retrieving the previous page of search results.
A URL for retrieving the next page of search results.
Resulting objects
Status Code
Successful Result
Unauthorized
No Permissions
No such catalog/offering/kind/version
No Sample Response
Get schematics permissions
Returns the schematics permissions for the specified user
GET /versions/{version_loc_id}/candeployRequest
Path Parameters
A dotted value of
catalogID.versionID
Query Parameters
ID of the cluster
Cluster region
Required if the version's pre-install scope is
namespaceResource group identification
versionLocator := "{versionLocator}" clusterID := "{clusterID}" region := "{region}" deployOptions := service.NewCanDeploySchematicsOptions(versionLocator, clusterID, region) _, response, _ := service.CanDeploySchematics(deployOptions) fmt.Println(response)
String versionLocator = "{versionLocator}"; CanDeploySchematicsOptions deployOptions = new CanDeploySchematicsOptions.Builder().versionLocId(versionLocator).build(); Response<DeployRequirementsCheck> response = service.canDeploySchematics(deployOptions).execute(); System.out.println(response.getResult());
versionLocator = "{versionLocator}"; clusterID = "{clusterID}"; region = "{region}"; response = await service.canDeploySchematics({ 'versionLocatorId': versionLocator, 'clusterId': clusterID, 'region': region }); console.log(response);
versionLocator = "{versionLocator}" response = self.service.can_deploy_schematics(version_locator_id=versionLocator) print(response)
Get resource groups
Returns all active resource groups in the current account, where the current user has permission to create schematics workspaces.
GET /deploy/schematics/resourcegroups
Request
No Request Parameters
getOptions := service.NewGetResourceGroupsOptions() _, response, _ := service.GetResourceGroups(getOptions) fmt.Println(response)
Response<ResourceGroups> response = service.getResourceGroups().execute(); System.out.println(response.getResult());
response = await service.getResourceGroups(); console.log(response);
response = self.service.get_resource_groups() print(response)
Response
Resource groups details
The offset (origin 0) of the first resource in this page of search results.
The maximum number of resources returned in each page of search results.
The overall total number of resources in the search result set.
The number of resources returned in this page of search results.
A URL for retrieving the first page of search results.
A URL for retrieving the last page of search results.
A URL for retrieving the previous page of search results.
A URL for retrieving the next page of search results.
Resulting Resource Group objects
Status Code
Successful Result
Unauthorized
No Permissions
No Sample Response
Request
No Request Parameters
getOptions := service.NewGetLicenseProvidersOptions() _, response, _ := service.GetLicenseProviders(getOptions) fmt.Println(response)
Response<LicenseProviders> response = service.getLicenseProviders().execute(); System.out.println(response.getResult());
response = self.service.get_license_providers() print(response)
response = await service.getLicenseProviders(); console.log(response);
List license entitlements
Returns the license entitlements bound to an account
GET /license/entitlements
Request
Query Parameters
The account ID to query for the entitlement. Default is the account from the user's token.
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
The GC ID of the specific offering version.
The state of the license entitlement. eg. usually 'active', or if it's been deleted will show as 'removed'.
listOptions := service.NewListLicenseEntitlementsOptions() _, response, _ := service.ListLicenseEntitlements(listOptions) fmt.Println(response)
String id = "{id}"; ListLicenseEntitlementsOptions getOptions = new ListLicenseEntitlementsOptions.Builder().licenseProductId(id).build(); Response<LicenseEntitlements> response = service.listLicenseEntitlements(getOptions).execute(); System.out.println(response.getResult());
response = self.service.list_license_entitlements() print(response)
response = await service.listLicenseEntitlements(); console.log(response);
Create license entitlement
Create an entitlement for a Cloud account. This is used to give an account an entitlement to a license.
POST /license/entitlements
Request
Query Parameters
if not specified the token's account will be used
License entitlement information
Entitlement name
Entitlement is good from this starting date. eg. '2019-07-17T21:21:47.6794935Z'
Entitlement is good until this ending date. eg. '2019-07-17T21:21:47.6794935Z'
Global Catalog ID of the version
Specific license entitlement ID from the license provider, eg. D1W3R4
IBM ID of the owner of this license entitlement
License provider ID
License product ID
createOptions := service.NewCreateLicenseEntitlementOptions() createOptions.SetName("{name}") _, response, _ := service.CreateLicenseEntitlement(createOptions) fmt.Println(response)
String name = "{name}"; CreateLicenseEntitlementOptions createOptions = new CreateLicenseEntitlementOptions.Builder().name(name).build(); Response<LicenseEntitlement> response = service.createLicenseEntitlement(createOptions).execute(); System.out.println(response.getResult());
name = "{name}"; response = await service.createLicenseEntitlement({ 'name': name } ); console.log(response);
name = "{name}" response = self.service.create_license_entitlement(name=name) print(response)
Response
License entitlement
Entitlement name
Entitlement ID
Entitlement CRN
URL for the BSS entitlement, e.g. /v1/licensing/entitlements/:id
Entitlement offering type
State of the BSS entitlement, e.g. 'active' or if it's been deleted, 'removed'.
Entitlement is good from this starting date. eg. '2019-07-17T21:21:47.6794935Z'
Entitlement is good until this ending date. eg. '2019-07-17T21:21:47.6794935Z'
Account ID where this entitlement is bound to
Account ID of owner
GC ID of the specific offering version
Marketplace offering ID for this license entitlement
Specific license entitlement ID from the license provider, eg. D1W3R4
IBM ID of the owner of this license entitlement
Type of license entitlement, e.g. ibm-ppa
ID of the license provider
URL for the BSS license provider, e.g. /v1/licensing/license_providers/:license_provider_id
Specific license entitlement ID from the license provider, eg. D1W3R4
Location of the registry images, eg. cp/cp4d
API key for access to the license entitlement
IBM ID
IBM ID
Creation date, eg. '2019-07-17T21:21:47.6794935Z'
Date last updated, eg. '2019-07-17T21:21:47.6794935Z'
Entitlement history
- history
Eg. create
Eg. IBM ID of user
Date of action, eg. '2019-07-17T21:21:47.6794935Z'
Array of license offering references
Status Code
Successful creation
Unauthorized
No Permissions
No Sample Response
Get license entitlements for license product ID
Get the license entitlements for a specific license product ID bound to an account
GET /license/entitlements/productID/{license_product_id}Request
Path Parameters
The license product ID. If from PPA (Passport Advantage) this is a specific product Part number, eg. D1YGZLL
Query Parameters
The account ID to query for the entitlement. Default is the account from the user's token.
The GC ID of the specific offering version.
getOptions := service.NewGetLicenseEntitlementsOptions() _, response, _ := service.GetLicenseEntitlements(getOptions) fmt.Println(response)
GetLicenseEntitlementsOptions getOptions = new GetLicenseEntitlementsOptions.Builder().build(); Response<LicenseEntitlements> response = service.getLicenseEntitlements(getOptions).execute(); System.out.println(response.getResult());
id = "{id}"; response = await service.getLicenseEntitlements({ 'licenseProductId': id } ); console.log(response);
id = "{id}" response = self.service.get_license_entitlements(license_product_id=id) print(response)
Delete license entitlement
Delete a license entitlement that is bound to an account. Note that BSS will mark the entitlement field "state": "removed".
DELETE /license/entitlements/{entitlement_id}Request
Path Parameters
The specific entitlement ID (can be obtained from one of the license entitlement queries)
Query Parameters
The account ID to query for the entitlement. Default is the account from the user's token.
id := "{id}" deleteOptions := service.NewDeleteLicenseEntitlementOptions(id) _, response, _ := service.GetLicenseEntitlements(deleteOptions) fmt.Println(response)
String id = "{id}"; DeleteLicenseEntitlementOptions deleteOptions = new DeleteLicenseEntitlementOptions.Builder().entitlementId(id).build(); Response<Void> response = service.deleteLicenseEntitlement(deleteOptions).execute(); System.out.println(response.getResult());
id = "{id}"; response = await service.deleteLicenseEntitlement({ 'entitlementId': id } ); console.log(response);
id = "{id}" response = self.service.delete_license_entitlement(entitlement_id=id) print(response)
Get licenses
Retrieve available licenses from supported license subsystems. This is used to get the list of available licenses that the user has
GET /license/licenses
Request
Query Parameters
ID of the license provider, ie. retrieved from GET license_providers
If not specified the token's account will be used
License name
Type of license, if not specified, default is ibm-ppa
The license product ID. If from PPA (Passport Advantage) this is the product Part number, eg. D1YGZLL
getOptions := service.NewGetLicensesOptions(id) _, response, _ := service.GetLicenseEntitlements(getOptions) fmt.Println(response)
GetLicensesOptions getOptions = new GetLicensesOptions.Builder().build(); Response<Licenses> response = service.getLicenses(getOptions).execute(); System.out.println(response.getResult());
id = "{id}"; response = await service.getLicenses({ 'licenseProviderId': id } ); console.log(response);
id = "{id}" response = self.service.get_(license_provider_id=id) print(response)
Search for versions
Search across accounts for all versions usig a particular license, requires global admin permission.
GET /search/license/versions
Request
Query Parameters
query, for now only "q=entitlement_key:
" is supported
name := "{name}" searchOptions := service.NewSearchLicenseVersionsOptions(name) response, _ := service.SearchLicenseVersions(searchOptions)
String name = "{name}"; SearchLicenseVersionsOptions getOptions = new SearchLicenseVersionsOptions.Builder().q(name).build(); service.searchLicenseVersions(getOptions).execute(); System.out.println(response.getResult());
name="{name}" response = self.service.search_license_versions(q=name) print(response)
name = "{name}"; response = await service.searchLicenseVersions({ 'q': name }); console.log(response);
Search for offerings
Search across accounts for all offerings using a particular license, requires global admin permission.
GET /search/license/offerings
Request
Query Parameters
query, for now only "q=entitlement_key:
" is supported
name := "{name}" searchOptions := service.NewSearchLicenseOfferingsOptions(name) response, _ := service.SearchLicenseOfferings(searchOptions)
String name = "{name}"; SearchLicenseOfferingsOptions getOptions = new SearchLicenseOfferingsOptions.Builder().q(name).build(); Response<Void> response = service.searchLicenseOfferings(getOptions).execute(); System.out.println(response.getResult());
name = "{name}" response = self.service.search_license_offerings(q=name) print(response)
name = "{name}"; response = await service.searchLicenseOfferings({ 'q': name }); console.log(response);
List objects across catalogs
List the available objects from both public and private catalogs. These copies cannot be used for updating. They are not complete and only return what is visible to the caller.
GET /objects
Request
Query Parameters
Lucene query string
The kind of the object. It will default to "vpe"
Allowable values: [
vpe]The maximum number of results to return
Possible values: value ≤ 1000
Default:
100The number of results to skip before returning values
Default:
0When true, hide private objects that correspond to public or IBM published objects
Display a digests of search results, has default value of true
Response
Paginated object search result
The offset (origin 0) of the first resource in this page of search results.
The maximum number of resources returned in each page of search results.
The overall total number of resources in the search result set.
The number of resources returned in this page of search results.
A URL for retrieving the first page of search results.
A URL for retrieving the last page of search results.
A URL for retrieving the previous page of search results.
A URL for retrieving the next page of search results.
Resulting objects
Status Code
Successful response. Your permissions determine what you can see
No Sample Response
List objects within a catalog
List the available objects within the specified catalog.
GET /catalogs/{catalog_identifier}/objectsRequest
Path Parameters
Catalog identifier
Query Parameters
The number of results to return
Possible values: value ≤ 1000
Default:
100The number of results to skip before returning values
Default:
0Only return results that contain the specified 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.
Response
Paginated object search result
The offset (origin 0) of the first resource in this page of search results.
The maximum number of resources returned in each page of search results.
The overall total number of resources in the search result set.
The number of resources returned in this page of search results.
A URL for retrieving the first page of search results.
A URL for retrieving the last page of search results.
A URL for retrieving the previous page of search results.
A URL for retrieving the next page of search results.
Resulting objects
Status Code
Successful response. Your permissions determine what you can see
No Sample Response
Create catalog object
Create an object with a specific catalog
POST /catalogs/{catalog_identifier}/objectsRequest
Path Parameters
Catalog identifier
object information
The programmatic name of this object
The crn for this specific object
The url for this specific object
The parent for this specific object
Translated display name in the requested language
- label_i18n
Display name in the requested language
List of tags associated with this catalog
The date and time this catalog was created
The date and time this catalog was last updated
Short description in the requested language
Short description translation
- short_description_i18n
Kind of object
Publish information
Offering state
The id of the catalog containing this offering
The name of the catalog
Map of data values for this object
- data
Response
object information
unique id
Cloudant revision
The programmatic name of this object
The crn for this specific object
The url for this specific object
The parent for this specific object
Translated display name in the requested language
- label_i18n
Display name in the requested language
List of tags associated with this catalog
The date and time this catalog was created
The date and time this catalog was last updated
Short description in the requested language
Short description translation
- short_description_i18n
Kind of object
Publish information
Offering state
The id of the catalog containing this offering
The name of the catalog
Map of data values for this object
- data
Status Code
Catalog object created successfully
Unauthorized
No Permissions
No Sample Response
Get catalog object
Get the specified object from within the specified catalog
GET /catalogs/{catalog_identifier}/objects/{object_identifier}Response
object information
unique id
Cloudant revision
The programmatic name of this object
The crn for this specific object
The url for this specific object
The parent for this specific object
Translated display name in the requested language
- label_i18n
Display name in the requested language
List of tags associated with this catalog
The date and time this catalog was created
The date and time this catalog was last updated
Short description in the requested language
Short description translation
- short_description_i18n
Kind of object
Publish information
Offering state
The id of the catalog containing this offering
The name of the catalog
Map of data values for this object
- data
Status Code
Successful Result
Unauthorized
No Permissions
No such catalog/object
No Sample Response
Update catalog object
Update an object within a specific catalog
PUT /catalogs/{catalog_identifier}/objects/{object_identifier}Request
Path Parameters
Catalog identifier
Object identifier
object information
unique id
Cloudant revision
The programmatic name of this object
The crn for this specific object
The url for this specific object
The parent for this specific object
Translated display name in the requested language
- label_i18n
Display name in the requested language
List of tags associated with this catalog
The date and time this catalog was created
The date and time this catalog was last updated
Short description in the requested language
Short description translation
- short_description_i18n
Kind of object
Publish information
Offering state
The id of the catalog containing this offering
The name of the catalog
Map of data values for this object
- data
Response
object information
unique id
Cloudant revision
The programmatic name of this object
The crn for this specific object
The url for this specific object
The parent for this specific object
Translated display name in the requested language
- label_i18n
Display name in the requested language
List of tags associated with this catalog
The date and time this catalog was created
The date and time this catalog was last updated
Short description in the requested language
Short description translation
- short_description_i18n
Kind of object
Publish information
Offering state
The id of the catalog containing this offering
The name of the catalog
Map of data values for this object
- data
Status Code
Catalog object was updated successfully
Unauthorized
No Permissions
No such catalog/object
No Sample Response
Get object audit logs
Get the audit logs associated with an object.
GET /catalogs/{catalog_identifier}/objects/{object_identifier}/auditsRequest
Path Parameters
Catalog identifier
Object identifier
Query Parameters
Start token for a query
number or results to return in the query
Possible values: value ≤ 1000
Default:
100Auditlog Lookup Names - by default names are not returned in auditlog.
Response
A collection of audit records
The limit that was applied to this response. It may be smaller than in the request because that was too large
The number of resources returned in this response
Link response on a token paginated query
A list of audit records
The start token used for this response
The total count of resources in the system that matches the request
Link response on a token paginated query
Link response on a token paginated query
Link response on a token paginated query
Status Code
Successful response. Your permissions determine what you can see
Unauthorized
No Permissions
No Sample Response
Get an object audit log entry
Get the full audit log entry associated with an object.
GET /catalogs/{catalog_identifier}/objects/{object_identifier}/audits/{auditlog_identifier}Request
Path Parameters
Catalog identifier
Object identifier
Auditlog ID
Query Parameters
Auditlog Lookup Names - by default names are not returned in auditlog.
Response
An audit log which describes a change made to a catalog or associated resource.
The identifier of the audit record.
Cloudant revision
The time at which the change was made.
The type of change described by the audit record.
The resource type associated with the change.
The identifier of the resource that was changed.
The email address of the user that made the change.
The email address of the delegate user that made the change. This happens when a service makes a change onbehalf of the user
A message which describes the change.
Transaction id for this change
IAM identifier of the user who made the change
Name of the user who made the change
IAM identifier of the delegate user who made the change
Name of the delegate user who made the change
Data about the change. Usually a change log of what was changed, both before and after. Can be of any type.
Status Code
Successful response. Your permissions determine what you can see
Unauthorized
No Permissions
No Sample Response
Allows object to be shared
Set the share options on an object.
POST /catalogs/{catalog_identifier}/objects/{object_identifier}/shareGet object access list
Get the access list associated with the specified object
GET /catalogs/{catalog_identifier}/objects/{object_identifier}/accessv1Request
Path Parameters
Catalog identifier
Object identifier
Query Parameters
Start token for a query
number or results to return in the query
Possible values: value ≤ 1000
Default:
100
Response
Paginated Offering search result
The limit that was applied to this response. It may be smaller than in the request because that was too large
The number of resources returned in this response
Link response on a token paginated query
A list of access records
The start token used for this response
The total count of resources in the system that matches the request
Link response on a token paginated query
Link response on a token paginated query
Link response on a token paginated query
Status Code
Successful response
Bad request
Unauthorized
No Permissions
No Sample Response
Check for account ID in object access list
Determine if an account ID is in an object's access list
GET /catalogs/{catalog_identifier}/objects/{object_identifier}/access/{access_identifier}Request
Path Parameters
Catalog identifier
Object identifier
Identifier for access. Use 'accountId' or '-acct-accountId' for an account, '-ent-enterpriseid' for an enterprise, and '-entgrp-enterprisegroupid' for an enterprise group.
Response
access
unique id
account id
Normal account or enterprise
unique id
object ID
object's owner's account
entity type
date and time create
Approval state for access. If this field is an empty string, then it means that it's approved
List of additional version states that this account can see. The default visible states are consumable and prerelease.
Status Code
Successful response
Bad request
Unauthorized
No Permissions
The specified account ID was not found in the object's access list.
No Sample Response
Add account ID to object access list
Add an account ID to an object's access list.
POST /catalogs/{catalog_identifier}/objects/{object_identifier}/access/{access_identifier}Remove account ID from object access list
Delete the specified account ID from the specified object's access list
DELETE /catalogs/{catalog_identifier}/objects/{object_identifier}/access/{access_identifier}Get object access list
Deprecated - use /accessv1 instead
GET /catalogs/{catalog_identifier}/objects/{object_identifier}/accessRequest
Path Parameters
Catalog identifier
Object identifier
Query Parameters
The maximum number of results to return
Possible values: value ≤ 1000
Default:
100The number of results to skip before returning values
Default:
0
Response
Paginated object search result
The offset (origin 0) of the first resource in this page of search results.
The maximum number of resources returned in each page of search results.
The overall total number of resources in the search result set.
The number of resources returned in this page of search results.
A URL for retrieving the first page of search results.
A URL for retrieving the last page of search results.
A URL for retrieving the previous page of search results.
A URL for retrieving the next page of search results.
Resulting objects
Status Code
Successful response
Bad request
Unauthorized
No Permissions
No Sample Response
Delete accesses from object access list
Delete all or a set of accesses from an object's access list.
DELETE /catalogs/{catalog_identifier}/objects/{object_identifier}/accessGet catalog object audit log
Get the audit log associated with a specific catalog object.
GET /catalogs/{catalog_identifier}/objects/{object_identifier}/auditResponse
A collection of audit records
The bookmark of the first resource in this page of search results. Omit for first entry.
The maximum number of resources returned in each page of search results.
The number of resources returned in this page of search results.
A URL for retrieving the first page of search results.
A URL for retrieving the last page of search results.
A URL for retrieving the previous page of search results.
A URL for retrieving the next page of search results.
A list of audit records
Status Code
Successful response. Your permissions determine what you can see
Unauthorized
No Permissions
No Sample Response
Create an offering resource instance
Provision a new offering in a given account, and return its resource instance
POST /instances/offerings
Request
Custom Headers
IAM Refresh token
A offering instance resource (provision instance of a catalog offering)
provisioned instance ID (part of the CRN).
Cloudant revision
url reference to this object.
platform CRN for this instance.
the label for this instance.
Catalog ID this instance was created from.
Offering ID this instance was created from.
the format this instance has (helm, operator, ova...).
Display value for the format this instance has (helm, operator, ova...).
The version this instance was installed from (semver - not version id)
The version id this instance was installed from (version id - not semver)
Cluster ID
Cluster region (e.g., us-south)
List of target namespaces to install into
designate to install into all namespaces
Id of the schematics workspace, for offering instances provisioned through schematics
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 to pin the operator subscription to
date and time create
date and time updated
Map of metadata values for this offering instance
- metadata
Id of the resource group to provision the offering instance into
String location of OfferingInstance deployment
Indicates if Resource Controller has disabled this instance
The account this instance is owned by
the last operation performed and status
- last_operation
last operation performed
state after the last operation performed
additional information about the last operation
transaction id from the last operation
Date and time last updated
Error code from the last operation, if applicable
The target kind for the installed software version
Display value for the target kind for the installed software version
The digest value of the installed software version
The software plan ID used when creating this software instance
The CRN of the resource that is considered a parent of this software instance
label := "{label}" shortDesc := "{shortDesc}" createOptions := service.NewCreateCatalogOptions() createOptions.SetLabel(label) createOptions.SetShortDescription(shortDesc) _, response, _ := service.CreateCatalog(createOptions) fmt.Println(response)
String label = "{label}"; String shortDesc = "{shortDesc}"; CreateCatalogOptions createOptions = new CreateCatalogOptions.Builder().label(label).shortDescription(shortDesc).build(); Response<Catalog> response = service.createCatalog(createOptions).execute(); System.out.println(response.getResult());
label = "{label}" shortDesc = "{shortDesc}" response = self.service.create_catalog(label=label, short_description=shortDesc) print(response)
label = "{label}"; shortDesc = "{shortDesc}"; response = await service.createCatalog({ 'label': label, 'shortDescription': shortDesc }); console.log(response);
Response
A offering instance resource (provision instance of a catalog offering)
provisioned instance ID (part of the CRN).
Cloudant revision
url reference to this object.
platform CRN for this instance.
the label for this instance.
Catalog ID this instance was created from.
Offering ID this instance was created from.
the format this instance has (helm, operator, ova...).
Display value for the format this instance has (helm, operator, ova...).
The version this instance was installed from (semver - not version id)
The version id this instance was installed from (version id - not semver)
Cluster ID
Cluster region (e.g., us-south)
List of target namespaces to install into
designate to install into all namespaces
Id of the schematics workspace, for offering instances provisioned through schematics
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 to pin the operator subscription to
date and time create
date and time updated
Map of metadata values for this offering instance
- metadata
Id of the resource group to provision the offering instance into
String location of OfferingInstance deployment
Indicates if Resource Controller has disabled this instance
The account this instance is owned by
the last operation performed and status
- last_operation
last operation performed
state after the last operation performed
additional information about the last operation
transaction id from the last operation
Date and time last updated
Error code from the last operation, if applicable
The target kind for the installed software version
Display value for the target kind for the installed software version
The digest value of the installed software version
The software plan ID used when creating this software instance
The CRN of the resource that is considered a parent of this software instance
Status Code
New instance created successfully
Unauthorized
No Permissions
No Sample Response
Get Offering Instance
Get the resource associated with an installed offering instance.
GET /instances/offerings/{instance_identifier}Request
Path Parameters
Version Instance identifier
id := "{id}" getOptions := service.NewGetCatalogOptions(id) _, response, _ := service.GetCatalog(getOptions) fmt.Println(response)
String id = "{id}"; GetCatalogOptions getOptions = new GetCatalogOptions.Builder().catalogIdentifier(id).build(); Response<Catalog> response = service.getCatalog(getOptions).execute(); System.out.println(response.getResult());
id = "{id}" response = self.service.get_catalog(catalog_identifier=id) print(response)
id = "{id}"; response = await service.getCatalog({ 'catalogIdentifier': id }); console.log(response);
Response
A offering instance resource (provision instance of a catalog offering)
provisioned instance ID (part of the CRN).
Cloudant revision
url reference to this object.
platform CRN for this instance.
the label for this instance.
Catalog ID this instance was created from.
Offering ID this instance was created from.
the format this instance has (helm, operator, ova...).
Display value for the format this instance has (helm, operator, ova...).
The version this instance was installed from (semver - not version id)
The version id this instance was installed from (version id - not semver)
Cluster ID
Cluster region (e.g., us-south)
List of target namespaces to install into
designate to install into all namespaces
Id of the schematics workspace, for offering instances provisioned through schematics
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 to pin the operator subscription to
date and time create
date and time updated
Map of metadata values for this offering instance
- metadata
Id of the resource group to provision the offering instance into
String location of OfferingInstance deployment
Indicates if Resource Controller has disabled this instance
The account this instance is owned by
the last operation performed and status
- last_operation
last operation performed
state after the last operation performed
additional information about the last operation
transaction id from the last operation
Date and time last updated
Error code from the last operation, if applicable
The target kind for the installed software version
Display value for the target kind for the installed software version
The digest value of the installed software version
The software plan ID used when creating this software instance
The CRN of the resource that is considered a parent of this software instance
Status Code
Successful Result
Unauthorized
No Permissions
No such catalog id
No Sample Response
Update Offering Instance
Update an installed offering instance.
PUT /instances/offerings/{instance_identifier}Request
Custom Headers
IAM Refresh token
Path Parameters
Version Instance identifier
A offering instance resource (provision instance of a catalog offering)
provisioned instance ID (part of the CRN).
Cloudant revision
url reference to this object.
platform CRN for this instance.
the label for this instance.
Catalog ID this instance was created from.
Offering ID this instance was created from.
the format this instance has (helm, operator, ova...).
Display value for the format this instance has (helm, operator, ova...).
The version this instance was installed from (semver - not version id)
The version id this instance was installed from (version id - not semver)
Cluster ID
Cluster region (e.g., us-south)
List of target namespaces to install into
designate to install into all namespaces
Id of the schematics workspace, for offering instances provisioned through schematics
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 to pin the operator subscription to
date and time create
date and time updated
Map of metadata values for this offering instance
- metadata
Id of the resource group to provision the offering instance into
String location of OfferingInstance deployment
Indicates if Resource Controller has disabled this instance
The account this instance is owned by
the last operation performed and status
- last_operation
last operation performed
state after the last operation performed
additional information about the last operation
transaction id from the last operation
Date and time last updated
Error code from the last operation, if applicable
The target kind for the installed software version
Display value for the target kind for the installed software version
The digest value of the installed software version
The software plan ID used when creating this software instance
The CRN of the resource that is considered a parent of this software instance
id := "{id}" getOptions := service.NewGetCatalogOptions(id) _, response, _ := service.GetCatalog(getOptions) fmt.Println(response)
String id = "{id}"; GetCatalogOptions getOptions = new GetCatalogOptions.Builder().catalogIdentifier(id).build(); Response<Catalog> response = service.getCatalog(getOptions).execute(); System.out.println(response.getResult());
id = "{id}" response = self.service.get_catalog(catalog_identifier=id) print(response)
id = "{id}"; response = await service.getCatalog({ 'catalogIdentifier': id }); console.log(response);
Response
A offering instance resource (provision instance of a catalog offering)
provisioned instance ID (part of the CRN).
Cloudant revision
url reference to this object.
platform CRN for this instance.
the label for this instance.
Catalog ID this instance was created from.
Offering ID this instance was created from.
the format this instance has (helm, operator, ova...).
Display value for the format this instance has (helm, operator, ova...).
The version this instance was installed from (semver - not version id)
The version id this instance was installed from (version id - not semver)
Cluster ID
Cluster region (e.g., us-south)
List of target namespaces to install into
designate to install into all namespaces
Id of the schematics workspace, for offering instances provisioned through schematics
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 to pin the operator subscription to
date and time create
date and time updated
Map of metadata values for this offering instance
- metadata
Id of the resource group to provision the offering instance into
String location of OfferingInstance deployment
Indicates if Resource Controller has disabled this instance
The account this instance is owned by
the last operation performed and status
- last_operation
last operation performed
state after the last operation performed
additional information about the last operation
transaction id from the last operation
Date and time last updated
Error code from the last operation, if applicable
The target kind for the installed software version
Display value for the target kind for the installed software version
The digest value of the installed software version
The software plan ID used when creating this software instance
The CRN of the resource that is considered a parent of this software instance
Status Code
Successful Result
Unauthorized
No Permissions
No such catalog id
No Sample Response
Delete a version instance
Delete and instance deployed out of a product version
DELETE /instances/offerings/{instance_identifier}Request
Custom Headers
IAM Refresh token
Path Parameters
Version Instance identifier
id := "{id}" deleteOptions := service.NewDeleteCatalogOptions(id) response, _ := service.DeleteCatalog(deleteOptions) fmt.Println(response)
String id = "{id}"; DeleteCatalogOptions deleteOptions = new DeleteCatalogOptions.Builder().catalogIdentifier(id).build(); Response<Void> response = service.deleteCatalog(deleteOptions).execute(); System.out.println(response.getResult());
id = "{id}" response = self.service.delete_catalog(catalog_identifier=id, id=id) print(response)
id = "{id}"; response = await service.deleteCatalog({ 'catalogIdentifier': id, 'id': id }); console.log(response);
Get offering instance audit logs
Get the audit logs associated with an offering instance.
GET /instances/offerings/{instance_identifier}/auditsRequest
Path Parameters
Version Instance identifier
Query Parameters
Start token for a query
number or results to return in the query
Possible values: value ≤ 1000
Default:
100Auditlog Lookup Names - by default names are not returned in auditlog.
Response
A collection of audit records
The limit that was applied to this response. It may be smaller than in the request because that was too large
The number of resources returned in this response
Link response on a token paginated query
A list of audit records
The start token used for this response
The total count of resources in the system that matches the request
Link response on a token paginated query
Link response on a token paginated query
Link response on a token paginated query
Status Code
Successful response. Your permissions determine what you can see
Unauthorized
No Permissions
No Sample Response
Get an offering instance audit log entry
Get the full audit log entry associated with an offering instance.
GET /instances/offerings/{instance_identifier}/audits/{auditlog_identifier}Request
Path Parameters
Version Instance identifier
Auditlog ID
Query Parameters
Auditlog Lookup Names - by default names are not returned in auditlog.
Response
An audit log which describes a change made to a catalog or associated resource.
The identifier of the audit record.
Cloudant revision
The time at which the change was made.
The type of change described by the audit record.
The resource type associated with the change.
The identifier of the resource that was changed.
The email address of the user that made the change.
The email address of the delegate user that made the change. This happens when a service makes a change onbehalf of the user
A message which describes the change.
Transaction id for this change
IAM identifier of the user who made the change
Name of the user who made the change
IAM identifier of the delegate user who made the change
Name of the delegate user who made the change
Data about the change. Usually a change log of what was changed, both before and after. Can be of any type.
Status Code
Successful response. Your permissions determine what you can see
Unauthorized
No Permissions
No Sample Response
Get offering/plan 'branch'
Get the Offering/Plan 'branch' for the specified locator ID
GET /plans/{plan_loc_id}Request
Path Parameters
A dotted value of
sw.catalogID.resourceID
planLocator := "{planLocator}" planOptions := service.NewGetVersionOptions(planLocator) _, response, _ := service.GetPlan(planOptions) fmt.Println(response)
String planLocator = "{planLocator}"; GetPlanOptions getOptions = new GetPlanOptions.Builder().planLocId(planLocator).build(); Response<Offering> response = service.getPlan(getOptions).execute(); System.out.println(response.getResult());
planLocator = "{planLocator}" response = self.service.get_plan(plan_loc_id=planLocator) print(response)
planLocator = "{planLocator}"; response = await service.getPlan({ 'planLocId': planLocator }); console.log(response);
Response
Offering information
unique id
Cloudant revision
The url for this specific offering
The crn for this specific offering
Display Name in the requested language
Translated display Name, by language code
- label_i18n
The programmatic name of this offering
URL for an icon associated with this offering
URL for an additional docs with this offering
[deprecated] - Use offering.support instead. URL to be displayed in the Consumption UI for getting support on this offering
List of tags associated with this catalog
List of keywords associated with offering, typically used to search for it
Repository info for offerings
The date and time this catalog was created
The date and time this catalog was last updated
Short description in the requested language
Translated short description, by language code
- short_description_i18n
Long description in the requested language
Translated long description, by language code
- long_description_i18n
list of features associated with this offering
Array of kind
Publish information
Offering is managed by Partner Center
Offering has been approved to publish to permitted to IBM or Public Catalog
Denotes public availability of an Offering
Denotes IBM employee availability of an Offering - if share_enabled is true
Denotes sharing including access list availability of an Offering is enabled
The original offering CRN that this publish entry came from
The crn of the public catalog entry of this offering
The portal's approval record ID
The portal UI URL
The id of the catalog containing this offering
The name of the catalog
Map of metadata values for this offering
- metadata
A disclaimer for this offering
Determine if this offering should be displayed in the Consumption UI
Deprecated - Provider of this offering
Information on the provider for this offering, or omitted if no provider information is given.
Repository info for offerings
Image pull keys for this offering
Offering Support information
A list of media items related to this offering
Deprecation information for this offering.
The product kind. Valid values are module, solution, or empty string
A list of badges for this offering
A list of plans for this offering
Status Code
Successful response. Your permissions determine what you can see
No Sample Response
Delete plan
Delete the specified plan. A plan cannot be deleted if it published.
DELETE /plans/{plan_loc_id}Request
Path Parameters
A dotted value of
sw.catalogID.resourceID
planLocator := "{planLocator}" deleteOptions := service.NewDeletePlanOptions(planLocator) response, _ := service.DeletePlan(deleteOptions) fmt.Println(response)
String planLocator = "{planLocator}"; deleteOption = new DeletePlanOptions.Builder().planLocId(planLocator).build(); Response<Void> response = service.deletePlan(deleteOption).execute(); System.out.println(response.getResult());
planLocator = "{planLocator}" response = self.service.delete_plan(plan_loc_id=planLocator) print(response)
planLocator = "{planLocator}"; response = await service.deletePlan({ 'planLocId': planLocator }); console.log(response);
Sets plan to be deprecated in a certain time period
Set or cancel the plan to be deprecated.
POST /plans/{plan_loc_id}/deprecate/{setting}Request
Path Parameters
A dotted value of
sw.catalogID.resourceIDSet deprecation (true) or cancel deprecation (false)
Allowable values: [
true,false]
Information for deprecation request
Additional information that users can provide to be displayed in deprecation notification
Specifies the amount of days until product is not available in catalog
Returns available locations based on supplied filter
Returns available locations based on supplied filter
POST /regions
Request
Query Parameters
Filter to apply for search
Returns inactive locations when true
The maximum number of results to return
Possible values: value ≤ 1000
Default:
100The number of results to skip before returning values
Default:
0
Response
Paginated location search result
The offset (origin 0) of the first resource in this page of search results.
The maximum number of resources returned in each page of search results.
The overall total number of resources in the search result set.
The number of resources returned in this page of search results.
Link response on a token paginated query
Link response on a token paginated query
Resulting objects
Status Code
Successful response
Bad request
Unauthorized
No Permissions
No Sample Response
Returns available locations based on filter set on the account and supplied filter
Returns available locations based on filter set on the account and supplied filter
GET /regions
Request
Query Parameters
Filter to apply for search
Returns inactive locations when true
The maximum number of results to return
Possible values: value ≤ 1000
Default:
100The number of results to skip before returning values
Default:
0
Response
Paginated location search result
The offset (origin 0) of the first resource in this page of search results.
The maximum number of resources returned in each page of search results.
The overall total number of resources in the search result set.
The number of resources returned in this page of search results.
Link response on a token paginated query
Link response on a token paginated query
Resulting objects
Status Code
Successful response
Bad request
Unauthorized
No Permissions
No Sample Response
id=curlclassName=tab-item-selected
id=javaclassName=tab-item-unselected
id=nodeclassName=tab-item-unselected
id=pythonclassName=tab-item-unselected
id=goclassName=tab-item-unselected