openapi: 3.2.0 info: version: '1' title: MOVEit Transfer REST Logs API x-swagger-net-version: 8.5.28.001 x-logo: url: images/MOVEitLogo.svg description: '**Release 2025.1**, **version 17.01** *MOVEit securely collects, stores, manages, and distributes information within organizations, between businesses, and more...* > **Important!** The REST API is an optionally licensed feature that runs at the MOVEit Transfer Server.' servers: - url: https://127.0.0.1 tags: - name: Logs paths: /api/v1/logs/{Id}: get: tags: - Logs summary: Get log's info operationId: GETapi/v1/logs/{Id}-1.0 parameters: - name: Id in: path description: Log ID required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LogDetailsModel' text/json: schema: $ref: '#/components/schemas/LogDetailsModel' application/problem+json: schema: $ref: '#/components/schemas/LogDetailsModel' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorModel' text/json: schema: $ref: '#/components/schemas/ErrorModel' application/problem+json: schema: $ref: '#/components/schemas/ErrorModel' '500': description: Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorModel' text/json: schema: $ref: '#/components/schemas/ErrorModel' application/problem+json: schema: $ref: '#/components/schemas/ErrorModel' security: - Authorization: [] /api/v1/logs: get: tags: - Logs summary: Get list of logs current user can view operationId: GETapi/v1/logs?Page={Page}&PerPage={PerPage}&SortField={SortField}&SortDirection={SortDirection}&StartDateTime={StartDateTime}&EndDateTime={EndDateTime}&Action={Action}&UserNameContains={UserNameContains}&UserId={UserId}&FileIdContains={FileIdContains}&FileNameContains={FileNameContains}&SizeComparison={SizeComparison}&Size={Size}&FolderId={FolderId}&FolderPathContains={FolderPathContains}&IpContains={IpContains}&AgentBrandContains={AgentBrandContains}&SuccessFailure={SuccessFailure}&SuppressSigns={SuppressSigns}&SuppressEmailNotes={SuppressEmailNotes}&SuppressLogViews={SuppressLogViews}-1.0 parameters: - name: page in: query description: Page number to display required: false schema: type: integer format: int32 - name: perPage in: query description: Items per page in result collection; Default is 25 required: false schema: type: integer format: int32 - name: sortField in: query description: Name of field to sort the results by. (logtime, action, username, userrealname, targetname, filename, fileid, folderpath, xfersize, duration, rate, ipaddress, agentbrand, resilnode); Default is logtime. required: false schema: type: string - name: sortDirection in: query description: Sort direction; Default is ascending. required: false schema: type: string - name: startDateTime in: query description: Start Date/Time (MM-dd-yy, MM-dd-yyyy, MM-dd-yyyy HH:mm:ss, MM/dd/yyyy, MM/dd/yyyy HH:mm etc.) required: false schema: type: string - name: endDateTime in: query description: End Date/Time (MM-dd-yy, MM-dd-yyyy, MM-dd-yyyy HH:mm:ss, MM/dd/yyyy, MM/dd/yyyy HH:mm etc.) required: false schema: type: string - name: action in: query description: Name of action to filter by required: false schema: type: string enum: - None - FileTransfer - Administration - Upload - Download - UserMaintenance - ContentScanning default: 0 - name: userNameContains in: query description: Show usernames like this (For admin users only) required: false schema: type: string - name: userId in: query description: Show only this user id (For admin users only. For non admin users current user ID is used.) required: false schema: type: string - name: fileIdContains in: query description: Show file IDs like this required: false schema: type: string - name: fileNameContains in: query description: Show file names like this required: false schema: type: string - name: sizeComparison in: query description: File size comparison selection required: false schema: type: string enum: - None - LargerOrEqual - SmallerOrEqual default: 0 - name: size in: query description: File size (in KB) required: false schema: type: string - name: folderId in: query description: Show only this Folder id required: false schema: type: string - name: folderPathContains in: query description: Show folder path like this required: false schema: type: string - name: ipContains in: query description: Show IP address like this required: false schema: type: string - name: agentBrandContains in: query description: Show Agent Brand like this required: false schema: type: string - name: successFailure in: query description: Filter Success/Errors required: false schema: type: string enum: - None - Success - Error default: 0 - name: suppressSigns in: query description: Suppress sign on/ sign off. Default is true required: false schema: type: boolean - name: suppressEmailNotes in: query description: Suppress email notes. Default is true required: false schema: type: boolean - name: suppressLogViews in: query description: Suppress log views. Default is true required: false schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedModelOfSimpleLogModel' text/json: schema: $ref: '#/components/schemas/PagedModelOfSimpleLogModel' application/problem+json: schema: $ref: '#/components/schemas/PagedModelOfSimpleLogModel' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorModel' text/json: schema: $ref: '#/components/schemas/ErrorModel' application/problem+json: schema: $ref: '#/components/schemas/ErrorModel' '500': description: Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorModel' text/json: schema: $ref: '#/components/schemas/ErrorModel' application/problem+json: schema: $ref: '#/components/schemas/ErrorModel' security: - Authorization: [] components: schemas: Certificate: properties: type: type: string subject: type: string cn: type: string issuer: type: string issuerCN: type: string thumbprint: type: string validAfter: type: string validUntil: type: string subjectAlternativeName: type: string principalName: type: string keyType: type: string keyBits: type: integer format: int32 fingerprints: additionalProperties: type: string type: object xml: name: Certificate type: object PagedModelOfSimpleLogModel: description: Represents paged response object with proper navigations properties: items: description: Items on the given page items: $ref: '#/components/schemas/SimpleLogModel' readOnly: true xml: name: SimpleLogModel wrapped: true type: array paging: $ref: '#/components/schemas/PagingInfoModel' description: Paging data for given response sorting: description: Sorting data for given response items: $ref: '#/components/schemas/SortFieldDto' xml: name: SortFieldDto wrapped: true type: array xml: name: PagedModel`1 type: object LogDetailsModel: description: Log Model that fully describes log entity properties: dlpMetadata: description: DLP metadata type: string webFarmNode: description: Web farm node type: integer format: int32 certificate: $ref: '#/components/schemas/Certificate' description: Certificate contentScannerName: description: Content scanner name type: string interfaceType: description: Interface type type: string parm1: description: Parameter 1 type: string parm2: description: Parameter 2 type: string parm3: description: Parameter 3 type: string parm4: description: Parameter 4 type: string id: description: Log id type: integer format: int64 logTime: description: Log date and time type: string uploadNotes: description: Upload comment type: string fileName: description: Filename type: string fileID: description: File Id type: string folderID: description: Folder id type: integer format: int32 folderPath: description: Folder path type: string virtualFolderID: description: Virtual folder id type: integer format: int32 virtualFolderPath: description: Virtual folder path type: string rate: description: Rate type: number format: double duration: description: Duration type: number format: double transferSize: description: Transfer size type: integer format: int64 username: description: User id type: string userLoginName: description: User login name type: string userFullName: description: User fullname type: string targetID: description: Target id type: string targetName: description: Target name type: string ipAddress: description: IP Address type: string action: description: Log Action type: string agentBrand: description: Client brand type: string agentVersion: description: Client version type: string message: description: Log message type: string errorCode: description: Error code type: integer format: int32 orgID: description: Organization id type: integer format: int32 xml: name: LogDetailsModel type: object SimpleLogModel: description: Log Model that describes main log info properties: id: description: Log id type: integer format: int64 logTime: description: Log date and time type: string uploadNotes: description: Upload comment type: string fileName: description: Filename type: string fileID: description: File Id type: string folderID: description: Folder id type: integer format: int32 folderPath: description: Folder path type: string virtualFolderID: description: Virtual folder id type: integer format: int32 virtualFolderPath: description: Virtual folder path type: string rate: description: Rate type: number format: double duration: description: Duration type: number format: double transferSize: description: Transfer size type: integer format: int64 username: description: User id type: string userLoginName: description: User login name type: string userFullName: description: User fullname type: string targetID: description: Target id type: string targetName: description: Target name type: string ipAddress: description: IP Address type: string action: description: Log Action type: string agentBrand: description: Client brand type: string agentVersion: description: Client version type: string message: description: Log message type: string errorCode: description: Error code type: integer format: int32 orgID: description: Organization id type: integer format: int32 xml: name: SimpleLogModel type: object SortFieldDto: properties: sortField: type: string sortDirection: type: string enum: - asc - desc xml: name: SortFieldDto type: object PagingInfoModel: description: Information about paging for collection response properties: page: description: Current page in collection type: integer format: int32 perPage: description: Items per page type: integer format: int32 totalItems: description: Total items in collection type: integer format: int64 totalPages: description: Total number of pages in collection readOnly: true type: integer format: int32 xml: name: PagingInfoModel type: object ErrorModel: description: Represents an error returned by API properties: detail: description: An explanation specific to this occurrence of the error type: string errorCode: description: An error number, defined by the application type: integer format: int32 default: 0 title: description: Short summary of the error type type: string xml: name: ErrorModel type: object securitySchemes: Authorization: type: apiKey description: 'Transfer API token. Put token value obtained using following format: "Bearer {token}"' name: Authorization in: header