Introduction

The private catalog service allows users to manage the way users in the account can interact with the public catalog, via the filtering mechanism. Users can create private catalogs, and can use these private catalogs to both manage access to the public catalog and upload their own offerings. For more information, see the catalog documentation.

API endpoint

https://cm.globalcatalog.cloud.ibm.com

API endpoint

https://cm.globalcatalog.cloud.ibm.com

API endpoint

https://cm.globalcatalog.cloud.ibm.com

API endpoint

https://cm.globalcatalog.cloud.ibm.com

Error handling

The private catalog uses standard HTTP response codes to indicate whether a method completed successfully. A 200 type response always indicates success. A 400 type response is a failure, and a 500 type response is an internal system error.

Methods

Get the account settings

Get the account level settings for the account for private catalog

GET /catalogaccount
Request

No Request Parameters

This method does not accept any request parameters.

Response

Response Body

Account

Status Code

  • 200

    Successful response. Your permissions determine what you can see

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

Set the account settings

PUT /catalogaccount
Request

Request Body

Account
Response

Status Code

  • 200

    Succesful update. Your permissions determine if can update or not.

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

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

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

GET /catalogaccount/filters
Request

Query Parameters

  • catalog
    string

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

Response

Response Body

AccumulatedFilters

The accumulated filters for an account. This will return the account filters plus a filter for each catalog the user has access to.

Status Code

  • 200

    Successful response. Your permissions determine what you can see

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

Get list of catalogs

List the available catalogs for a given account

GET /catalogs
Request

No Request Parameters

This method does not accept any request parameters.

Response

Response Body

CatalogSearchResult

Status Code

  • 200

    Successful response. Your permissions determine what you can see

No Sample Response

This method does not specify any sample responses.

Create a catalog

Create a catalog for a given account

POST /catalogs
Request

Request Body

Catalog
Response

Response Body

Catalog

Status Code

  • 201

    Successful creation

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

/catalogs/{catalogID}

GET /catalogs/{catalogID}
Request

Path Parameters

  • catalogID
    string
Response

Response Body

Catalog

Status Code

  • 200

    Successful Result

  • 401

    Unauthorized

  • 403

    No Permissions

  • 404

    No such catalog id

No Sample Response

This method does not specify any sample responses.

/catalogs/{catalogID}

PUT /catalogs/{catalogID}
Request

Path Parameters

  • catalogID
    string

Request Body

Catalog
Response

Response Body

Catalog

Status Code

  • 200

    Successful Result

  • 401

    Unauthorized

  • 403

    No Permissions

  • 404

    No such catalog id

No Sample Response

This method does not specify any sample responses.

/catalogs/{catalogID}

DELETE /catalogs/{catalogID}
Request

Path Parameters

  • catalogID
    string
Response

Status Code

  • 200

    Successful Result

  • 401

    Unauthorized

  • 403

    No Permissions

  • 404

    No such catalog

No Sample Response

This method does not specify any sample responses.

Get list of offerings for consumption

List the available offerings from both public and from the account that currently scoped for consumption. These copies cannot be used updating. They are not complete and only return what is visible to the caller.

GET /offerings
Request

Query Parameters

  • digest
    boolean

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

  • catalog
    string

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

  • select
    string

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

    Allowable values: [all,public,private]

  • includeHidden
    boolean

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

Response

Response Body

OfferingSearchResult

Status Code

  • 200

    Successful response. Your permissions determine what you can see

No Sample Response

This method does not specify any sample responses.

Get list of offerings

List the available offerings in the specified catalog

GET /catalogs/{catalogID}/offerings
Request

Path Parameters

  • catalogID
    string
Response

Response Body

OfferingSearchResult

Status Code

  • 200

    Successful response. Your permissions determine what you can see

No Sample Response

This method does not specify any sample responses.

Create an offering

Create an offering

POST /catalogs/{catalogID}/offerings
Request

Path Parameters

  • catalogID
    string

Request Body

Offering
Response

Response Body

Offering

Status Code

  • 201

    Successful creation

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

Import new version to offering from a tgz

Import new version to offering from a tgz

POST /catalogs/{catalogID}/offerings/{offeringID}/version
Request

Path Parameters

  • catalogID
    string
  • offeringID
    string

Query Parameters

  • zipurl
    string
  • targetVersion
    string

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

  • includeConfig
    boolean

    Add all possible configuration values to this version when importing

Response

Response Body

Offering

Status Code

  • 201

    New version created

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

Import a new offering from a tgz

Import a new offering from a tgz

POST /catalogs/{catalogID}/import/offerings
Request

Path Parameters

  • catalogID
    string

Query Parameters

  • zipurl
    string
  • offeringID
    string

    Re-use the specified offeringID during import

  • includeConfig
    boolean

    Add all possible configuration items when creating this version

Response

Response Body

Offering

Status Code

  • 201

    New offering created

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

Reload existing version in offering from a tgz

Reload exsiting version in offering from a tgz

PUT /catalogs/{catalogID}/offerings/{offeringID}/reload
Request

Path Parameters

  • catalogID
    string
  • offeringID
    string

Query Parameters

  • zipurl
    string
  • targetVersion
    string

    The semver value for this new version

Response

Response Body

Offering

Status Code

  • 201

    New version created

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

Get an offering

Get an offering

GET /catalogs/{catalogID}/offerings/{offeringID}
Request

Path Parameters

  • catalogID
    string

    catalog's ID

  • offeringID
    string
Response

Response Body

Offering

Status Code

  • 200

    Successful Result

  • 401

    Unauthorized

  • 403

    No Permissions

  • 404

    No such catalog/offering

No Sample Response

This method does not specify any sample responses.

Update an offering

Update an offering

PUT /catalogs/{catalogID}/offerings/{offeringID}
Request

Path Parameters

  • catalogID
    string
  • offeringID
    string

Request Body

Offering
Response

Response Body

Catalog

Status Code

  • 200

    Successful Result

  • 401

    Unauthorized

  • 403

    No Permissions

  • 404

    No such catalog/offering

No Sample Response

This method does not specify any sample responses.

Delete an offering

Delete an offering

DELETE /catalogs/{catalogID}/offerings/{offeringID}
Request

Path Parameters

  • catalogID
    string
  • offeringID
    string

Request Body

object
Response

Status Code

  • 200

    Successful Result

  • 401

    Unauthorized

  • 403

    No Permissions

  • 404

    No such catalogg

No Sample Response

This method does not specify any sample responses.

upload an icon for the offerring

upload an icon file to be stored in GC. File is uploaded as a binary payload - not as a form

PUT /catalogs/{catalogID}/offerings/{offeringID}/icon/{fileName}
Request

Path Parameters

  • catalogID
    string

    catalog's ID

  • offeringID
    string
  • fileName
    string

    Name of the file name that is being uploaded

Response

Response Body

Offering

Status Code

  • 200

    Successful Result

  • 401

    Unauthorized

  • 403

    No Permissions

  • 404

    No such catalog/offering

No Sample Response

This method does not specify any sample responses.

Approve offering to be permitted to publish to IBM Public Catalog (IBMers only or Everyone)

Approve or disapprove the offering to be allowed to publish to the IBM Public Catalog in ibm (visible to IBM only) or public (visible to everyone). Can approve to only ibm, or it can be extended to public. If extended to public then ibm is automatically approved too. If disapprove public, then ibm approval will not be changed. If disapprove ibm then public will automatically be disapproved. This is because the process steps always go first through ibm and then to public. ibm cannot be skipped. Only users with Approval IAM authority can use this.

POST /catalogs/{catalogID}}/offerings/{offeringID}}/publish/{type}/{setting}
Request

Path Parameters

  • catalogID
    string

    catalog's ID

  • offeringID
    string

    offering's ID

  • type
    string

    Type of approval, ibm or public

    Allowable values: [ibm,public]

  • setting
    boolean

    Approve or disapprove

Response

Response Body

ApprovalResult

Status Code

  • 200

    Successful Result

  • 401

    Unauthorized

  • 403

    No Permissions

  • 404

    No such catalog/offering

No Sample Response

This method does not specify any sample responses.

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

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

GET /versions/{versionLocatorID}/about
Request

Path Parameters

  • versionLocatorID
    string

    A dotted value of catalogID.versionID

Response

Response Body

VersionAboutInformation

Status Code

  • 200

    Successful response. Your permissions determine what you can see

  • 400

    Bad request

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

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

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

GET /versions/{versionLocatorID}/licenses/{licenseID}
Request

Path Parameters

  • versionLocatorID
    string

    A dotted value of catalogID.versionID

  • licenseID
    string

    The ID of the license, which maps to the file name in the 'licenses' directory of this verions tgz file

Response

Status Code

  • 200

    Successful response. Your permissions determine what you can see

  • 400

    Bad request

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

Get get the list of container images associated with this version

The "image_manifest_url" property of the version should be pointing the a URL for the image manifest, this api reflects that content

GET /versions/{versionLocatorID}/containerImages
Request

Path Parameters

  • versionLocatorID
    string

    A dotted value of catalogID.versionID

Response

Response Body

ImageManifest

Status Code

  • 200

    Successful response. A list of images

No Sample Response

This method does not specify any sample responses.

Deprecate the specified version

Deprecate the specified version

POST /versions/{versionLocatorID}/deprecate
Request

Path Parameters

  • versionLocatorID
    string

    A dotted value of catalogID.versionID

Response

Status Code

  • 202

    Request accepted.

  • 400

    Bad request

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

Publish the specified version so it is viewable by account members

Publish the specified version so it is viewable by account members

POST /versions/{versionLocatorID}/account-publish
Request

Path Parameters

  • versionLocatorID
    string

    A dotted value of catalogID.versionID

Response

Status Code

  • 202

    Request accepted.

  • 400

    Bad request

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

Publish the specified version so that it is visible to IBMers in the public catalog

Publish the specified version so that it is visible to IBMers in the public catalog

POST /versions/{versionLocatorID}/ibm-publish
Request

Path Parameters

  • versionLocatorID
    string

    A dotted value of catalogID.versionID

Response

Status Code

  • 202

    Request accepted.

  • 400

    Bad request

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

Publish the specified version so it is visible to all users in the public catalog

Publish the specified version so it is visible to all users in the public catalog

POST /versions/{versionLocatorID}/public-publish
Request

Path Parameters

  • versionLocatorID
    string

    A dotted value of catalogID.versionID

Response

Status Code

  • 202

    Request accepted.

  • 400

    Bad request

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

Commit a working copy of the specified version

Commit a working copy of the specified version

POST /versions/{versionLocatorID}/commit
Request

Path Parameters

  • versionLocatorID
    string

    A dotted value of catalogID.versionID for either the working copy to commit or the active version with a working copy to be committed.

Response

Status Code

  • 200

    Working Copy Committed

  • 400

    Bad request

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

Create a working copy of the specified version

Create a working copy of the specified version

POST /versions/{versionLocatorID}/workingcopy
Request

Path Parameters

  • versionLocatorID
    string

    A dotted value of catalogID.versionID

Response

Response Body

Version

Status Code

  • 200

    Working Copy Created

  • 400

    Bad request

  • 401

    Unauthorized

  • 403

    No Permissions

  • 409

    Working Copy already exists

No Sample Response

This method does not specify any sample responses.

Get available updates for the specified version

Get available updates for the specified version

GET /versions/{versionLocatorID}/updates
Request

Custom Headers

  • X-Auth-Refresh-Token
    string

    The refresh token for the current user

Path Parameters

  • versionLocatorID
    string

    A dotted value of catalogID.versionID

Query Parameters

  • cluster_id
    string

    The id of the cluster where this version was installed

  • region
    string

    The region of the cluster where this version was installed

  • resource_group_id
    string

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

  • namespace
    string

    The namespace of the cluster where this version was installed

Response

Response Body

VersionUpdateDescriptor[]

Status Code

  • 200

    Version Descriptors, sorted newest first

  • 400

    Bad request

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

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

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

GET /versions/{versionLocatorID}
Request

Path Parameters

  • versionLocatorID
    string

    A dotted value of catalogID.versionID

Response

Response Body

Offering

Status Code

  • 200

    Successful response. Your permissions determine what you can see

No Sample Response

This method does not specify any sample responses.

Delete a version

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

DELETE /versions/{versionLocatorID}
Request

Path Parameters

  • versionLocatorID
    string

    A dotted value of catalogID.versionID

Response

Status Code

  • 200

    Working Copy Deleted

  • 400

    Bad request

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

Search for versions

Search across all versions, requires global admin permission..

GET /versions
Request

Query Parameters

  • q
    string

    query, for now only "q=entitlement_key:" is supported

Response

Status Code

  • 200

    Successful response with a search result of version locators, a dotted value of catalogID.versionID

No Sample Response

This method does not specify any sample responses.

List a repo's entries

List the available entries from a given repo

GET /repo/{type}/entries
Request

Path Parameters

  • type
    string

    The type of repo (valid repo types: helm)

Query Parameters

  • repourl
    string

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

Response

Response Body

HelmRepoList

Status Code

  • 200

    Successful response.

No Sample Response

This method does not specify any sample responses.

Get contents of a repo

Get the contents of a given repo

GET /repo/{type}
Request

Path Parameters

  • type
    string

    The type of repo (valid repo types: helm)

Query Parameters

  • charturl
    string

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

Response

Response Body

HelmChart

Status Code

  • 200

    Successful response.

No Sample Response

This method does not specify any sample responses.

/deploy/kubernetes/clusters

GET /deploy/kubernetes/clusters
Request

Query Parameters

  • limit
    integer

    number or results to return

  • offset
    integer

    number of results to skip before returning values

  • type
    string

    kubernetes or openshift. Default is kubernetes.

Response

Response Body

ClusterSearchResult

Status Code

  • 200

    Successful Result

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

/deploy/kubernetes/clusters/{clusterID}

GET /deploy/kubernetes/clusters/{clusterID}
Request

Custom Headers

  • X-Auth-Refresh-Token
    string

    IAM Refresh token

Path Parameters

  • clusterID
    string

    ID of the cluster

Query Parameters

  • region
    string

    Region of the cluster

Response

Response Body

ClusterInfo

Status Code

  • 200

    Successful Result

  • 401

    Unauthorized

  • 403

    No Permissions

  • 404

    No such cluster

No Sample Response

This method does not specify any sample responses.

/deploy/kubernetes/clusters/{clusterID}/namespaces

GET /deploy/kubernetes/clusters/{clusterID}/namespaces
Request

Custom Headers

  • X-Auth-Refresh-Token
    string

    IAM Refresh token

Path Parameters

  • clusterID
    string

    ID of the cluster

Query Parameters

  • region
    string

    Cluster region

  • limit
    integer

    number or results to return

  • offset
    integer

    number of results to skip before returning values

Response

Response Body

NamespaceSearchResult

Status Code

  • 200

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

  • 401

    Unauthorized

  • 403

    No Permissions

  • 404

    No such cluster

No Sample Response

This method does not specify any sample responses.

/versions/{versionLocatorID}/install

POST /versions/{versionLocatorID}/install
Request

Custom Headers

  • X-Auth-Refresh-Token
    string

    IAM Refresh token

Path Parameters

  • versionLocatorID
    string

    A dotted value of catalogID.versionID

Request Body

ClusterRequestBody
Response

Status Code

  • 202

    Request accepted

  • 401

    Unauthorized

  • 403

    No Permissions

  • 404

    No such catalog/offering

No Sample Response

This method does not specify any sample responses.

/versions/{versionLocatorID}/preinstall

POST /versions/{versionLocatorID}/preinstall
Request

Custom Headers

  • X-Auth-Refresh-Token
    string

    IAM Refresh token

Path Parameters

  • versionLocatorID
    string

    A dotted value of catalogID.versionID

Request Body

ClusterRequestBody
Response

Status Code

  • 202

    Request accepted

  • 401

    Unauthorized

  • 403

    No Permissions

  • 404

    No such catalog/offering

No Sample Response

This method does not specify any sample responses.

/versions/{versionLocatorID}/preinstall

GET /versions/{versionLocatorID}/preinstall
Request

Custom Headers

  • X-Auth-Refresh-Token
    string

    IAM Refresh token

Path Parameters

  • versionLocatorID
    string

    A dotted value of catalogID.versionID

Query Parameters

  • cluster_id
    string
  • region
    string
  • namespace
    string

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

Response

Response Body

InstallStatus

Status Code

  • 200

    Preinstall status

  • 401

    Unauthorized

  • 403

    No Permissions

  • 404

    No such catalog/offering

No Sample Response

This method does not specify any sample responses.

/versions/{versionLocatorID}/validation/install

POST /versions/{versionLocatorID}/validation/install
Request

Custom Headers

  • X-Auth-Refresh-Token
    string

    IAM Refresh token

Path Parameters

  • versionLocatorID
    string

    A dotted value of catalogID.versionID

Request Body

ClusterRequestBody
Response

Status Code

  • 202

    Request accepted

  • 401

    Unauthorized

  • 403

    No Permissions

  • 404

    No such catalog/offering

No Sample Response

This method does not specify any sample responses.

/versions/{versionLocatorID}/validation/install

Returns the install status for the specified offering version

GET /versions/{versionLocatorID}/validation/install
Request

Custom Headers

  • X-Auth-Refresh-Token
    string

    IAM Refresh token

Path Parameters

  • versionLocatorID
    string

    A dotted value of catalogID.versionID

Response

Response Body

Validation

Status Code

  • 200

    Successful Result

  • 401

    Unauthorized

  • 403

    No Permissions

  • 404

    No such catalog/offering

No Sample Response

This method does not specify any sample responses.

/versions/{versionLocatorID}/validation/overridevalues

Returns the override values that were used to validate the specified offering version

GET /versions/{versionLocatorID}/validation/overridevalues
Request

Path Parameters

  • versionLocatorID
    string

    A dotted value of catalogID.versionID

Response

Response Body

object

Status Code

  • 200

    JSON of override values

  • 400

    Invalid request

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

/versions/{versionLocatorID}/workspaces

Returns the schematics workspaces for the specified offering version

GET /versions/{versionLocatorID}/workspaces
Request

Custom Headers

  • X-Auth-Refresh-Token
    string

    IAM Refresh token

Path Parameters

  • versionLocatorID
    string

    A dotted value of catalogID.versionID

Response

Response Body

SchematicsWorkspaceSearchResult

Status Code

  • 200

    Successful Result

  • 401

    Unauthorized

  • 403

    No Permissions

  • 404

    No such catalog/offering/kind/version

No Sample Response

This method does not specify any sample responses.

/versions/{versionLocatorID}/candeploy

Returns the schematics permissions for the specified user

GET /versions/{versionLocatorID}/candeploy
Request

Custom Headers

  • X-Auth-Refresh-Token
    string

    IAM Refresh token

Path Parameters

  • versionLocatorID
    string

    A dotted value of catalogID.versionID

Query Parameters

  • cluster_id
    string
  • region
    string
  • namespace
    string
  • resource_group_id
    string
Response

Response Body

DeployRequirementsCheck

Status Code

  • 200

    Failed requirement checks, by pre_install and install

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

/deploy/schematics/resourcegroups

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

This method does not accept any request parameters.

Response

Response Body

ResourceGroups

Status Code

  • 200

    Successful Result

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

Get license providers

Get license providers

GET /license/license_providers
Request

No Request Parameters

This method does not accept any request parameters.

Response

Response Body

LicenseProviders

Status Code

  • 200

    Successful response.

No Sample Response

This method does not specify any sample responses.

Get license entitlements

Get license entitlements bound to an account

GET /license/entitlements
Request

Query Parameters

  • account_id
    string

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

  • license_product_id
    string

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

  • version_id
    string

    The GC ID of the specific offering version.

  • state
    string

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

Response

Response Body

LicenseEntitlements

Status Code

  • 200

    Successful response.

No Sample Response

This method does not specify any sample responses.

Create a 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

  • account_id
    string

    if not specified the token's account will be used

Request Body

LicenseEntitlementBody
Response

Response Body

LicenseEntitlement

Status Code

  • 200

    Successful creation

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

Get entitlements for a specific license product ID

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

GET /license/entitlements/productID/{license_product_id}
Request

Path Parameters

  • license_product_id
    string

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

Query Parameters

  • account_id
    string

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

  • version_id
    string

    The GC ID of the specific offering version.

Response

Response Body

LicenseEntitlements

Status Code

  • 200

    Successful response.

No Sample Response

This method does not specify any sample responses.

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

  • entitlement_id
    string

    The specific entitlement ID (can be obtained from one of the license entitlement queries)

Query Parameters

  • account_id
    string

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

Response

Status Code

  • 200

    Successful response.

  • 401

    Unauthorized

  • 403

    No Permissions

No Sample Response

This method does not specify any sample responses.

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

  • license_provider_id
    string

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

  • account_id
    string

    if not specified the token's account will be used

  • name
    string
  • license_type
    string

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

  • license_product_id
    string

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

Response

Response Body

Licenses

Status Code

  • 200

    Successful response.

No Sample Response

This method does not specify any sample responses.