What is 'canary' & API version

Developer help
1

Hi folks, I have quick question,

Is version ‘canary’ always the latest version? At the time of writing, v5?
Also, is the Admin API version goes the same with the ghost version?

2

In older versions of Ghost canary was the unstable version of the API that would become the next version.

However, Ghost no longer has versioned API URLs, instead all Admin API endpoints live on yoursite.com/ghost/api/admin/* and use an Accept-Version header. You can find more details in the Admin API docs.

2 Likes
3

Thank you for your prompt reply, I now understand what canary is, and Admin API no longer has versioned URLs.

I actually have one more question,
I was confused because the example here (Admin API JavaScript Client) passes the parameter “v5.0” for the argument “version”
for the GhostAdminAPI .

With the explanation in Authentication here, it says

  • version - minimum version of the API your code works with

and I didn’t get the message here.
My homepage is now build on ghost Version: 5.91.0
but my code which use Admin API still passes parameter like below

           const api = new GhostAdminAPI({`
                url: config.auth.ghost[userDoc.local.langCode]['url'],`
                key: config.auth.ghost[userDoc.local.langCode]['key'],`
                version: "v3.0",`
              });

Do I also have to change the parameter for the version here,
when I conduct major version update?

4

@Kevin I would be appreciated if you could follow up this question.