Class ServerService

Index

Constructors

constructor

Methods

getServerConfiguration getServerInformation getServerStatus getServerTroubleshooting getServerUpgradeCheck

Constructors

constructor

new ServerService(): ServerService
Returns ServerService

Methods

`Static`getServerConfiguration

getServerConfiguration<ThrowOnError extends boolean = true>(
    options?: Options<GetServerConfigurationData, ThrowOnError>,
): RequestResult<
    GetServerConfigurationResponses,
    unknown,
    ThrowOnError,
    "fields",
>
Gets the server configuration.

Gets the configuration settings for servers.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetServerConfigurationData, ThrowOnError>
Returns RequestResult<GetServerConfigurationResponses, unknown, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:6662

`Static`getServerInformation

getServerInformation<ThrowOnError extends boolean = true>(
    options?: Options<GetServerInformationData, ThrowOnError>,
): RequestResult<
    GetServerInformationResponses,
    GetServerInformationErrors,
    ThrowOnError,
    "fields",
>
Gets server information.

Gets detailed information about the server environment and configuration.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetServerInformationData, ThrowOnError>
Returns RequestResult<
    GetServerInformationResponses,
    GetServerInformationErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:6674

`Static`getServerStatus

getServerStatus<ThrowOnError extends boolean = true>(
    options?: Options<GetServerStatusData, ThrowOnError>,
): RequestResult<
    GetServerStatusResponses,
    GetServerStatusErrors,
    ThrowOnError,
    "fields",
>
Gets server status.

Gets the current operational status of the Umbraco server.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetServerStatusData, ThrowOnError>
Returns RequestResult<
    GetServerStatusResponses,
    GetServerStatusErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:6692

`Static`getServerTroubleshooting

getServerTroubleshooting<ThrowOnError extends boolean = true>(
    options?: Options<GetServerTroubleshootingData, ThrowOnError>,
): RequestResult<
    GetServerTroubleshootingResponses,
    GetServerTroubleshootingErrors,
    ThrowOnError,
    "fields",
>
Gets server troubleshooting information.

Gets troubleshooting information and diagnostics for the server.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetServerTroubleshootingData, ThrowOnError>
Returns RequestResult<
    GetServerTroubleshootingResponses,
    GetServerTroubleshootingErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:6704

`Static`getServerUpgradeCheck

getServerUpgradeCheck<ThrowOnError extends boolean = true>(
    options?: Options<GetServerUpgradeCheckData, ThrowOnError>,
): RequestResult<
    GetServerUpgradeCheckResponses,
    GetServerUpgradeCheckErrors,
    ThrowOnError,
    "fields",
>
Checks for available upgrades.

Checks if there are any available upgrades for the Umbraco installation.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetServerUpgradeCheckData, ThrowOnError>
Returns RequestResult<
    GetServerUpgradeCheckResponses,
    GetServerUpgradeCheckErrors,
    ThrowOnError,
    "fields",
>
Deprecated
- Defined in src/packages/core/backend-api/sdk.gen.ts:6724

Class ServerService

Index

Constructors

Methods

Constructors

constructor

Returns ServerService

Methods

`Static`getServerConfiguration

Type Parameters

Parameters

Returns RequestResult<GetServerConfigurationResponses, unknown, ThrowOnError, "fields">

`Static`getServerInformation

Type Parameters

Parameters

Returns RequestResult<
    GetServerInformationResponses,
    GetServerInformationErrors,
    ThrowOnError,
    "fields",
>

`Static`getServerStatus

Type Parameters

Parameters

Returns RequestResult<
    GetServerStatusResponses,
    GetServerStatusErrors,
    ThrowOnError,
    "fields",
>

`Static`getServerTroubleshooting

Type Parameters

Parameters

Returns RequestResult<
    GetServerTroubleshootingResponses,
    GetServerTroubleshootingErrors,
    ThrowOnError,
    "fields",
>

`Static`getServerUpgradeCheck

Type Parameters

Parameters

Returns RequestResult<
    GetServerUpgradeCheckResponses,
    GetServerUpgradeCheckErrors,
    ThrowOnError,
    "fields",
>

Deprecated

Settings

On This Page

Class ServerService

Index

Constructors

Methods

Constructors

constructor

Returns ServerService

Methods

StaticgetServerConfiguration

Type Parameters

Parameters

Returns RequestResult<GetServerConfigurationResponses, unknown, ThrowOnError, "fields">

StaticgetServerInformation

Type Parameters

Parameters

Returns RequestResult< GetServerInformationResponses, GetServerInformationErrors, ThrowOnError, "fields",>

StaticgetServerStatus

Type Parameters

Parameters

Returns RequestResult< GetServerStatusResponses, GetServerStatusErrors, ThrowOnError, "fields",>

StaticgetServerTroubleshooting

Type Parameters

Parameters

Returns RequestResult< GetServerTroubleshootingResponses, GetServerTroubleshootingErrors, ThrowOnError, "fields",>

StaticgetServerUpgradeCheck

Type Parameters

Parameters

Returns RequestResult< GetServerUpgradeCheckResponses, GetServerUpgradeCheckErrors, ThrowOnError, "fields",>

Deprecated

Settings

On This Page

`Static`getServerConfiguration

`Static`getServerInformation

Returns RequestResult<
GetServerInformationResponses,
GetServerInformationErrors,
ThrowOnError,
"fields",
>

`Static`getServerStatus

Returns RequestResult<
GetServerStatusResponses,
GetServerStatusErrors,
ThrowOnError,
"fields",
>

`Static`getServerTroubleshooting

Returns RequestResult<
GetServerTroubleshootingResponses,
GetServerTroubleshootingErrors,
ThrowOnError,
"fields",
>

`Static`getServerUpgradeCheck

Returns RequestResult<
GetServerUpgradeCheckResponses,
GetServerUpgradeCheckErrors,
ThrowOnError,
"fields",
>