Error on linux when importing an API with no changes.

[jschutte27]

APIM-CLI version

1.14.11

API-Management version

7.7.0.20240830

Bug description

When running apim.sh to import an api in linux that does not have changes the response code is and error (1) which is failing our deploy job. This works fine on windows.

Steps to reproduce

Import an API twice in a row on linux.

Relevant log output

Windows output:
Run C:\actions-runner\_work\it-axway-automation\it-axway-automation\./\src\deploy.ps1  -ConfigPath "C:\actions-runner\_work\it-axway-automation\it-axway-automation/testfiles/test-api-config.json"  -ApimPath "apim.bat"  -ApiDefinitionPath "https://petstore.swagger.io/v2/swagger.json"  -AxwayHost devwebapi.domain.com  -AxwayUser devbuildservice  -AxwayPassword '***'  -OverrideBasePath 0
Run /opt/actions-runner/_work/it-axway-automation/it-axway-automation/./\src\deploy.ps1  -ConfigPath "/opt/actions-runner/_work/it-axway-automation/it-axway-automation/testfiles/test-api-config.json"  -ApimPath "apim.sh"  -ApiDefinitionPath "https://petstore.swagger.io/v2/swagger.json"  -AxwayHost devwebapi.domain.com  -AxwayUser devbuildservice  -AxwayPassword '***'  -OverrideBasePath 0
2025-06-12 10:56:37,824 [APIManagerCLI] INFO : API-Manager CLI: 1.14.11
2025-06-12 10:56:37,839 [APIManagerCLI] INFO : Module: API - I M P O R T  (1.14.11)
2025-06-12 10:56:37,839 [CoreParameters] INFO : Retrying unexpected API-Manager REST-API responses with a delay of 3000 milliseconds.
2025-06-12 10:56:38,860 [APIManagerOrganizationAdapter] WARN : Using OrgAdmin only to load all organizations.
2025-06-12 10:56:38,969 [APIManagerAdapter] INFO : Successfully connected to API-Manager (7.7.20240830) on: https://devwebapi.domain.com:8075
2025-06-12 10:56:39,313 [APISpecificationFactory] INFO : Detected: Swagger 2.0 specification. 
2025-06-12 10:56:39,657 [APIImportApp] INFO : Lookup actual API based on Path: /sample/api/v1  
2025-06-12 10:56:39,922 [APIManagerAPIAdapter] INFO : Loading application quotas for 1 subscribed applications.
2025-06-12 10:56:40,094 [APIImportApp] INFO : You may enable debug to get more details. See: https://github.com/Axway-API-Management-Plus/apim-cli/wiki/9.1.-Enable-Debug
2025-06-12 10:56:40,094 [APIImportApp] WARN : No changes detected between Import- and API-Manager-API: 'Test Deploy Petstore API' (d28a1215-95ec-4348-a825-9bcc038badc6)
"No changes detected. Existing with RC: 0"



Linux output:

Run /opt/actions-runner/_work/it-axway-automation/it-axway-automation/./\src\deploy.ps1  -ConfigPath "/opt/actions-runner/_work/it-axway-automation/it-axway-automation/testfiles/test-api-config.json"  -ApimPath "apim.sh"  -ApiDefinitionPath "https://petstore.swagger.io/v2/swagger.json"  -AxwayHost devwebapi.domain.com  -AxwayUser devbuildservice  -AxwayPassword '***'  -OverrideBasePath 0
2025-06-12 15:55:51,927 [APIManagerCLI] INFO : API-Manager CLI: 1.14.11
2025-06-12 15:55:51,928 [APIManagerCLI] INFO : Module: API - I M P O R T  (1.14.11)
2025-06-12 15:55:51,935 [CoreParameters] INFO : Retrying unexpected API-Manager REST-API responses with a delay of 3000 milliseconds.
2025-06-12 15:55:52,494 [APIManagerOrganizationAdapter] WARN : Using OrgAdmin only to load all organizations.
2025-06-12 15:55:52,585 [APIManagerAdapter] INFO : Successfully connected to API-Manager (7.7.20240830) on: https://devwebapi.domain.com:8075
2025-06-12 15:55:52,862 [APISpecificationFactory] INFO : Detected: Swagger 2.0 specification. 
2025-06-12 15:55:53,060 [APIImportApp] INFO : Lookup actual API based on Path: /sample/api/v1  
2025-06-12 15:55:53,278 [APIManagerAPIAdapter] INFO : Loading application quotas for 1 subscribed applications.
2025-06-12 15:55:53,402 [APIImportApp] INFO : You may enable debug to get more details. See: https://github.com/Axway-API-Management-Plus/apim-cli/wiki/9.1.-Enable-Debug
2025-06-12 15:55:53,403 [APIImportApp] WARN : No changes detected between Import- and API-Manager-API: 'Test Deploy Petstore API' (d28a1215-95ec-4348-a825-9bcc038badc6)

Error: Process completed with exit code 1.



deploy.ps1 contains:
$ArgumentList = @("api","import","-c", $outputFilePath, "-a", $ApiDefinitionPath, "-h", $AxwayHost, "-u",  $AxwayUser, "-p", $AxwayPassword, "-force", "-retryDelay", "3000") # "-forceUpdate",

if ($OverrideBasePath)
{
  $ArgumentList += "-overrideSpecBasePath"
}

& $ApimPath $ArgumentList 
exit $LASTEXITCODE

[jschutte27]

another log without the powershell script from linux gives an exit code 10:

apim.sh api import -config ${backupfolder}/api-config-edited.json --apidefinition "https://petstore.swagger.io/v2/swagger.json" -h devwebapi.domain.com -u devbuildservice -p '***' -force -retryDelay 3000
2025-06-13 12:23:54,201 [APIManagerCLI] INFO : API-Manager CLI: 1.14.11
2025-06-13 12:23:54,203 [APIManagerCLI] INFO : Module: API - E X P O R T / U T I L S  (1.14.11)
2025-06-13 12:23:55,341 [APIManagerOrganizationAdapter] WARN : Using OrgAdmin only to load all organizations.
2025-06-13 12:23:55,450 [APIManagerAdapter] INFO : Successfully connected to API-Manager (7.7.20240830) on: https://devwebapi.domain.com:8075
2025-06-13 12:23:55,[78](https://github.com/domain-corp/it-axway-automation/actions/runs/15634452143/job/44046072279#step:4:83)1 [APIManagerAPIAdapter] INFO : Loading application quotas for 1 subscribed applications.
2025-06-13 12:23:56,030 [APIExportApp] INFO : 1 API(s) selected.
2025-06-13 12:23:56,030 [JsonAPIExporter] INFO : Exporting API and configuration as JSON format
2025-06-13 12:23:56,074 [ExportHelper] INFO : Successfully exported API: Test Deploy Petstore API into folder: /home/docker/actions-runner/_work/it-axway-automation/it-axway-automation/sample-api-v1
2025-06-13 12:23:56,754 [APIManagerCLI] INFO : API-Manager CLI: 1.14.11
2025-06-13 12:23:56,756 [APIManagerCLI] INFO : Module: API - I M P O R T  (1.14.11)
2025-06-13 12:23:56,762 [CoreParameters] INFO : Retrying unexpected API-Manager REST-API responses with a delay of 3000 milliseconds.
2025-06-13 12:23:57,371 [APIManagerOrganizationAdapter] WARN : Using OrgAdmin only to load all organizations.
2025-06-13 12:23:57,453 [APIManagerAdapter] INFO : Successfully connected to API-Manager (7.7.20240830) on: https://devwebapi.domain.com:8075
2025-06-13 12:23:57,729 [APISpecificationFactory] INFO : Detected: Swagger 2.0 specification. 
2025-06-13 12:23:57,917 [APIImportConfigAdapter] INFO : Handling configured client-applications.
2025-06-13 12:23:57,969 [APIImportConfigAdapter] INFO : Application exists : jjs91[79](https://github.com/domain-corp/it-axway-automation/actions/runs/15634452143/job/44046072279#step:4:84) (null)]
2025-06-13 12:23:57,987 [APIImportApp] INFO : Lookup actual API based on Path: /sample/api/v1  
2025-06-13 12:23:58,188 [APIManagerAPIAdapter] INFO : Loading application quotas for 1 subscribed applications.
2025-06-13 12:23:58,318 [APIImportApp] INFO : You may enable debug to get more details. See: https://github.com/Axway-API-Management-Plus/apim-cli/wiki/9.1.-Enable-Debug
2025-06-13 12:23:58,318 [APIImportApp] WARN : No changes detected between Import- and API-Manager-API: 'Test Deploy Petstore API' (3e23e5ff-86[81](https://github.com/domain-corp/it-axway-automation/actions/runs/15634452143/job/44046072279#step:4:86)-4de9-b6a4-686ea27214b7)

Error: Process completed with exit code 10.

[rathnapandi]

Hi @jschutte27

It is a expected Behavior. Please use error code mapping parameter.

Return-Code Mapping
The Return-Code-Mapping feature is useful for controlling in which situations your pipeline should and should not fail. For example, it might be acceptable when a configured application for an API is missing. In this case, the pipeline should not fail. In contrast, you may want the pipeline to fail when a configured organization is missing. This should be up to customer requirements.

With return code mapping, you can convert the original error code to a different error code.
For example, by default the CLI returns with: 10, when the API has No-Change. This is desirable in some situations, but not when running it as part of the pipeline where you need a return-code 0. You can set the returnCodeMapping parameter either in the environment property file or as a parameter to the executable. With given the example above: 10:0 the return-code 10 is mapped into 0. See the example environment properties file.

[jschutte27]

@rathnapandi Thanks for the information. I will give it a try.