Server

Endpoints

Server

Source code in matrix_admin_sdk/endpoints/v1/server.py

class Server(Endpoint):
    async def get_version(self) -> ServerVersionModel:
        """
        This API returns the running Synapse version and the Python version on
        which Synapse is being run. This is useful when a Synapse instance is
        behind a proxy that does not forward the 'Server' header (which also
        contains Synapse version information).

        Returns:

        """
        url = self.url("server_version")
        result = await self.request(RequestMethods.GET, url)
        res: ServerVersionModel = ServerVersionModel.from_dict(result)
        return res

get_version(self) async

This API returns the running Synapse version and the Python version on which Synapse is being run. This is useful when a Synapse instance is behind a proxy that does not forward the 'Server' header (which also contains Synapse version information).

Source code in matrix_admin_sdk/endpoints/v1/server.py

async def get_version(self) -> ServerVersionModel:
    """
    This API returns the running Synapse version and the Python version on
    which Synapse is being run. This is useful when a Synapse instance is
    behind a proxy that does not forward the 'Server' header (which also
    contains Synapse version information).

    Returns:

    """
    url = self.url("server_version")
    result = await self.request(RequestMethods.GET, url)
    res: ServerVersionModel = ServerVersionModel.from_dict(result)
    return res

Models

ServerVersionModel

Server version model.

Attributes:

Name	Type	Description
server_version	str	Synapse version
python_version	str	Python version

Source code in matrix_admin_sdk/models/v1/server.py

class ServerVersionModel(BaseModel):
    """
    Server version model.
    Attributes:
        server_version (str): Synapse version
        python_version (str): Python version
    """

    server_version: str
    python_version: str