Home → Problems →

Changes in AppVeyor API URLs

• Edit

gep13

07 Aug, 2024 12:22 PM

Hello,

Unless I am mistaken, there seems to have been some changes to the AppVeyor API rules, which haven't been updated on this page:

https://www.appveyor.com/docs/api/projects-builds/

For example, in order to get the query for Get Projects to work, I had to change from:

/api/projects

to

/api/account/{accountName}/projects

similarly, for Get Deployments, it had to change from:

/api/deployments/{deploymentId}

to:

/api/account/{accountName}/deployments/{deploymentId}

Are all of these required URL changes documented somewhere, and are there plans to update the documentation to reflect what is actually required?

Thanks
Gary

1. 1 Posted by gep13 on 07 Aug, 2024 03:07 PM

   

   Hello,

   I found a similar issue here:

   https://help.appveyor.com/discussions/problems/23835-getting-list-o...

   Where a solution was found, but there was no mention of changes to the API that would have caused this.

   Thanks
   Gary

   • Edit

2. Support Staff 2 Posted by Owen McDonnell on 08 Aug, 2024 09:42 PM

   

   I've added a note to this section of our docs to clarify, in addition to the note that already existed on users' api-key page when they belong to several accounts and choose All accounts option (see screenshot).

   • api-key-page.png 66 KB
   • Edit

3. 3 Posted by gep13 on 10 Aug, 2024 02:42 PM

   

   Hello Owen,

   Thank you for the information. That indeed was the root cause of the problem that I was having. All the Unit Tests for the project that I was updating now work.

   I guess the problem for me came when looking at this section:

   https://www.appveyor.com/docs/api/projects-builds/#get-projects

   I was trying to make a request to here:

   GET /api/projects
   

   And it wasn't working. There is no mention on that page of the need to use a specific API Key.

   Having grabbed the default API Key (i.e. the All Accounts one is the default one selected in the dropdown list) from the API Key page, I would have expected it just to work, however, it is necessary instead to grab a different API Key from that page.

   As you have pointed out, the User API Key page does call this out, but perhaps this needs to be more clearly called out on the page. Could there be a red warning callout when the All Accounts option is selected, which goes away when you choose a specific account. Or could there be a link to the new section which you have just added from each API page (i.e. the project-builds page that I linked to above).

   These are just ideas, but I honestly think they would help people coming to this problem.

   Thanks again for your help! Really appreciate it!
   Gary

   • Edit