Accessing AIQ Repository Configuration via REST APIs

LastThis reviewed:is Septembera 22,list 2026of useful repository related REST APIs,

getRepositoryNamesByUser

Endpoint

rest/preferences/getRepositoryNamesByUser

Description

Returns an array with all repository configuration names from current logged in user.

Request parameters | payload

N/A

Response

[ "repoName1", "repoName2", "repoName3" ]
or empty array if no repo configs exists.

[ ]

getRepositoryByUser

Endpoint

rest/preferences/getRepositoryByUser

Description

Returns JSON object with details of 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 repo and then executes a 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 updates repository configuration

UsePossible theseerror 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 non-production environment before automating changes.
• Avoid storing repository credentials or tokens in documentation, scripts, or logs.

Validation workflow

1. Confirm the AIQ version and supported repository API endpoints.
2. Authenticatemessages:
   "Repository with angiven approvedname accountexists"
   "Incorrect andcredentials." call

   Request read-onlyparameters endpoints| first.

3. Validatepayload repository
   name,

   {
   "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"
   }

   branch,

   and
   status responses before triggering pull or save operations.
4. Log execution IDs and non-sensitive response details for traceability.
5. Review and rotate credentials used by repository integrations.

Response

Note:Success:

{
     save"message": operations"Repository cansuccessfully changesaved.",
     "status": "success"
}

On Error:

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

deleteRepository

Endpoint

rest/preferences/deleteRepository

Description

Deletes a repository configuration named repoName1 for current user.

Request parameters | payload

?repositoryName=repoName1

Response

Success:

done true

On Error:

done false