Navigate

Kaltura API DocumentationuploadToken.list

List upload token by filter with pager support.

When using a user session the service will be restricted to users objects only.

Try it out
post https://www.kaltura.com/api_v3/service/uploadtoken/action/list

Request Parameters

body:object
SchemaExample
object
filter:object:KalturaUploadTokenFilter
orderBy:string
Enum: CREATED_AT_ASC [+createdAt], CREATED_AT_DESC [-createdAt]
KalturaUploadTokenFilter must also match all of:
object:KalturaUploadTokenBaseFilter
pager:object:KalturaFilterPager
The KalturaFilterPager object enables paging management to be applied upon service list actions.


KalturaFilterPager must also match all of:
object:KalturaPager

Response

Success

SchemaExample
object:KalturaUploadTokenListResponse
objects:array[object:KalturaUploadToken]
object:KalturaUploadToken
attachedObjectId:string
readOnly


The id of the object this token is attached to.


attachedObjectType:string
readOnly


The type of the object this token is attached to.


autoFinalize:integer
Enum: NULL_VALUE [-1], FALSE_VALUE [0], TRUE_VALUE [1]
insertOnly


Enum Type: KalturaNullableBoolean


autoFinalize - Should the upload be finalized once the file size on disk matches the file size reported when adding the upload token.


createdAt:integer
readOnly


Creation date as Unix timestamp (In seconds)


fileName:string
insertOnly


Name of the file for the upload token, can be empty when the upload token is created and will be updated internally after the file is uploaded


fileSize:number
insertOnly


File size in bytes, can be empty when the upload token is created and will be updated internally after the file is uploaded


id:string
readOnly


Upload token unique ID


partnerId:integer
readOnly


Partner ID of the upload token


status:integer
Enum: PENDING [0], PARTIAL_UPLOAD [1], FULL_UPLOAD [2], CLOSED [3], TIMED_OUT [4], DELETED [5]
readOnly


Enum Type: KalturaUploadTokenStatus


Status of the upload token


updatedAt:integer
readOnly


Last update date as Unix timestamp (In seconds)


uploadUrl:string
readOnly


Upload url - to explicitly determine to which domain to address the uploadToken->upload call


uploadedFileSize:number
readOnly


Uploaded file size in bytes, can be used to identify how many bytes were uploaded before resuming


userId:string
readOnly


User id for the upload token


KalturaUploadTokenListResponse must also match all of:
object:KalturaListResponse