Abort an upload only while it is created, releasing its quota reservation immediately. Terminal sessions are unchanged and return their terminal outcome. A finishing session returns UploadNotReady.
Input
Encoding
application/jsonjobId
string
Required
No description available.
maxLength: 256 bytesminLength: 1 bytesOutput
Encoding
application/jsoncompletedJobId
string
Optional
Present only when state is completed.
failureReason
string
Optional
Present only when state is failed.
state
string
Required
No description available.
Known values:
aborted, completed, failed, expiredErrors
UploadNotFound
The job ID is unknown or aged out of retention; known terminal sessions return their outcome and are never reported as not found. UploadNotReady
A finish is in progress; check getUploadStatus and retry. Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"description": "Abort an upload only while it is created, releasing its quota reservation immediately. Terminal sessions are unchanged and return their terminal outcome. A finishing session returns UploadNotReady.",
"errors": [
{
"description": "The job ID is unknown or aged out of retention; known terminal sessions return their outcome and are never reported as not found.",
"name": "UploadNotFound"
},
{
"description": "A finish is in progress; check getUploadStatus and retry.",
"name": "UploadNotReady"
}
],
"input": {
"encoding": "application/json",
"schema": {
"properties": {
"jobId": {
"maxLength": 256,
"minLength": 1,
"type": "string"
}
},
"required": [
"jobId"
],
"type": "object"
}
},
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"completedJobId": {
"description": "Present only when state is completed.",
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"failureReason": {
"description": "Present only when state is failed.",
"maxLength": 1024,
"type": "string"
},
"state": {
"knownValues": [
"aborted",
"completed",
"failed",
"expired"
],
"maxLength": 32,
"type": "string"
}
},
"required": [
"state"
],
"type": "object"
}
},
"type": "procedure"
}