Logon Hours
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
401
Unauthorized
application/json; api-version=1.0
404
Not Found
application/json; api-version=1.0
get
GET /api/LogonHours HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-07T20:09:15.372Z",
"timeLastMod": "2025-07-07T20:09:15.372Z",
"name": "text",
"siteId": 1,
"description": "text",
"enabled": true,
"order": 1,
"criteria": {
"securityPrincipals": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"account": "text",
"type": [
"1 = User",
"2 = Group",
"3 = ForeignSecurityPrincipal",
"4 = Computer"
],
"sid": "text"
}
]
},
"gateways": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"gatewayIP": "text"
}
]
},
"oSs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"allowedOSes": {
"chrome": true,
"android": true,
"webClient": true,
"iOS": true,
"linux": true,
"mac": true,
"wyse": true,
"windows": true
}
},
"iPs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"allowedIPs": {
"iPv4s": [
{
"from": "text",
"to": "text"
}
],
"iPv6s": [
{
"from": "text",
"to": "text"
}
]
}
},
"hardwareIDs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"hardwareID": "text"
}
]
},
"devices": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"client": "text"
}
]
},
"themes": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"ids": [
1
]
}
},
"permittedHourPlan": {
"sunday": [
"1 = h00",
"2 = h01",
"4 = h02",
"8 = h03",
"16 = h04",
"32 = h05",
"64 = h06",
"128 = h07",
"256 = h08",
"512 = h09",
"1024 = h10",
"2048 = h11",
"4096 = h12",
"8192 = h13",
"16384 = h14",
"32768 = h15",
"65536 = h16",
"131072 = h17",
"262144 = h18",
"524288 = h19",
"1048576 = h20",
"2097152 = h21",
"4194304 = h22",
"8388608 = h23"
],
"monday": [
"1 = h00",
"2 = h01",
"4 = h02",
"8 = h03",
"16 = h04",
"32 = h05",
"64 = h06",
"128 = h07",
"256 = h08",
"512 = h09",
"1024 = h10",
"2048 = h11",
"4096 = h12",
"8192 = h13",
"16384 = h14",
"32768 = h15",
"65536 = h16",
"131072 = h17",
"262144 = h18",
"524288 = h19",
"1048576 = h20",
"2097152 = h21",
"4194304 = h22",
"8388608 = h23"
],
"tuesday": [
"1 = h00",
"2 = h01",
"4 = h02",
"8 = h03",
"16 = h04",
"32 = h05",
"64 = h06",
"128 = h07",
"256 = h08",
"512 = h09",
"1024 = h10",
"2048 = h11",
"4096 = h12",
"8192 = h13",
"16384 = h14",
"32768 = h15",
"65536 = h16",
"131072 = h17",
"262144 = h18",
"524288 = h19",
"1048576 = h20",
"2097152 = h21",
"4194304 = h22",
"8388608 = h23"
],
"wednesday": [
"1 = h00",
"2 = h01",
"4 = h02",
"8 = h03",
"16 = h04",
"32 = h05",
"64 = h06",
"128 = h07",
"256 = h08",
"512 = h09",
"1024 = h10",
"2048 = h11",
"4096 = h12",
"8192 = h13",
"16384 = h14",
"32768 = h15",
"65536 = h16",
"131072 = h17",
"262144 = h18",
"524288 = h19",
"1048576 = h20",
"2097152 = h21",
"4194304 = h22",
"8388608 = h23"
],
"thursday": [
"1 = h00",
"2 = h01",
"4 = h02",
"8 = h03",
"16 = h04",
"32 = h05",
"64 = h06",
"128 = h07",
"256 = h08",
"512 = h09",
"1024 = h10",
"2048 = h11",
"4096 = h12",
"8192 = h13",
"16384 = h14",
"32768 = h15",
"65536 = h16",
"131072 = h17",
"262144 = h18",
"524288 = h19",
"1048576 = h20",
"2097152 = h21",
"4194304 = h22",
"8388608 = h23"
],
"friday": [
"1 = h00",
"2 = h01",
"4 = h02",
"8 = h03",
"16 = h04",
"32 = h05",
"64 = h06",
"128 = h07",
"256 = h08",
"512 = h09",
"1024 = h10",
"2048 = h11",
"4096 = h12",
"8192 = h13",
"16384 = h14",
"32768 = h15",
"65536 = h16",
"131072 = h17",
"262144 = h18",
"524288 = h19",
"1048576 = h20",
"2097152 = h21",
"4194304 = h22",
"8388608 = h23"
],
"saturday": [
"1 = h00",
"2 = h01",
"4 = h02",
"8 = h03",
"16 = h04",
"32 = h05",
"64 = h06",
"128 = h07",
"256 = h08",
"512 = h09",
"1024 = h10",
"2048 = h11",
"4096 = h12",
"8192 = h13",
"16384 = h14",
"32768 = h15",
"65536 = h16",
"131072 = h17",
"262144 = h18",
"524288 = h19",
"1048576 = h20",
"2097152 = h21",
"4194304 = h22",
"8388608 = h23"
]
}
}
]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
201
Created
application/json; api-version=1.0
401
Unauthorized
application/json; api-version=1.0
409
Conflict
application/json; api-version=1.0
post
POST /api/LogonHours HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 51
{
"name": "text",
"enabled": true,
"description": "text"
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-07T20:09:15.372Z",
"timeLastMod": "2025-07-07T20:09:15.372Z",
"name": "text",
"siteId": 1,
"description": "text",
"enabled": true,
"order": 1,
"criteria": {
"securityPrincipals": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"account": "text",
"type": [
"1 = User",
"2 = Group",
"3 = ForeignSecurityPrincipal",
"4 = Computer"
],
"sid": "text"
}
]
},
"gateways": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"gatewayIP": "text"
}
]
},
"oSs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"allowedOSes": {
"chrome": true,
"android": true,
"webClient": true,
"iOS": true,
"linux": true,
"mac": true,
"wyse": true,
"windows": true
}
},
"iPs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"allowedIPs": {
"iPv4s": [
{
"from": "text",
"to": "text"
}
],
"iPv6s": [
{
"from": "text",
"to": "text"
}
]
}
},
"hardwareIDs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"hardwareID": "text"
}
]
},
"devices": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"client": "text"
}
]
},
"themes": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"ids": [
1
]
}
},
"permittedHourPlan": {
"sunday": [
"1 = h00",
"2 = h01",
"4 = h02",
"8 = h03",
"16 = h04",
"32 = h05",
"64 = h06",
"128 = h07",
"256 = h08",
"512 = h09",
"1024 = h10",
"2048 = h11",
"4096 = h12",
"8192 = h13",
"16384 = h14",
"32768 = h15",
"65536 = h16",
"131072 = h17",
"262144 = h18",
"524288 = h19",
"1048576 = h20",
"2097152 = h21",
"4194304 = h22",
"8388608 = h23"
],
"monday": [
"1 = h00",
"2 = h01",
"4 = h02",
"8 = h03",
"16 = h04",
"32 = h05",
"64 = h06",
"128 = h07",
"256 = h08",
"512 = h09",
"1024 = h10",
"2048 = h11",
"4096 = h12",
"8192 = h13",
"16384 = h14",
"32768 = h15",
"65536 = h16",
"131072 = h17",
"262144 = h18",
"524288 = h19",
"1048576 = h20",
"2097152 = h21",
"4194304 = h22",
"8388608 = h23"
],
"tuesday": [
"1 = h00",
"2 = h01",
"4 = h02",
"8 = h03",
"16 = h04",
"32 = h05",
"64 = h06",
"128 = h07",
"256 = h08",
"512 = h09",
"1024 = h10",
"2048 = h11",
"4096 = h12",
"8192 = h13",
"16384 = h14",
"32768 = h15",
"65536 = h16",
"131072 = h17",
"262144 = h18",
"524288 = h19",
"1048576 = h20",
"2097152 = h21",
"4194304 = h22",
"8388608 = h23"
],
"wednesday": [
"1 = h00",
"2 = h01",
"4 = h02",
"8 = h03",
"16 = h04",
"32 = h05",
"64 = h06",
"128 = h07",
"256 = h08",
"512 = h09",
"1024 = h10",
"2048 = h11",
"4096 = h12",
"8192 = h13",
"16384 = h14",
"32768 = h15",
"65536 = h16",
"131072 = h17",
"262144 = h18",
"524288 = h19",
"1048576 = h20",
"2097152 = h21",
"4194304 = h22",
"8388608 = h23"
],
"thursday": [
"1 = h00",
"2 = h01",
"4 = h02",
"8 = h03",
"16 = h04",
"32 = h05",
"64 = h06",
"128 = h07",
"256 = h08",
"512 = h09",
"1024 = h10",
"2048 = h11",
"4096 = h12",
"8192 = h13",
"16384 = h14",
"32768 = h15",
"65536 = h16",
"131072 = h17",
"262144 = h18",
"524288 = h19",
"1048576 = h20",
"2097152 = h21",
"4194304 = h22",
"8388608 = h23"
],
"friday": [
"1 = h00",
"2 = h01",
"4 = h02",
"8 = h03",
"16 = h04",
"32 = h05",
"64 = h06",
"128 = h07",
"256 = h08",
"512 = h09",
"1024 = h10",
"2048 = h11",
"4096 = h12",
"8192 = h13",
"16384 = h14",
"32768 = h15",
"65536 = h16",
"131072 = h17",
"262144 = h18",
"524288 = h19",
"1048576 = h20",
"2097152 = h21",
"4194304 = h22",
"8388608 = h23"
],
"saturday": [
"1 = h00",
"2 = h01",
"4 = h02",
"8 = h03",
"16 = h04",
"32 = h05",
"64 = h06",
"128 = h07",
"256 = h08",
"512 = h09",
"1024 = h10",
"2048 = h11",
"4096 = h12",
"8192 = h13",
"16384 = h14",
"32768 = h15",
"65536 = h16",
"131072 = h17",
"262144 = h18",
"524288 = h19",
"1048576 = h20",
"2097152 = h21",
"4194304 = h22",
"8388608 = h23"
]
}
}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
401
Unauthorized
application/json; api-version=1.0
404
Not Found
application/json; api-version=1.0
get
GET /api/LogonHours/{id} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-07T20:09:15.372Z",
"timeLastMod": "2025-07-07T20:09:15.372Z",
"name": "text",
"siteId": 1,
"description": "text",
"enabled": true,
"order": 1,
"criteria": {
"securityPrincipals": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"account": "text",
"type": [
"1 = User",
"2 = Group",
"3 = ForeignSecurityPrincipal",
"4 = Computer"
],
"sid": "text"
}
]
},
"gateways": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"gatewayIP": "text"
}
]
},
"oSs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"allowedOSes": {
"chrome": true,
"android": true,
"webClient": true,
"iOS": true,
"linux": true,
"mac": true,
"wyse": true,
"windows": true
}
},
"iPs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"allowedIPs": {
"iPv4s": [
{
"from": "text",
"to": "text"
}
],
"iPv6s": [
{
"from": "text",
"to": "text"
}
]
}
},
"hardwareIDs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"hardwareID": "text"
}
]
},
"devices": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"client": "text"
}
]
},
"themes": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"ids": [
1
]
}
},
"permittedHourPlan": {
"sunday": [
"1 = h00",
"2 = h01",
"4 = h02",
"8 = h03",
"16 = h04",
"32 = h05",
"64 = h06",
"128 = h07",
"256 = h08",
"512 = h09",
"1024 = h10",
"2048 = h11",
"4096 = h12",
"8192 = h13",
"16384 = h14",
"32768 = h15",
"65536 = h16",
"131072 = h17",
"262144 = h18",
"524288 = h19",
"1048576 = h20",
"2097152 = h21",
"4194304 = h22",
"8388608 = h23"
],
"monday": [
"1 = h00",
"2 = h01",
"4 = h02",
"8 = h03",
"16 = h04",
"32 = h05",
"64 = h06",
"128 = h07",
"256 = h08",
"512 = h09",
"1024 = h10",
"2048 = h11",
"4096 = h12",
"8192 = h13",
"16384 = h14",
"32768 = h15",
"65536 = h16",
"131072 = h17",
"262144 = h18",
"524288 = h19",
"1048576 = h20",
"2097152 = h21",
"4194304 = h22",
"8388608 = h23"
],
"tuesday": [
"1 = h00",
"2 = h01",
"4 = h02",
"8 = h03",
"16 = h04",
"32 = h05",
"64 = h06",
"128 = h07",
"256 = h08",
"512 = h09",
"1024 = h10",
"2048 = h11",
"4096 = h12",
"8192 = h13",
"16384 = h14",
"32768 = h15",
"65536 = h16",
"131072 = h17",
"262144 = h18",
"524288 = h19",
"1048576 = h20",
"2097152 = h21",
"4194304 = h22",
"8388608 = h23"
],
"wednesday": [
"1 = h00",
"2 = h01",
"4 = h02",
"8 = h03",
"16 = h04",
"32 = h05",
"64 = h06",
"128 = h07",
"256 = h08",
"512 = h09",
"1024 = h10",
"2048 = h11",
"4096 = h12",
"8192 = h13",
"16384 = h14",
"32768 = h15",
"65536 = h16",
"131072 = h17",
"262144 = h18",
"524288 = h19",
"1048576 = h20",
"2097152 = h21",
"4194304 = h22",
"8388608 = h23"
],
"thursday": [
"1 = h00",
"2 = h01",
"4 = h02",
"8 = h03",
"16 = h04",
"32 = h05",
"64 = h06",
"128 = h07",
"256 = h08",
"512 = h09",
"1024 = h10",
"2048 = h11",
"4096 = h12",
"8192 = h13",
"16384 = h14",
"32768 = h15",
"65536 = h16",
"131072 = h17",
"262144 = h18",
"524288 = h19",
"1048576 = h20",
"2097152 = h21",
"4194304 = h22",
"8388608 = h23"
],
"friday": [
"1 = h00",
"2 = h01",
"4 = h02",
"8 = h03",
"16 = h04",
"32 = h05",
"64 = h06",
"128 = h07",
"256 = h08",
"512 = h09",
"1024 = h10",
"2048 = h11",
"4096 = h12",
"8192 = h13",
"16384 = h14",
"32768 = h15",
"65536 = h16",
"131072 = h17",
"262144 = h18",
"524288 = h19",
"1048576 = h20",
"2097152 = h21",
"4194304 = h22",
"8388608 = h23"
],
"saturday": [
"1 = h00",
"2 = h01",
"4 = h02",
"8 = h03",
"16 = h04",
"32 = h05",
"64 = h06",
"128 = h07",
"256 = h08",
"512 = h09",
"1024 = h10",
"2048 = h11",
"4096 = h12",
"8192 = h13",
"16384 = h14",
"32768 = h15",
"65536 = h16",
"131072 = h17",
"262144 = h18",
"524288 = h19",
"1048576 = h20",
"2097152 = h21",
"4194304 = h22",
"8388608 = h23"
]
}
}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
204
No Content
401
Unauthorized
application/json; api-version=1.0
404
Not Found
application/json; api-version=1.0
put
PUT /api/LogonHours/{id} HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 51
{
"enabled": true,
"name": "text",
"description": "text"
}No content
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
204
No Content
401
Unauthorized
application/json; api-version=1.0
404
Not Found
application/json; api-version=1.0
delete
DELETE /api/LogonHours/{id} HTTP/1.1
Host:
Accept: */*
No content
Was this helpful?