Get file metadata

Get file metadata returns file metadata for the current application by filename. This operation is available only after successful Initialize.

Request

Get file metadata uses packet type = 9.

{
  "type": 9,
  "id": 10,
  "filename": "client.dll"
}

Prop

Type

Response

{
  "id": 10,
  "checksum": "2f57f0f6f4f8f7df8f4f395f6efc58f3e0681c6cf8f8a53fd2f1f4d76ab4bc9e",
  "size": 1832456,
  "transfer_count": 37,
  "last_transferred_at": 1760000000,
  "status": 1
}

Prop

Type

Behavior notes

Response packet is a regular text JSON websocket frame.
checksum describes the whole stored file, not a transfer range.
This operation does not require an authorized user/license session; initialized session is enough.

Get-file-metadata statuses

Status	Constant	Returned when
`1`	`Ok`	Metadata returned successfully.
`6`	`InternalServerError`	Server failed to read metadata due to an internal error.
`300`	`FileNotFound`	File with provided `filename` does not exist for this application.
`301`	`FileInvalidName`	`filename` is shorter than 4 characters.

Connection-close cases (before/around this usecase)

Get file metadata itself returns regular JSON responses, but session can still be closed by protocol/session guards:

Close code	Error	When it happens
`4200`	`connection is not initialized`	Request was sent before successful `Initialize`.
`4201`	`rate limit hit`	Global per-session packet rate limit was exceeded.
`4302`	`invalid request body`	Packet body does not match the required schema for this operation.
`4304`	`received unsupported data`	Client sent unsupported frame type (request packets must be text JSON).