File Upload REST API Guide

Upload file in a single part

post

Uploads a file in a single part to Fiddler.

Authorizations

Body

filestring · binaryrequired

Binary file object

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v3/files/upload' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=binary'

200

400

500

200

{
  "api_version": "2.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "filename": "text",
    "type": "CSV",
    "status": "INITIATED",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[e-mail]"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[e-mail]"
    },
    "created_at": "2025-03-28T22:05:49.358Z",
    "updated_at": "2025-03-28T22:05:49.358Z"
  }
}

File uploaded successfully.

Initiate multi-part upload

post

Initiates a multi-part upload process for a large file to Fiddler.

Authorizations

Body

filenamestringrequired

Name of the file uploaded by the user.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v3/files/multipart-init' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "filename": "text"
  }'

200

400

500

200

{
  "api_version": "2.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "filename": "text",
    "type": "CSV",
    "status": "INITIATED",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[e-mail]"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[e-mail]"
    },
    "created_at": "2025-03-28T22:05:49.358Z",
    "updated_at": "2025-03-28T22:05:49.358Z"
  }
}

Multi-part upload request initiated successfully.

Upload file a part of the file

post

Uploads a part of a large file to Fiddler as part of a multi-part upload process.

Authorizations

Body

filestring · binaryrequired

Binary file object

file_idstring · uuidrequired

Unique file identifier

part_numberinteger · min: 1 · max: 1000required

Part number of the file in multi-part upload process.

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v3/files/multipart-upload' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=binary' \
  --form 'file_id=123e4567-e89b-12d3-a456-426614174000' \
  --form 'part_number=1'

200

400

404

500

200

{
  "api_version": "2.0",
  "kind": "NORMAL",
  "data": {
    "part_id": 1
  }
}

File part uploaded successfully.

Complete multi-part upload

post

Completes the multi-part upload process for a large file in Fiddler.

Authorizations

Body

file_idstring · uuidoptional

Unique file identifier

partsobject[]optional

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v3/files/multipart-complete' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "file_id": "123e4567-e89b-12d3-a456-426614174000",
    "parts": [
      {
        "id": "text",
        "number": 1
      }
    ]
  }'

200

400

404

500

200

{
  "api_version": "2.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "filename": "text",
    "type": "CSV",
    "status": "INITIATED",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[e-mail]"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "[e-mail]"
    },
    "created_at": "2025-03-28T22:05:49.358Z",
    "updated_at": "2025-03-28T22:05:49.358Z"
  }
}

Multi-part upload request completed successfully.