ProductsSupportPartnersDocumentation

Logon Hours

List

get

Retrieve information about one or multiple logon hours setting.

Query parameters
SiteIdinteger · int32Optional

Site ID from which to retrieve the logon hours setting (optional).

NamestringOptional

The name of the logon hours setting for which to retrieve the information. This must be the actual logon hours setting name used in the RAS connections.

Responses
200

Success

application/json; api-version=1.0
get
/api/LogonHours

Create

post

Create a new logon hours setting.

Body

Create a new logon hours property

namestring | nullableRequired

The name of the target logon hours rule. This must be the actual logon hours rule name used in the RAS Farm.

enabledbooleanOptional

Enable or disable the logon hours rule upon creation. If the parameter is omitted, the logon hours rule is initialised as disabled.

descriptionstring | nullableOptional

A user-defined logon hours rule description.

Responses
post
/api/LogonHours

Get

get

Retrieve information about a particular logon hours setting by ID.

Path parameters
idinteger · int32Required

The ID of the logon hours setting for which to retrieve the information.

Responses
200

Success

application/json; api-version=1.0
get
/api/LogonHours/{id}

Update

put

Modify properties of a logon hours setting.

Path parameters
idinteger · int32Required

The ID of the logon hours setting to modify.

Body

Update a logon hours property settings

enabledboolean | nullableOptional

Enable or disable the specified logon hours rule in a Site.

namestring | nullableOptional

The new name of the target logon hours rule.

descriptionstring | nullableOptional

A user-defined LogonHours description.

Responses
put
/api/LogonHours/{id}
No content

Delete

delete

Remove a logon hours setting from a Site.

Path parameters
idinteger · int32Required

The ID of a logon hours setting to remove from the Site.

Responses
delete
/api/LogonHours/{id}
No content
PreviousLoad BalancingNextCriteria

Was this helpful?