Skip to content

Commit a668c37

Browse files
Create api-section.md
1 parent 6384456 commit a668c37

File tree

1 file changed

+79
-0
lines changed

1 file changed

+79
-0
lines changed

docs/settings/api-section.md

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
title: Enable/Disable API Sections
3+
description: Enable/Disable API Sections
4+
date: 2024-05-18
5+
---
6+
7+
# Enable/Disable (Show/Hide) API Sections
8+
[![KopiCloud_AD_API](https://img.shields.io/badge/kopiCloud_ad-v1.1+-blueviolet.svg)](https://adapi.kopicloud.com)
9+
10+
By default, all API sections are **enabled**, but you may need to disable sections for security reasons.
11+
12+
This article explains enabling or disabling some specific KopiCloud AD API sections.
13+
14+
API Section settings are managed by the file **C:\KopiCloud-AD-API\appsettings.json**.
15+
16+
This is the list of API settings that you can enable/disable:
17+
18+
- APIEnableAD
19+
- APIEnableADComputer
20+
- APIEnableADGroup
21+
- APIEnableADGroupMembership
22+
- APIEnableADUser
23+
- APIEnableDNS
24+
- APIEnableDnsA
25+
- APIEnableDnsAAAA
26+
- APIEnableDnsCNAME
27+
- APIEnableDnsZones
28+
29+
----
30+
31+
## APIEnableAD
32+
33+
The **APIEnableAD** setting manages **ALL** Active Directory sections.
34+
35+
When you enable/disable this section, you will see/hide the **AD Computer**, **AD OU**, **AD User**, **AD Group**, and **ADGroupMembership** sections.
36+
37+
Open the **appsettings.json** file located at the root of the KopiCloud AD API folder (C:\KopiCloud-AD-API).
38+
39+
> AD Sections Enabled
40+
41+
```
42+
"APIEnableAD: true"
43+
```
44+
45+
> AD Sections Disabled
46+
47+
```
48+
"APIEnableAD: false"
49+
```
50+
51+
Save the file.
52+
53+
Restart the web server using the **IISReset command** or the IIS Console.
54+
55+
----
56+
57+
## APIEnableDNS
58+
59+
The **APIEnableDNS** setting manages **ALL** DNS sections.
60+
61+
When you enable/disable this section, you will see/hide the **APIEnableDnsA**, **APIEnableDnsAAAA**, **APIEnableDnsCNAME**, and **APIEnableDnsZones** sections.
62+
63+
Open the **appsettings.json** file located at the root of the KopiCloud AD API folder (C:\KopiCloud-AD-API).
64+
65+
> AD Sections Enabled
66+
67+
```
68+
"APIEnableAD: true"
69+
```
70+
71+
> AD Sections Disabled
72+
73+
```
74+
"APIEnableAD: false"
75+
```
76+
77+
Save the file.
78+
79+
Restart the web server using the **IISReset command** or the IIS Console.

0 commit comments

Comments
 (0)