Skip to content

System

system-related endpoints

SystemMixin

Bases: BasePFSenseAPIClient

system calls

Source code in pfsense_api_client/system.py 
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
class SystemMixin(BasePFSenseAPIClient):
    """ system calls """
    def get_system_api_error(self) -> APIResponse:
        """gets the list of error codes

        https://github.com/jaredhendrickson13/pfsense-api#2-read-system-api-error-library
        """
        url = "/api/v1/system/api/error"
        return self.call_api(url)


    def get_system_api_version(self) -> APIResponse:
        """Read the current API version and locate available version updates.

        https://github.com/jaredhendrickson13/pfsense-api#3-read-system-api-version
        """
        url = "/api/v1/system/api/version"
        method = "GET"
        return self.call_api_dict(url, method)


    def update_system_api_configuration(
        self,
        readonly: Optional[bool] = None,
        **kwargs: Dict[str, Any],
    ) -> requests.Response:
        """Update the API configuration.

        https://github.com/jaredhendrickson13/pfsense-api#3-read-system-api-version
        """
        url = "/api/v1/system/api"
        method = "PUT"

        class APIConfiguration(pydantic.BaseModel):
            """API Config options"""

            enable: Optional[bool]
            persist: Optional[bool]
            readonly: bool
            allow_options: Optional[bool]
            available_interfaces: Optional[List[str]]
            authmode: Optional[str]
            jwt_exp: Optional[int]
            keyhash: Optional[str]
            keybytes: Optional[int]
            custom_headers: Optional[List[str]]
            hasync: Optional[bool]
            hasync_hosts: Optional[List[str]]
            hasync_username: Optional[str]
            hasync_password: Optional[str]

        payload = APIConfiguration(readonly=readonly, **kwargs)

        return self.call(url, method, payload=payload.dict())


    def get_system_api_configuration(
        self, **filterargs: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-system-api-configuration"""
        url = "/api/v1/system/api"
        return self.call(url, payload=filterargs)


    def get_system_api_error_library(
        self, **filterargs: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-read-system-api-error-library"""
        url = "/api/v1/system/api/error"
        return self.call(url, payload=filterargs)


    def delete_system_arp_table(
        self, **args: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-delete-system-arp-table"""
        url = "/api/v1/system/arp"
        method = "DELETE"
        return self.call(url=url, method=method, payload=args)


    def get_system_arp_table(
        self, **filterargs: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-read-system-arp-table"""
        url = "/api/v1/system/arp"
        return self.call(url, payload=filterargs)


    def create_system_ca(
        self, **args: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-system-ca"""
        url = "/api/v1/system/ca"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def delete_system_ca(
        self, **args: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-delete-system-ca"""
        url = "/api/v1/system/ca"
        method = "DELETE"
        return self.call(url=url, method=method, payload=args)


    def get_system_cas(
        self, **filterargs: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-read-system-cas"""
        url = "/api/v1/system/ca"
        return self.call(url, payload=filterargs)


    def create_system_certificates(
        self, **args: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-system-certificates"""
        url = "/api/v1/system/certificate"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def delete_system_certificates(
        self, **args: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-delete-system-certificates"""
        url = "/api/v1/system/certificate"
        method = "DELETE"
        return self.call(url=url, method=method, payload=args)


    def get_system_certificates(
        self, **filterargs: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-read-system-certificates"""
        url = "/api/v1/system/certificate"
        return self.call(url, payload=filterargs)


    def get_system_configuration(
        self, **filterargs: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-system-configuration"""
        url = "/api/v1/system/config"
        return self.call(url, payload=filterargs)


    def update_system_configuration(
        self, **args: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-update-system-configuration"""
        url = "/api/v1/system/config"
        method = "PUT"
        return self.call(url=url, method=method, payload=args)


    def update_console_settings(
        self, **args: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-update-console-settings"""
        url = "/api/v1/system/console"
        method = "PUT"
        return self.call(url=url, method=method, payload=args)


    def get_system_dns(
        self, **filterargs: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-system-dns"""
        url = "/api/v1/system/dns"
        return self.call(url, payload=filterargs)


    def update_system_dns(
        self, **args: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-update-system-dns"""
        url = "/api/v1/system/dns"
        method = "PUT"
        return self.call(url=url, method=method, payload=args)


    def create_system_dns_server(
        self, **args: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-system-dns-server"""
        url = "/api/v1/system/dns/server"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def delete_system_dns_server(
        self, **args: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-delete-system-dns-server"""
        url = "/api/v1/system/dns/server"
        method = "DELETE"
        return self.call(url=url, method=method, payload=args)


    def halt_system(
        self, **args: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-halt-system"""
        url = "/api/v1/system/halt"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def get_system_hostname(
        self, **filterargs: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-system-hostname"""
        url = "/api/v1/system/hostname"
        return self.call(url, payload=filterargs)


    def update_system_hostname(
        self, **args: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-update-system-hostname"""
        url = "/api/v1/system/hostname"
        method = "PUT"
        return self.call(url=url, method=method, payload=args)


    def get_system_email_notification_settings(
        self, **filterargs: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-system-email-notification-settings"""
        url = "/api/v1/system/notifications/email"
        return self.call(url, payload=filterargs)


    def update_system_email_notification_settings(
        self, **args: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-update-system-email-notification-settings"""
        url = "/api/v1/system/notifications/email"
        method = "PUT"
        return self.call(url=url, method=method, payload=args)


    def create_system_reboot(
        self, **args: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-system-reboot"""
        url = "/api/v1/system/reboot"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def get_system_tables(
        self, **filterargs: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-system-tables"""
        url = "/api/v1/system/table"
        return self.call(url, payload=filterargs)


    def create_system_tunables(
        self, **args: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-system-tunables"""
        url = "/api/v1/system/tunable"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def delete_system_tunables(
        self, **args: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-delete-system-tunables"""
        url = "/api/v1/system/tunable"
        method = "DELETE"
        return self.call(url=url, method=method, payload=args)


    def get_system_tunables(
        self, **filterargs: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-read-system-tunables"""
        url = "/api/v1/system/tunable"
        return self.call(url, payload=filterargs)


    def update_system_tunables(
        self, **args: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-update-system-tunables"""
        url = "/api/v1/system/tunable"
        method = "PUT"
        return self.call(url=url, method=method, payload=args)


    def get_system_version(
        self, **filterargs: Dict[str, Any]
    ) -> requests.Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-system-version"""
        url = "/api/v1/system/version"
        return self.call(url, payload=filterargs)

create_system_ca(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-system-ca

Source code in pfsense_api_client/system.py 
104
105
106
107
108
109
110
def create_system_ca(
    self, **args: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-system-ca"""
    url = "/api/v1/system/ca"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

create_system_certificates(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-system-certificates

Source code in pfsense_api_client/system.py 
130
131
132
133
134
135
136
def create_system_certificates(
    self, **args: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-system-certificates"""
    url = "/api/v1/system/certificate"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

create_system_dns_server(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-system-dns-server

Source code in pfsense_api_client/system.py 
199
200
201
202
203
204
205
def create_system_dns_server(
    self, **args: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-system-dns-server"""
    url = "/api/v1/system/dns/server"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

create_system_reboot(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-system-reboot

Source code in pfsense_api_client/system.py 
260
261
262
263
264
265
266
def create_system_reboot(
    self, **args: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-system-reboot"""
    url = "/api/v1/system/reboot"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

create_system_tunables(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-system-tunables

Source code in pfsense_api_client/system.py 
277
278
279
280
281
282
283
def create_system_tunables(
    self, **args: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-system-tunables"""
    url = "/api/v1/system/tunable"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

delete_system_arp_table(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-delete-system-arp-table

Source code in pfsense_api_client/system.py 
87
88
89
90
91
92
93
def delete_system_arp_table(
    self, **args: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-delete-system-arp-table"""
    url = "/api/v1/system/arp"
    method = "DELETE"
    return self.call(url=url, method=method, payload=args)

delete_system_ca(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-delete-system-ca

Source code in pfsense_api_client/system.py 
113
114
115
116
117
118
119
def delete_system_ca(
    self, **args: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-delete-system-ca"""
    url = "/api/v1/system/ca"
    method = "DELETE"
    return self.call(url=url, method=method, payload=args)

delete_system_certificates(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-delete-system-certificates

Source code in pfsense_api_client/system.py 
139
140
141
142
143
144
145
def delete_system_certificates(
    self, **args: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-delete-system-certificates"""
    url = "/api/v1/system/certificate"
    method = "DELETE"
    return self.call(url=url, method=method, payload=args)

delete_system_dns_server(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-delete-system-dns-server

Source code in pfsense_api_client/system.py 
208
209
210
211
212
213
214
def delete_system_dns_server(
    self, **args: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-delete-system-dns-server"""
    url = "/api/v1/system/dns/server"
    method = "DELETE"
    return self.call(url=url, method=method, payload=args)

delete_system_tunables(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-delete-system-tunables

Source code in pfsense_api_client/system.py 
286
287
288
289
290
291
292
def delete_system_tunables(
    self, **args: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-delete-system-tunables"""
    url = "/api/v1/system/tunable"
    method = "DELETE"
    return self.call(url=url, method=method, payload=args)

get_system_api_configuration(**filterargs)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-system-api-configuration

Source code in pfsense_api_client/system.py 
71
72
73
74
75
76
def get_system_api_configuration(
    self, **filterargs: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-system-api-configuration"""
    url = "/api/v1/system/api"
    return self.call(url, payload=filterargs)

get_system_api_error()

gets the list of error codes

https://github.com/jaredhendrickson13/pfsense-api#2-read-system-api-error-library

Source code in pfsense_api_client/system.py 
17
18
19
20
21
22
23
def get_system_api_error(self) -> APIResponse:
    """gets the list of error codes

    https://github.com/jaredhendrickson13/pfsense-api#2-read-system-api-error-library
    """
    url = "/api/v1/system/api/error"
    return self.call_api(url)

get_system_api_error_library(**filterargs)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-read-system-api-error-library

Source code in pfsense_api_client/system.py 
79
80
81
82
83
84
def get_system_api_error_library(
    self, **filterargs: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-read-system-api-error-library"""
    url = "/api/v1/system/api/error"
    return self.call(url, payload=filterargs)

get_system_api_version()

Read the current API version and locate available version updates.

https://github.com/jaredhendrickson13/pfsense-api#3-read-system-api-version

Source code in pfsense_api_client/system.py 
26
27
28
29
30
31
32
33
def get_system_api_version(self) -> APIResponse:
    """Read the current API version and locate available version updates.

    https://github.com/jaredhendrickson13/pfsense-api#3-read-system-api-version
    """
    url = "/api/v1/system/api/version"
    method = "GET"
    return self.call_api_dict(url, method)

get_system_arp_table(**filterargs)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-read-system-arp-table

Source code in pfsense_api_client/system.py 
 96
 97
 98
 99
100
101
def get_system_arp_table(
    self, **filterargs: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-read-system-arp-table"""
    url = "/api/v1/system/arp"
    return self.call(url, payload=filterargs)

get_system_cas(**filterargs)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-read-system-cas

Source code in pfsense_api_client/system.py 
122
123
124
125
126
127
def get_system_cas(
    self, **filterargs: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-read-system-cas"""
    url = "/api/v1/system/ca"
    return self.call(url, payload=filterargs)

get_system_certificates(**filterargs)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-read-system-certificates

Source code in pfsense_api_client/system.py 
148
149
150
151
152
153
def get_system_certificates(
    self, **filterargs: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-read-system-certificates"""
    url = "/api/v1/system/certificate"
    return self.call(url, payload=filterargs)

get_system_configuration(**filterargs)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-system-configuration

Source code in pfsense_api_client/system.py 
156
157
158
159
160
161
def get_system_configuration(
    self, **filterargs: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-system-configuration"""
    url = "/api/v1/system/config"
    return self.call(url, payload=filterargs)

get_system_dns(**filterargs)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-system-dns

Source code in pfsense_api_client/system.py 
182
183
184
185
186
187
def get_system_dns(
    self, **filterargs: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-system-dns"""
    url = "/api/v1/system/dns"
    return self.call(url, payload=filterargs)

get_system_email_notification_settings(**filterargs)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-system-email-notification-settings

Source code in pfsense_api_client/system.py 
243
244
245
246
247
248
def get_system_email_notification_settings(
    self, **filterargs: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-system-email-notification-settings"""
    url = "/api/v1/system/notifications/email"
    return self.call(url, payload=filterargs)

get_system_hostname(**filterargs)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-system-hostname

Source code in pfsense_api_client/system.py 
226
227
228
229
230
231
def get_system_hostname(
    self, **filterargs: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-system-hostname"""
    url = "/api/v1/system/hostname"
    return self.call(url, payload=filterargs)

get_system_tables(**filterargs)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-system-tables

Source code in pfsense_api_client/system.py 
269
270
271
272
273
274
def get_system_tables(
    self, **filterargs: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-system-tables"""
    url = "/api/v1/system/table"
    return self.call(url, payload=filterargs)

get_system_tunables(**filterargs)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-read-system-tunables

Source code in pfsense_api_client/system.py 
295
296
297
298
299
300
def get_system_tunables(
    self, **filterargs: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-read-system-tunables"""
    url = "/api/v1/system/tunable"
    return self.call(url, payload=filterargs)

get_system_version(**filterargs)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-system-version

Source code in pfsense_api_client/system.py 
312
313
314
315
316
317
def get_system_version(
    self, **filterargs: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-system-version"""
    url = "/api/v1/system/version"
    return self.call(url, payload=filterargs)

halt_system(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-halt-system

Source code in pfsense_api_client/system.py 
217
218
219
220
221
222
223
def halt_system(
    self, **args: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-halt-system"""
    url = "/api/v1/system/halt"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

update_console_settings(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-update-console-settings

Source code in pfsense_api_client/system.py 
173
174
175
176
177
178
179
def update_console_settings(
    self, **args: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-update-console-settings"""
    url = "/api/v1/system/console"
    method = "PUT"
    return self.call(url=url, method=method, payload=args)

update_system_api_configuration(readonly=None, **kwargs)

Update the API configuration.

https://github.com/jaredhendrickson13/pfsense-api#3-read-system-api-version

Source code in pfsense_api_client/system.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
def update_system_api_configuration(
    self,
    readonly: Optional[bool] = None,
    **kwargs: Dict[str, Any],
) -> requests.Response:
    """Update the API configuration.

    https://github.com/jaredhendrickson13/pfsense-api#3-read-system-api-version
    """
    url = "/api/v1/system/api"
    method = "PUT"

    class APIConfiguration(pydantic.BaseModel):
        """API Config options"""

        enable: Optional[bool]
        persist: Optional[bool]
        readonly: bool
        allow_options: Optional[bool]
        available_interfaces: Optional[List[str]]
        authmode: Optional[str]
        jwt_exp: Optional[int]
        keyhash: Optional[str]
        keybytes: Optional[int]
        custom_headers: Optional[List[str]]
        hasync: Optional[bool]
        hasync_hosts: Optional[List[str]]
        hasync_username: Optional[str]
        hasync_password: Optional[str]

    payload = APIConfiguration(readonly=readonly, **kwargs)

    return self.call(url, method, payload=payload.dict())

update_system_configuration(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-update-system-configuration

Source code in pfsense_api_client/system.py 
164
165
166
167
168
169
170
def update_system_configuration(
    self, **args: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-update-system-configuration"""
    url = "/api/v1/system/config"
    method = "PUT"
    return self.call(url=url, method=method, payload=args)

update_system_dns(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-update-system-dns

Source code in pfsense_api_client/system.py 
190
191
192
193
194
195
196
def update_system_dns(
    self, **args: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-update-system-dns"""
    url = "/api/v1/system/dns"
    method = "PUT"
    return self.call(url=url, method=method, payload=args)

update_system_email_notification_settings(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-update-system-email-notification-settings

Source code in pfsense_api_client/system.py 
251
252
253
254
255
256
257
def update_system_email_notification_settings(
    self, **args: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-update-system-email-notification-settings"""
    url = "/api/v1/system/notifications/email"
    method = "PUT"
    return self.call(url=url, method=method, payload=args)

update_system_hostname(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-update-system-hostname

Source code in pfsense_api_client/system.py 
234
235
236
237
238
239
240
def update_system_hostname(
    self, **args: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-update-system-hostname"""
    url = "/api/v1/system/hostname"
    method = "PUT"
    return self.call(url=url, method=method, payload=args)

update_system_tunables(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-update-system-tunables

Source code in pfsense_api_client/system.py 
303
304
305
306
307
308
309
def update_system_tunables(
    self, **args: Dict[str, Any]
) -> requests.Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-update-system-tunables"""
    url = "/api/v1/system/tunable"
    method = "PUT"
    return self.call(url=url, method=method, payload=args)