Cancel an upload session that has not become ready.

POST

/v1/uploads/{id}/cancel

const url = 'https://api.share2.us/v1/uploads/example/cancel';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.share2.us/v1/uploads/example/cancel \
  --header 'Authorization: Bearer <token>'

Authorizations

Parameters

Path Parameters

required

string

Responses

200

Upload canceled.

application/json

object

required

string

share_id

required

string

status

required

string

Allowed values: created uploading completed canceled failed

expected_size_bytes

required

integer format: int64

expected_sha256

string

/^[a-f0-9]{64}$/

created_at

required

string format: date-time

Example

{
  "status": "created"
}

default

Standard error envelope.

application/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "quota_exceeded"
  }
}