IBM Support

How to generate an API key for CPLEX Optimization Studio Download & Go subscription

How To


Summary

If you subscribe to IBM ILOG CPLEX Optimization Studio Download & Go, you can generate your own API key for use with the software.

Objective

Generate your own API key for use with your CPLEX Optimization Studio subscription plan.

Environment

Windows, Linux, MacOS

Steps

  1. Log into https://cloud.ibm.com using your IBMid.
  2. In the top menu, select Manage > Access (IAM).
  3. Select API Keys and click Create.
  4. Save the generated key to your local drive.
    For security reasons you cannot retrieve the key later. If you lose it you'll have to regenerate it.
Once you've generated your key, you're ready to start using CPLEX Optimization Studio. See Entering your API key and setting the CPLEX_STUDIO environment variables for details.

Additional Information

To test your API key with the license server, you can run this cURL command:
 
curl --request POST 'https://scx-cos.docloud.ibm.com/cos/query/v1/apikeys?apikey=YOUR_API_KEY'
 
If your subscription is valid, you'll see the following response status 200:
{
    "subscription": {
        "subscriptionId": "test_subscription_4Sep2021",
        "subscriptionType": "D00ECZX",
        "actualSubscriptionType": "D1YCNLL",
        "customerIbmId": "your_customer_ID",
        "customerEmail": "your_email@address",
        "subscriptionState": "ACTIVE",
        "expirationDate": -1,
        "pollingRate": 86400
    }
}
If your subscription is not recognized, the response will be an error 400:
 
{
    "status": 5001,
    "message": "Not a valid API key"
}

Document Location

Worldwide

[{"Type":"MASTER","Line of Business":{"code":"LOB76","label":"Data Platform"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSSA5P","label":"IBM ILOG CPLEX Optimization Studio"},"ARM Category":[{"code":"a8m3p0000006wlmAAA","label":"CPLEX Optimization Studio-\u003EHow to"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"},{"Type":"MASTER","Line of Business":{"code":"LOB76","label":"Data Platform"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSUTDB","label":"ILOG CPLEX Optimization Studio Subscription"},"ARM Category":[],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"12.1.0;12.10.0;12.2.0;12.3.0;12.4.0;12.5.0;12.5.1;12.6.0;12.6.1;12.6.2;12.6.3;12.7.0;12.7.1;12.8.0;12.9.0;20.1.0;22.1.0;22.1.1;22.1.2;SaaS"}]

Document Information

Modified date:
10 May 2023

UID

ibm16954451

Page Feedback