Skip to main content
POST
/
api
/
v1
/
samples
/
confirm_upload
POST samples confirm_upload
curl --request POST \
  --url https://app.onecodex.com/api/v1/samples/confirm_upload \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "sample_id": "<string>",
  "upload_type": "standard"
}
'
{
  "message": "<string>",
  "sample": {
    "type": "<unknown>",
    "pattern": "<unknown>"
  },
  "success": true
}
Confirms the upload. See Starting an Upload for more details on the full upload workflow.

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
sample_id
string
required
​
upload_type
enum<string>
default:standard
Available options:
standard

Response

200 - application/json

Successful operation

​
message
string

A detailed success or failure message.

​
sample
object

A reference to the $uri of the uploaded sample.

​
success
boolean

Whether the upload was successful.