CompleteCodeBundle
Finalizes a code bundle after the client completes an OSS PUT operation. This operation validates the uploaded object and sets the code bundle status to ready. If CI metadata that triggers an automatic scan was provided during creation, a scanId is returned.
Try it now
Test
RAM authorization
Request syntax
POST /v1/projects/{projectId}/codeBundles/{codeBundleId}/complete HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| projectId |
integer |
Yes |
The project ID. |
12312 |
| codeBundleId |
integer |
Yes |
The code bundle ID. |
111 |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| byteSize |
integer |
Yes |
The declared size of the uploaded object. This value must match the OSS Content-Length. |
1 |
| contentType |
string |
Yes |
The MIME type of the stored code bundle. This is typically application/octet-stream for pre-signed PUT operations. |
application/octet-stream |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| requestId |
string |
The request ID. |
9A1F403F-0A85-5578-8B7C-55E3E9408659 |
| codeBundleId |
integer |
The code bundle ID. |
111 |
| projectId |
integer |
The project ID. |
76851f2b5bf0187fbc29e8bca4 |
| bundleVersion |
string |
The code bundle version identifier. |
1 |
| status |
string |
The code bundle status. |
ready |
| byteSize |
integer |
The object size. |
111 |
| contentType |
string |
The MIME type of the stored code bundle. This is typically application/octet-stream for pre-signed PUT operations. |
application/octet-stream |
| filename |
string |
The file name. |
test-cases.zip |
| createdAt |
string |
The time when the record was created, in RFC 3339 format. |
2026-08-27T00:53:46.774Z |
| updatedAt |
string |
The time when the record was last updated. |
2026-08-27T00:53:46.774Z |
Examples
Success response
JSON format
{
"requestId": "9A1F403F-0A85-5578-8B7C-55E3E9408659",
"codeBundleId": 111,
"projectId": 0,
"bundleVersion": "1",
"status": "ready",
"byteSize": 111,
"contentType": "application/octet-stream",
"filename": "test-cases.zip",
"createdAt": "2026-08-27T00:53:46.774Z",
"updatedAt": "2026-08-27T00:53:46.774Z"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParameter.%s | Invalid parameter:%s. | Invalid parameter:%s. |
| 400 | NotFound.%s | The resource does not exist. | The resource does not exist. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.