Manage AIQ Repository Configuration with REST APIs

ThisLast isreviewed: September 22, 2026

Use these repository REST APIs only for supported AIQ administration and automation workflows. Treat repository names, branch data, and credentials as sensitive operational configuration.

Recommended guidance

• Use least-privilege accounts or tokens for repository automation.
• Validate API behavior in a listnon-production ofenvironment usefulbefore automating changes.
• Avoid storing repository relatedcredentials RESTor APIs,tokens in documentation, scripts, or logs.

getRepositoryNamesByUserValidation workflow

Endpoint

1. Confirm

   rest/preferences/getRepositoryNamesByUser

   the

   Description

   AIQ

   Returnsversion and supported repository API endpoints.

2. Authenticate with an arrayapproved withaccount alland call read-only endpoints first.
3. Validate repository configurationname, namesbranch, fromand currentstatus loggedresponses inbefore user.triggering

   Requestpull parameters | payload

   N/A

   Response

   [ "repoName1", "repoName2", "repoName3" ]
   or emptysave arrayoperations.

4. Log ifexecution noIDs repoand configsnon-sensitive exists.
   
   [ ]

   getRepositoryByUser

   Endpoint

   rest/preferences/getRepositoryByUser

   Description

   Returns JSON object withresponse details offor the a repo given its name or empty JSON if no configuration with provided name is found.

   Request parameters | payload

   ?name=repoName1

   Response

   Success

   
   

   {     "proxyPort": 0,     "commitMessage": "Appvance Commit",     "auth": "Password",     "proxyServer": "",     "proxyUsername": "",     "name": "repoName1",     "proxyPassword": "",     "proxyType": "defatult",     "type": "GIT",     "branch": "main",     "url": "https://gitlab.com/appvnc/repomemo/",     "username": "appvnc"}

   
   

   Error (repoName1 was not found)

   
   

   { }

   
   

   getRepositoryStatus

   Endpoint

   rest/preferences/getRepositoryStatus

   Description

   Returns JSON object with status of the a repo given its name.

   Request parameters | payload

   ?name=repoName1

   Response

   Success:

   
   

   {     "timeStamp": "2023/01/30 19:59:52",     "stack": "",     "status": "WORKING"}

   
   

   Error:

   
   

   {     "timeStamp": "0",     "stack": "Repository not found",     "status": "ERROR"}

   
   

   pullRepository

   Endpoint

   rest/preferences/pullRepository

   Description

   If repo is found, it triggers a git pull action on the repotraceability.

5. Review and thenrotate executescredentials aused getRepositoryStatus returning the same JSON as that call.

   Request parameters | payload

   ?name=repoName1

   Response

   Success:

   
   

   {     "timeStamp": "2023/01/30 19:59:52",     "stack": "",     "status": "WORKING"}

   
   

   On error:

   {

   
   

   {     "timeStamp": "2023/01/30 19:59:52",     "stack": "Repository not found",     "status": "ERROR"}

   
   

   getBranches

   Endpoint

   rest/preferences/getBranches

   Description

   Returns the names of all the existing branches in the remote repository

   Request parameters | payload

   ?name=repoName1

   Response

   Success:

   
   

   {     "timeStamp": "0",     "stack": "",     "branches": [     "main",     "performanceFolder"     ],     "status": "OK"}

   
   

   On Error:

   
   

   {     "timeStamp": "0",     "stack": "Repository not found",     "status": "ERROR"}

   
   

   saveRepository

   Endpoint

   rest/preferences/saveRepository

   Description

   Saves new or updatesby repository configuration

   integrations.

PossibleNote: errorDelete messages:
"Repositoryand withsave givenoperations namecan exists"
"Incorrect credentials."

Request parameters | payload

{"type":"GIT","name":"repoName1","url":"https://gitlab.net/ac/repo.git","username":"user@example.com","ssh":"","auth":"Password","password":"Wkdz!vxh14x9","branch":"","commitMessage":"","proxyServer":"","proxyPort":0,"proxyUsername":"","proxyPassword":"","proxyType":"defatult"}

Response

Success:

{     "message": "Repository successfully saved.",     "status": "success"}

On Error:

{     "message": "Error: check yourchange repository configuration.", "status":Use "error"}

them

only

deleteRepository

with

Endpoint

explicit

rest/preferences/deleteRepository

admin

Description

Deletes a repository configuration named repoName1 for current user.

Request parameters | payload

?repositoryName=repoName1

Response

Success:

done true

On Error:

done falseintent.

---

Last updated: JulySeptember 07,22, 20232026

If you have any feedback on this topic, please contact us at documentation@appvance.ai.