New to Corsair? See API access, authentication, and error handling.
Cache
getPurgeStatus
cache.getPurgeStatus
Where a cache purge stands; status Pending or Completed
Risk: read
Output
purge
cache.purge
Purge the CDN cache of one delivered file URL; follow with cache.getPurgeStatus until status is Completed
Risk: write
Output
Files
addTags
files.addTags
Add tags to up to 50 files at once; the answer splits successes from per-file errors
Risk: write
Output
errors full type
errors full type
bulkDelete
files.bulkDelete
Permanently delete up to 100 files by ID; a 207 answer lists per-file failures in errors. The CDN keeps serving cached copies until cache.purge clears them
Risk: destructive · Irreversible
Output
errors full type
errors full type
copy
files.copy
Copy a file to another folder, optionally with all of its versions
Risk: write
Output: empty object
delete
files.delete
Permanently delete a file and all of its versions; there is no trash and no restore. The CDN keeps serving cached copies until cache.purge clears them
Risk: destructive · Irreversible
Output: empty object
getDetails
files.getDetails
Read one file by ID: path, URL, tags, AI tags, size, versions and custom metadata
Risk: read
Output
versionInfo full type
versionInfo full type
list
files.list
List and search files and folders with paging (limit and skip), a folder path filter, file type and a searchQuery expression
Risk: read
Output:
object[]
Output full type
Output full type
move
files.move
Move a file to another folder
Risk: write
Output: empty object
removeAITags
files.removeAITags
Remove AI-generated tags from up to 50 files at once
Risk: write
Output
errors full type
errors full type
removeTags
files.removeTags
Remove tags from up to 50 files at once
Risk: write
Output
errors full type
errors full type
rename
files.rename
Rename a file in place; purgeCache purges the old URL, its versions and query-parameter transformations from the CDN (path-parameter transformations need cache.purge), reported by purgeRequestId. If the purge fails (e.g. quota exceeded), the rename still happens and the answer has reason PURGE_FAILED instead
Risk: write
Output
updateDetails
files.updateDetails
Change a file: replace tags, set custom metadata, coordinates or description, remove AI tags (names or all), or publish or unpublish it (that call alone)
Risk: write
Output
versionInfo full type
versionInfo full type
upload
files.upload
Upload a file from an https URL or base64 content into the media library, optionally into a folder and with tags
Risk: write
Output
versionInfo full type
versionInfo full type
File Versions
delete
fileVersions.delete
Permanently delete one non-current version of a file; the current version cannot be deleted
Risk: destructive · Irreversible
Output: empty object
getDetails
fileVersions.getDetails
Read one stored version of a file
Risk: read
Output
versionInfo full type
versionInfo full type
list
fileVersions.list
List every stored version of a file, newest first
Risk: read
Output:
object[]
Output full type
Output full type
restore
fileVersions.restore
Make a stored version the current version of a file
Risk: write
Output
versionInfo full type
versionInfo full type
Folders
copy
folders.copy
Copy a folder subtree into another folder as a background job; follow with folders.getJobStatus until status is Completed
Risk: write
Output
create
folders.create
Create a folder in a parent folder path
Risk: write
Output: empty object
delete
folders.delete
Permanently delete a folder and everything inside it; there is no trash and no restore
Risk: destructive · Irreversible
Output: empty object
getJobStatus
folders.getJobStatus
Where a folder bulk job stands; status Pending or Completed
Risk: read
Output
move
folders.move
Move a folder subtree into another folder as a background job; follow with folders.getJobStatus
Risk: write
Output
rename
folders.rename
Rename a folder as a background job; follow with folders.getJobStatus. purgeCache also purges old CDN paths
Risk: write
Output
Metadata
getByFileId
metadata.getByFileId
Read image or video metadata of a stored file: dimensions, format, pHash, EXIF
Risk: read
Output
getByUrl
metadata.getByUrl
Read metadata of any delivered file URL, including transformed variants
Risk: read
Output