Upload a file with the REST API

Upload a file with the REST API. Follow a controlled workflow, verify the result, and avoid changing the wrong workspace or item.

Last reviewed

Upload a file with the REST API is safest when you verify the account, workspace and target before committing the action. This guide uses a small controlled example so you can confirm each state.

Before you start

  • Open the REST API upload workflow in the current released Dosya client.
  • Confirm the active account and workspace, then identify an upload-scoped key and small test file.
  • Use non-confidential test data and record the current state before changing it.
  • Keep passwords, API keys, recovery keys and private links out of screenshots and support messages.

Steps: upload a file with the REST API

  1. Open the REST API upload workflow and confirm the active workspace.
  2. Select an upload-scoped key and small test file and check its name or identifying details.
  3. Create the upload, transfer bytes and complete it.
  4. Read the confirmation, warning or progress state before leaving the screen.
  5. Verify that the returned file appears in the target folder.
  6. Refresh or reopen the view once to confirm the result persisted.
Dosya API-key permission selector showing the access granted to an integration.
Use a disposable key with the narrowest scope and a non-production workspace. Open full-size screenshot.

Expected result

The workflow completes for the controlled test and the returned file appears in the target folder. The result remains visible after a refresh or reconnect.

Limits and important details

  • Available controls depend on the current client version, plan, role and workspace policy.
  • Actions may be blocked by folder locks, hidden-item rules, storage limits or a restricted credential.
  • For destructive or access-changing actions, test with disposable data before applying the workflow to important files.

Troubleshooting

The expected control is missing. Return to the REST API upload workflow, confirm the active workspace and check that your role permits the action.

The operation is rejected. Read the exact message and check access, locks, quota, network state and client version before retrying.

The result is unclear. Repeat with one small test item, then contact support with the time, client version and a nonsecret error message.

Was this helpful?

Loading helpfulness results…

Voting saves a necessary ballot cookie for up to 180 days so you can change your answer.

Questions and replies

Ask about the steps in this guide. Questions are reviewed before publication.

Keep account details, credentials and private files out of public questions. Use private support for those.

Loading questions…

    Sign in to your Dosya account to ask a question.