Skip to navigation
REST APIFile Tags

Replace file tags

Replaces the entire tag set of a file. Tags not in the new list are deleted. An empty array clears all tags.

Tags are normalized before storage (lowercased, whitespace-stripped, duplicates removed).

Calling PUT with the same set of tags (regardless of case or order) produces no write — added and deleted will both be empty.

Authentication

Authorizationstring

Every request made to https://api.uploadcare.com/ MUST be signed. HTTPS SHOULD be used with any authorization scheme.

Requests MUST contain the Authorization header defining auth-scheme and auth-param: Authorization: auth-scheme auth-param.

Every request MUST contain the Accept header identifying the REST API version: Accept: application/vnd.uploadcare-v0.7+json.

There are two available authorization schemes:

  • For production: Uploadcare, a scheme where a signature, not your Secret API Key MUST be specified. Signatures SHOULD be generated on backend.
  • For quick tests: Uploadcare.Simple, a simple scheme where your Secret API Key MUST be specified in every request's auth-param.

Path parameters

uuidstringRequiredformat: "uuid"
File UUID.

Headers

AcceptstringRequired
Version header.

Request

This endpoint expects an object.
tagslist of stringsRequired

New tag list. Must be a JSON array (not null, not a string). An empty array clears all tags.

Response

Tags replaced successfully.
tagslist of strings
Resulting tag list in storage order.
addedlist of strings

Tags present in the new set but not in the previous set (sorted alphabetically).

deletedlist of strings

Tags present in the previous set but not in the new set (sorted alphabetically).

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
406
Not Acceptable Error
415
Unsupported Media Type Error