Troubleshooting
This section describes possible solutions to the issues that you might experience when using the Build Promoter API.
HTTP error codes
The Build Promoter API uses the following error codes:
Error code | Description |
---|---|
400 Bad Request | The request is incorrect. Make sure the request body follows the schema. |
401 Unauthorized | The authentication credentials are missing or invalid. Check if your access token isn't expired. |
403 Forbidden | You aren't authorized to view or modify the requested resource, or a given tenant or star system doesn't exist. Make sure that you have the required access permissions and provide the correct data. |
404 Not Found | The requested resource doesn't exist. |
409 Conflict | Either a build promotion is in progress or the quality gate status for the build is FAILED . |
502 Bad Gateway | The EnterpriseEngage application data can't be retrieved from the upstream server. |
503 Service Unavailable | Either data can't be fetched from the upstream server or the build is temporarily unavailable for promotion. |
A build can't be promoted due to validation issues
In some cases, after triggering a build promotion, you'll receive the 400 error code with the following response: The class of the target star system should be one level higher than the current star system class
.
It means that the build can't be promoted because of the issue with source and target star systems. Note that you can only promote a build to a star system class that is one level higher than the source star system class.
You can only promote a build between the following star system classes:
- From
dev
topreprod
. - From
preprod
toprod
.
To solve this issue, do the following:
- Get a list of available branches in a star system.
- Use the list of branches to check the available builds for each star system class.
- Promote a build to a star system whose class is only one level higher than the class of the source star system.
A build can't be promoted due to quality gates status
After triggering a build promotion, you might receive the 409 error code. This means one of the following:
- The build promotion is already in progress.
- A quality gate status for a given build is
FAILED
.
If you didn't promote the build, the build quality gate status might be FAILED
.
To solve this issue, ensure that required quality gate verification is successful. If the quality gate status is FAILED
, fix your build and try again.
If you want to ignore the quality gate status while promoting a given build, see Promote a build regardless of the quality gate status.
Can't get the EnterpriseEngage application list
After requesting a list of the available EnterpriseEngage applications in a star system, you might receive the 502 error code. This means that the list of the available EnterpriseEngage applications can't be retrieved from the upstream server.
To get a list of the EnterpriseEngage applications, try again later.
A build is temporarily unavailable for promotion
In some cases, after triggering a build promotion, you'll receive the 503 error code with the following response: The build is temporarily unavailable for promotion
.
It means that the recently triggered build promotion can't be finished due to an unexpected error.
To promote this build, try again later. If, after triggering another promotion of the given build, you receive the 409 error code, you'll need to wait for a moment and then trigger the promotion process again.
The build might be unavailable for promotion for about an hour.