Please whitelist cPanel in your adblocker so that you’re able to see our version release promotions, thanks!

The Community Forums

Interact with an entire community of cPanel & WHM users!

API backward compatibility in v54?

Discussion in 'cPanel Developers' started by Aleksey Korolev, Feb 27, 2016.

  1. Aleksey Korolev

    Aleksey Korolev Registered

    Jan 22, 2016
    Likes Received:
    Trophy Points:
    cPanel Access Level:
    Website Owner

    I'm having issues with response format from WHM API version 1 in new version 54 of WHM/CPanel.

    Such functions as sslissue and generatessl (WHM API 1 Functions - generatessl - Software Development Kit - cPanel Documentation) now return fields groupped in metadata and data objects e.g. for generatessl:
    'metadata' => {
    'version' => 1,
    'reason' => 'Key, Certificate, and CSR generated OK',
    'command' => 'generatessl',
    'result' => 1
    'data' => {

    Before v54 result of operation was returns as {results}->{status}, now it is {metadata}->{result}.
    Does this mean broken backward compatibility or there's anything else that could affect return format?
    Thank you.
  2. cPDavidN

    cPDavidN cPanel Developer
    Staff Member

    Mar 19, 2013
    Likes Received:
    Trophy Points:
    cPanel Access Level:
    DataCenter Provider
    Hi Aleksey,

    I just used the 'generatessl' API call on 11.52 and 11.54, and the results were structured the same as far as I could tell. I could see the operation succeeded based on {metadata}->{result} in both cases. Could you give more details about how you're making the API call?

    There are SSL-related calls in all 5 cPanel & WHM APIs, and the cPanel APIs will return data in a different structure, but the WHM APIs should not be changing.

    David Nielson
    cPanel Developer
    Stop hovering to collapse... Click to collapse... Hover to expand... Click to expand...

Share This Page

  1. This site uses cookies to help personalise content, tailor your experience and to keep you logged in if you register.
    By continuing to use this site, you are consenting to our use of cookies.
    Dismiss Notice