aap 2.5 api endpoint changes

[RichardWardle]

Hiya,

Pass on my thanks and appreciation for the project. Currently doing some work with the AAP 2.5 platform (prepping to migrate from 2.4) which uses AF as a frontend for some internal teams.

Is there plans for supporting the changed API structure that was introduced with AAP 2.5 - the upgrade brought in a new architecture which places a gateway service that unifies all the controllers together. This then proxies connections to the various servers/containers on the backend which runs (e.g. eda, hub and controller etc), the gateway server now handles all authentication for the various services:

Querying the pre 2.4 versions on /api with a url of aaptest.redacted.com.au shows:

{
    "description": "AWX REST API",
    "current_version": "[/api/v2/](https://aaptest.redacted.com.au/api/v2/)",
    "available_versions": {
        "v2": "[/api/v2/](https://aaptest.redacted.com.au/api/v2/)"
    },
    "oauth2": "[/api/o/](https://aaptest.redacted.com.au/api/o/)",
        "custom_login_info": "Production Ansible Automation Platform",
    "login_redirect_override": ""
}

When querying 2.5 you get:

{
    "description": "AAP gateway REST API",
    "apis": {
        "gateway": "[/api/gateway/](https://aapgw.redacted.com.au/api/gateway/)",
        "controller": "[/api/controller/](https://aapgw.redacted.com.au/api/controller/)",
        "eda": "[/api/eda/](https://aapgw.redacted.com.au/api/eda/)",
        "galaxy": "[/api/galaxy/](https://aapgw.redacted.com.au/api/galaxy/)"
    }
}

I am hoping that we can get either a check box or logic built into the system to allow the use of the new 2.5 endpoints. Currently the old endpoints do route properly (seemingly for users that were existing in 2.4 - not fully confirmed) but this will eventually be dropped in 2.6 coming out in a potentially few months.

We can see that the below is an example of something that would start to fail when the API changes come in:

Awx.check = function (awxConfig) {
  logger.info(`Checking AWX connection`)
  const axiosConfig = Awx.getAuthorization(awxConfig,true)
  return axios.get(awxConfig.uri + "/api/v2/job_templates/",axiosConfig)
    .then((axiosresult)=>{
      if(axiosresult?.data?.results){
        return "Awx Connection is OK"
      }else{
        throw new Error("Awx Connection failed")
      }
    })
};

The above would most likely change to /api/controller/v2/job_templates. The rest of the API components look to be unchanged underneath that /api/controller/v2

Is it possible to please have a check box that will allow us to toggle the change in API endpoints used to be compatible with the AAP version (leave disabled by default maybe..)?

I am happy and willing to test as it can be cost prohibitive to spin up AAP (even for a short while)

[ansibleguy76]

i will see what the best options are. can you give suggestions
checkbox, env var, database field with api prefix....

[RichardWardle]

I would lean towards changing as little as possible, given the changes in the direction/maintenance of the AWX platform and the competing commercial AAP product.

Seems like there are a few endpoints that are touched:

RH could always change things in the future around what API endpoints are available based on the version (e.g. change instance_groups to instance_grp) and the path they are under (e.g. the /api/v2 to /api/controller/v2) and it would cause issues again for those who use this against an AAP installation.

I think it may be better to use an environment variable that allows you to set the initial prefix to what ever you want but defaults to "/api/v2 if not set. This should ensure users AWX users are not impacted by this and users can opt in if they are on a later version of aap (e.g. 2.4 and above)

Happy for feedback or thoughts from anyone

[ansibleguy76]

I'll make the necessary changes From: RichardWardle ***@***.***> Sent: Tuesday, 1 April 2025 07:51 To: ansibleguy76/ansibleforms ***@***.***> Cc: AnsibleGuy76 ***@***.***>; Comment ***@***.***> Subject: Re: [ansibleguy76/ansibleforms] aap 2.5 api endpoint changes (Discussion #278) I would lean towards changing as little as possible, given the changes in the direction/maintenance of the AWX platform and the competing commercial AAP product. Seems like there are a few endpoints that are touched: snip-2025-04-01-16.36.07.png (view on web) <https://github.com/user-attachments/assets/bf1ac4c7-c31b-4da7-8f8c-e3c2973d cbcc> RH could always change things in the future around what API endpoints are available based on the version (e.g. change instance_groups to instance_grp) and the path they are under (e.g. the /api/v2 to /api/controller/v2) and it would cause issues again for those who use this against an AAP installation. I think it may be better to use an environment variable that allows you to set the initial prefix to what ever you want but defaults to "/api/v2 if not set. This should ensure users AWX users are not impacted by this and users can opt in if they are on a later version of aap (e.g. 2.4 and above) Happy for feedback or thoughts from anyone - Reply to this email directly, view it on GitHub <#278 (comment) ent-12684102> , or unsubscribe <https://github.com/notifications/unsubscribe-auth/AVM6SKVZX6EMI3RSCXPWWI32X IZLVAVCNFSM6AAAAAB2DZTHM6VHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTE NRYGQYTAMQ> . You are receiving this because you commented. <https://github.com/notifications/beacon/AVM6SKSKNEC7ZKUDHVUXCKL2XIZLVA5CNFS M6AAAAAB2DZTHM6WGG33NNVSW45C7OR4XAZNRIRUXGY3VONZWS33OINXW23LFNZ2KUY3PNVWWK3T UL5UWJTQAYGFUM.gif> Message ID: ***@***.*** ***@***.*** hub.com> >

[ansibleguy76]

fixed in 5.0.10... will be online soon