Skip to content
Select language:English

/api/v1/files/{fileId}

PUT
/api/v1/files/{fileId}
curl --request PUT \
--url 'https://example.com/api/v1/files/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?locationId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&class=evidence'
fileId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
locationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
class
string
default: photo
Allowed values: evidence photo document video

Default Response

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
sha256
required
string
bytes
required
number
mime
required
string
class
required
string
Allowed values: evidence photo document video
hasGps
required
boolean
width
required
number | null
height
required
number | null
derivativeState
required
string
Allowed values: ready pending unavailable not_applicable
thumbUrl
required
string | null
displayUrl
required
string | null
deduplicatedFrom
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
Example
{
"class": "evidence",
"derivativeState": "ready"
}

Default Response

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
sha256
required
string
bytes
required
number
mime
required
string
class
required
string
Allowed values: evidence photo document video
hasGps
required
boolean
width
required
number | null
height
required
number | null
derivativeState
required
string
Allowed values: ready pending unavailable not_applicable
thumbUrl
required
string | null
displayUrl
required
string | null
deduplicatedFrom
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
Example
{
"class": "evidence",
"derivativeState": "ready"
}