Complete File Upload

POST 
/api/inspect/v1/file/upload/complete

Mark a file as uploaded after using the presigned URL.

This endpoint is used to finalize the file upload process when uploading via a presigned URL. After successfully uploading the file to cloud storage, you must call this endpoint to mark the file as successfully uploaded. This step is necessary for the system to recognize the file and process it appropriately. Without calling this endpoint, the file will remain in an incomplete state and may not be available for further operations.

This endpoint should be used in combination with the File Upload - Presigned URL endpoint.

Request

application/json

Body

required

fileID uuidrequired

The unique identifier (UUID) of the file that was uploaded using the presigned URL. This parameter is used to mark the file as successfully uploaded, allowing the system to recognize it as complete.

assetID uuidrequired

The unique identifier (UUID) of the asset to which the uploaded file belongs. This parameter ensures that the file is correctly linked to the asset in the system for future operations or retrieval.

Responses

204

204 No Content. The file upload has been successfully marked as complete. No content is returned in the response, indicating that the file is now ready for further processing or retrieval.

400

400 Bad Request. The request is invalid. This may occur if required parameters are missing or invalid. Ensure that all required parameters are included and valid.

application/json

Schema

Schema

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

Example (from schema)

{
  "errorDescription": "permission denied",
  "error": "Forbidden"
}

401

401 Unauthorized. Authentication is required and was not provided or is invalid. Ensure that the correct credentials or tokens are included in the request.

application/json

Schema

Schema

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

Example (from schema)

{
  "errorDescription": "permission denied",
  "error": "Forbidden"
}

403

403 Forbidden. The client does not have permission to perform this action. This might happen if the client lacks the necessary privileges to interact with the specified entity.

application/json

Schema

Schema

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

Example (from schema)

{
  "errorDescription": "permission denied",
  "error": "Forbidden"
}

404

404 Not Found. The specified entity does not exist. Verify that the reference given is correct and that the entity is available.

application/json

Schema

Schema

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

Example (from schema)

{
  "errorDescription": "permission denied",
  "error": "Forbidden"
}

500

500 Internal Server Error. An error occurred on the server while processing the request. Retry the operation or contact support if the issue persists.

application/json

Schema

Schema

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

Example (from schema)

{
  "errorDescription": "permission denied",
  "error": "Forbidden"
}

Loading...