tools/unitctl/unit-openapi/README.md
NGINX Unit is a lightweight and versatile application runtime that provides the essential components for your web application as a single open-source server: running application code, serving static assets, handling TLS and request routing.
Important: Unit's API is designed to expose any part of its configuration as an addressable endpoint. Suppose a JSON object is stored at /config/listeners/:
json { \"*:8080\": { \"pass\": \"applications/wp_emea_dev\" } }
Here, /config/listeners/_*:8080 and /config/listeners/_*:8080/pass are also endpoints. Generally, object options are addressable by their names, array items—by their indexes (/array/0/).
Note: By default, Unit is configured through a UNIX domain socket. To use this specification with OpenAPI tools interactively, start Unit with a TCP port as the control socket.
For more information, please visit https://unit.nginx.org/
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
org.openapitools.codegen.languages.RustClientCodegenPut the package under your project folder in a directory named unit-openapi and add the following to Cargo.toml under [dependencies]:
unit-openapi = { path = "./unit-openapi" }
All URIs are relative to http://localhost:8080
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AccessLogApi | delete_access_log | Delete /config/access_log | Delete the access log |
| AccessLogApi | delete_access_log_format | Delete /config/access_log/format | Delete the access log format |
| AccessLogApi | delete_access_log_path | Delete /config/access_log/path | Delete the access log path |
| AccessLogApi | get_access_log | Get /config/access_log | Retrieve the access log |
| AccessLogApi | get_access_log_format | Get /config/access_log/format | Retrieve the access log format option |
| AccessLogApi | get_access_log_path | Get /config/access_log/path | Retrieve the access log path option |
| AccessLogApi | update_access_log | Put /config/access_log | Create or overwrite the access log |
| AccessLogApi | update_access_log_format | Put /config/access_log/format | Create or overwrite the access log format |
| AccessLogApi | update_access_log_path | Put /config/access_log/path | Create or overwrite the access log path |
| ApplicationsApi | delete_application | Delete /config/applications/{appName} | Delete the application object |
| ApplicationsApi | delete_applications | Delete /config/applications | Delete the applications object |
| ApplicationsApi | get_application | Get /config/applications/{appName} | Retrieve an application object |
| ApplicationsApi | get_applications | Get /config/applications | Retrieve the applications object |
| ApplicationsApi | update_application | Put /config/applications/{appName} | Create or overwrite the application object |
| ApplicationsApi | update_applications | Put /config/applications | Overwrite the applications object |
| AppsApi | get_app_restart | Get /control/applications/{appName}/restart | Restart the {appName} application |
| CertificatesApi | get_cert_bundle | Get /certificates/{bundleName} | Retrieve the certificate bundle object |
| CertificatesApi | get_cert_bundle_chain | Get /certificates/{bundleName}/chain | Retrieve the certificate bundle chain |
| CertificatesApi | get_cert_bundle_chain_cert | Get /certificates/{bundleName}/chain/{arrayIndex} | Retrieve certificate object from the chain array |
| CertificatesApi | get_cert_bundle_chain_cert_issuer | Get /certificates/{bundleName}/chain/{arrayIndex}/issuer | Retrieve the issuer object from the certificate object |
| CertificatesApi | get_cert_bundle_chain_cert_issuer_cn | Get /certificates/{bundleName}/chain/{arrayIndex}/issuer/common_name | Retrieve the common name from the certificate issuer |
| CertificatesApi | get_cert_bundle_chain_cert_issuer_org | Get /certificates/{bundleName}/chain/{arrayIndex}/issuer/organization | Retrieve the organization name from the certificate issuer |
| CertificatesApi | get_cert_bundle_chain_cert_issuer_state | Get /certificates/{bundleName}/chain/{arrayIndex}/issuer/state_or_province | Retrieve the state or province code from the certificate issuer |
| CertificatesApi | get_cert_bundle_chain_cert_subj | Get /certificates/{bundleName}/chain/{arrayIndex}/subject | Retrieve the subject from the certificate object |
| CertificatesApi | get_cert_bundle_chain_cert_subj_alt | Get /certificates/{bundleName}/chain/{arrayIndex}/subject/alt_names/{arrayIndex2} | Retrieve an alternative name from the certificate subject |
| CertificatesApi | get_cert_bundle_chain_cert_subj_alt_array | Get /certificates/{bundleName}/chain/{arrayIndex}/subject/alt_names | Retrieve the alternative names array from the certificate subject |
| CertificatesApi | get_cert_bundle_chain_cert_subj_cn | Get /certificates/{bundleName}/chain/{arrayIndex}/subject/common_name | Retrieve the common name from the certificate subject |
| CertificatesApi | get_cert_bundle_chain_cert_subj_country | Get /certificates/{bundleName}/chain/{arrayIndex}/subject/country | Retrieve the country code from the certificate subject |
| CertificatesApi | get_cert_bundle_chain_cert_subj_org | Get /certificates/{bundleName}/chain/{arrayIndex}/subject/organization | Retrieve the organization name from the certificate subject |
| CertificatesApi | get_cert_bundle_chain_cert_subj_state | Get /certificates/{bundleName}/chain/{arrayIndex}/subject/state_or_province | Retrieve the state or province code from the certificate subject |
| CertificatesApi | get_cert_bundle_chain_cert_valid | Get /certificates/{bundleName}/chain/{arrayIndex}/validity | Retrieve the validity object from the certificate object |
| CertificatesApi | get_cert_bundle_chain_cert_valid_since | Get /certificates/{bundleName}/chain/{arrayIndex}/validity/since | Retrieve the starting time of certificate validity |
| CertificatesApi | get_cert_bundle_chain_cert_valid_until | Get /certificates/{bundleName}/chain/{arrayIndex}/validity/until | Retrieve the ending time of certificate validity |
| CertificatesApi | get_cert_bundle_chain_certissuer_country | Get /certificates/{bundleName}/chain/{arrayIndex}/issuer/country | Retrieve the country code from the certificate issuer |
| CertificatesApi | get_cert_bundle_key | Get /certificates/{bundleName}/key | Retrieve the certificate bundle key type |
| CertificatesApi | get_certs | Get /certificates | Retrieve the certificates object |
| CertificatesApi | put_cert_bundle | Put /certificates/{bundleName} | Create or overwrite the actual certificate bundle |
| ConfigApi | delete_access_log | Delete /config/access_log | Delete the access log |
| ConfigApi | delete_access_log_format | Delete /config/access_log/format | Delete the access log format |
| ConfigApi | delete_access_log_path | Delete /config/access_log/path | Delete the access log path |
| ConfigApi | delete_application | Delete /config/applications/{appName} | Delete the application object |
| ConfigApi | delete_applications | Delete /config/applications | Delete the applications object |
| ConfigApi | delete_config | Delete /config | Delete the config object |
| ConfigApi | delete_listener | Delete /config/listeners/{listenerName} | Delete a listener object |
| ConfigApi | delete_listener_forwarded_recursive | Delete /config/listeners/{listenerName}/forwarded/recursive | Delete the recursive object in a listener |
| ConfigApi | delete_listener_forwarded_source | Delete /config/listeners/{listenerName}/forwarded/source/{arrayIndex} | Delete a source array item in a listener |
| ConfigApi | delete_listener_forwarded_sources | Delete /config/listeners/{listenerName}/forwarded/source | Delete the source option in a listener |
| ConfigApi | delete_listener_forwared | Delete /config/listeners/{listenerName}/forwarded | Delete the forwarded object in a listener |
| ConfigApi | delete_listener_tls | Delete /config/listeners/{listenerName}/tls | Delete the tls object in a listener |
| ConfigApi | delete_listener_tls_certificate | Delete /config/listeners/{listenerName}/tls/certificate/{arrayIndex} | Delete a certificate array item in a listener |
| ConfigApi | delete_listener_tls_certificates | Delete /config/listeners/{listenerName}/tls/certificate | Delete the certificate option in a listener |
| ConfigApi | delete_listener_tls_conf_commands | Delete /config/listeners/{listenerName}/tls/conf_commands | Delete the conf_commands object in a listener |
| ConfigApi | delete_listener_tls_session | Delete /config/listeners/{listenerName}/tls/session | Delete the session object in a listener |
| ConfigApi | delete_listener_tls_session_ticket | Delete /config/listeners/{listenerName}/tls/session/tickets/{arrayIndex} | Delete a ticket array item in a listener |
| ConfigApi | delete_listener_tls_session_tickets | Delete /config/listeners/{listenerName}/tls/session/tickets | Delete the tickets option in a listener |
| ConfigApi | delete_listeners | Delete /config/listeners | Delete all the listeners |
| ConfigApi | delete_routes | Delete /config/routes | Delete the routes entity |
| ConfigApi | delete_settings | Delete /config/settings | Delete the settings object |
| ConfigApi | delete_settings_discard_unsafe_fields | Delete /config/settings/http/discard_unsafe_fields | Delete the discard_unsafe_fields option |
| ConfigApi | delete_settings_http | Delete /config/settings/http | Delete the http object |
| ConfigApi | delete_settings_http_body_read_timeout | Delete /config/settings/http/body_read_timeout | Delete the body_read_timeout option |
| ConfigApi | delete_settings_http_header_read_timeout | Delete /config/settings/http/header_read_timeout | Delete the header_read_timeout option |
| ConfigApi | delete_settings_http_idle_timeout | Delete /config/settings/http/idle_timeout | Delete the idle_timeout option |
| ConfigApi | delete_settings_http_max_body_size | Delete /config/settings/http/max_body_size | Delete the max_body_size option |
| ConfigApi | delete_settings_http_send_timeout | Delete /config/settings/http/send_timeout | Delete the send_timeout option |
| ConfigApi | delete_settings_http_static | Delete /config/settings/http/static | Delete the static object |
| ConfigApi | delete_settings_http_static_mime_type | Delete /config/settings/http/static/mime_types/{mimeType} | Delete the MIME type option |
| ConfigApi | delete_settings_http_static_mime_types | Delete /config/settings/http/static/mime_types | Delete the mime_types object |
| ConfigApi | delete_settings_listen_threads | Delete /config/settings/listen_threads | Delete the listen_threads option |
| ConfigApi | delete_settings_log_route | Delete /config/settings/http/log_route | Delete the log_route option |
| ConfigApi | delete_settings_server_version | Delete /config/settings/http/server_version | Delete the server_version option |
| ConfigApi | delete_settings_telemetry | Delete /config/settings/telemetry | Delete the telemetry object |
| ConfigApi | get_access_log | Get /config/access_log | Retrieve the access log |
| ConfigApi | get_access_log_format | Get /config/access_log/format | Retrieve the access log format option |
| ConfigApi | get_access_log_path | Get /config/access_log/path | Retrieve the access log path option |
| ConfigApi | get_application | Get /config/applications/{appName} | Retrieve an application object |
| ConfigApi | get_applications | Get /config/applications | Retrieve the applications object |
| ConfigApi | get_config | Get /config | Retrieve the config |
| ConfigApi | get_listener | Get /config/listeners/{listenerName} | Retrieve a listener object |
| ConfigApi | get_listener_backlog | Get /config/listeners/{listenerName}/backlog | Retrieve the backlog option in a listener |
| ConfigApi | get_listener_forwarded | Get /config/listeners/{listenerName}/forwarded | Retrieve the forwarded object in a listener |
| ConfigApi | get_listener_forwarded_client_ip | Get /config/listeners/{listenerName}/forwarded/client_ip | Retrieve the client_ip option in a listener |
| ConfigApi | get_listener_forwarded_protocol | Get /config/listeners/{listenerName}/forwarded/protocol | Retrieve the protocol option in a listener |
| ConfigApi | get_listener_forwarded_recursive | Get /config/listeners/{listenerName}/forwarded/recursive | Retrieve the recursive option in a listener |
| ConfigApi | get_listener_forwarded_source | Get /config/listeners/{listenerName}/forwarded/source/{arrayIndex} | Retrieve a source array item in a listener |
| ConfigApi | get_listener_pass | Get /config/listeners/{listenerName}/pass | Retrieve the pass option in a listener |
| ConfigApi | get_listener_tls | Get /config/listeners/{listenerName}/tls | Retrieve the tls object in a listener |
| ConfigApi | get_listener_tls_certificate | Get /config/listeners/{listenerName}/tls/certificate/{arrayIndex} | Retrieve a certificate array item in a listener |
| ConfigApi | get_listener_tls_session | Get /config/listeners/{listenerName}/tls/session | Retrieve the session object in a listener |
| ConfigApi | get_listener_tls_session_ticket | Get /config/listeners/{listenerName}/tls/session/tickets/{arrayIndex} | Retrieve a ticket array item in a listener |
| ConfigApi | get_listeners | Get /config/listeners | Retrieve all the listeners |
| ConfigApi | get_routes | Get /config/routes | Retrieve the routes entity |
| ConfigApi | get_settings | Get /config/settings | Retrieve the settings object |
| ConfigApi | get_settings_discard_unsafe_fields | Get /config/settings/http/discard_unsafe_fields | Retrieve the discard_unsafe_fields option from http settings |
| ConfigApi | get_settings_http | Get /config/settings/http | Retrieve the http object from settings |
| ConfigApi | get_settings_http_body_read_timeout | Get /config/settings/http/body_read_timeout | Retrieve the body_read_timeout option from http settings |
| ConfigApi | get_settings_http_header_read_timeout | Get /config/settings/http/header_read_timeout | Retrieve the header_read_timeout option from http settings |
| ConfigApi | get_settings_http_idle_timeout | Get /config/settings/http/idle_timeout | Retrieve the idle_timeout option from http settings |
| ConfigApi | get_settings_http_max_body_size | Get /config/settings/http/max_body_size | Retrieve the max_body_size option from http settings |
| ConfigApi | get_settings_http_send_timeout | Get /config/settings/http/send_timeout | Retrieve the send_timeout option from http settings |
| ConfigApi | get_settings_http_static | Get /config/settings/http/static | Retrieve the static object from http settings |
| ConfigApi | get_settings_http_static_mime_type | Get /config/settings/http/static/mime_types/{mimeType} | Retrieve the MIME type option from MIME type settings |
| ConfigApi | get_settings_http_static_mime_types | Get /config/settings/http/static/mime_types | Retrieve the mime_types object from static settings |
| ConfigApi | get_settings_listen_threads | Get /config/settings/listen_threads | Retrieve the listen_threads option from settings |
| ConfigApi | get_settings_log_route | Get /config/settings/http/log_route | Retrieve the log_route option from http settings |
| ConfigApi | get_settings_server_version | Get /config/settings/http/server_version | Retrieve the server_version option from http settings |
| ConfigApi | get_settings_telemetry | Get /config/settings/telemetry | Retrieve the telemetry object from settings |
| ConfigApi | insert_listener_forwarded_source | Post /config/listeners/{listenerName}/forwarded/source | Add a new source array item in a listener |
| ConfigApi | insert_listener_tls_certificate | Post /config/listeners/{listenerName}/tls/certificate | Add a new certificate array item in a listener |
| ConfigApi | insert_listener_tls_session_ticket | Post /config/listeners/{listenerName}/tls/session/tickets | Add a new tickets array item in a listener |
| ConfigApi | list_listener_forwarded_sources | Get /config/listeners/{listenerName}/forwarded/source | Retrieve the source option in a listener |
| ConfigApi | list_listener_tls_certificates | Get /config/listeners/{listenerName}/tls/certificate | Retrieve the certificate option in a listener |
| ConfigApi | list_listener_tls_conf_commands | Get /config/listeners/{listenerName}/tls/conf_commands | Retrieve the conf_commands object in a listener |
| ConfigApi | list_listener_tls_session_tickets | Get /config/listeners/{listenerName}/tls/session/tickets | Retrieve the tickets option in a listener |
| ConfigApi | put_settings_telemetry | Put /config/settings/telemetry | Create or update the telemetry object in settings |
| ConfigApi | update_access_log | Put /config/access_log | Create or overwrite the access log |
| ConfigApi | update_access_log_format | Put /config/access_log/format | Create or overwrite the access log format |
| ConfigApi | update_access_log_path | Put /config/access_log/path | Create or overwrite the access log path |
| ConfigApi | update_application | Put /config/applications/{appName} | Create or overwrite the application object |
| ConfigApi | update_applications | Put /config/applications | Overwrite the applications object |
| ConfigApi | update_config | Put /config | Create or overwrite the config |
| ConfigApi | update_listener | Put /config/listeners/{listenerName} | Create or overwrite a listener object |
| ConfigApi | update_listener_backlog | Put /config/listeners/{listenerName}/backlog | Update the backlog option in a listener |
| ConfigApi | update_listener_forwarded | Put /config/listeners/{listenerName}/forwarded | Create or overwrite the forwarded object in a listener |
| ConfigApi | update_listener_forwarded_client_ip | Put /config/listeners/{listenerName}/forwarded/client_ip | Create or overwrite the client_ip option in a listener |
| ConfigApi | update_listener_forwarded_protocol | Put /config/listeners/{listenerName}/forwarded/protocol | Create or overwrite the protocol option in a listener |
| ConfigApi | update_listener_forwarded_recursive | Put /config/listeners/{listenerName}/forwarded/recursive | Create or overwrite the recursive option in a listener |
| ConfigApi | update_listener_forwarded_source | Put /config/listeners/{listenerName}/forwarded/source/{arrayIndex} | Update a source array item in a listener |
| ConfigApi | update_listener_forwarded_sources | Put /config/listeners/{listenerName}/forwarded/source | Create or overwrite the source option in a listener |
| ConfigApi | update_listener_pass | Put /config/listeners/{listenerName}/pass | Update the pass option in a listener |
| ConfigApi | update_listener_tls | Put /config/listeners/{listenerName}/tls | Create or overwrite the tls object in a listener |
| ConfigApi | update_listener_tls_certificate | Put /config/listeners/{listenerName}/tls/certificate/{arrayIndex} | Update a certificate array item in a listener |
| ConfigApi | update_listener_tls_certificates | Put /config/listeners/{listenerName}/tls/certificate | Create or overwrite the certificate option in a listener |
| ConfigApi | update_listener_tls_conf_commands | Put /config/listeners/{listenerName}/tls/conf_commands | Create or overwrite the conf_commands object in a listener |
| ConfigApi | update_listener_tls_session | Put /config/listeners/{listenerName}/tls/session | Create or overwrite the session object in a listener |
| ConfigApi | update_listener_tls_session_ticket | Put /config/listeners/{listenerName}/tls/session/tickets/{arrayIndex} | Create or overwrite a ticket array item in a listener |
| ConfigApi | update_listener_tls_session_tickets | Put /config/listeners/{listenerName}/tls/session/tickets | Create or overwrite the tickets option in a listener |
| ConfigApi | update_listeners | Put /config/listeners | Create or overwrite all the listeners |
| ConfigApi | update_routes | Put /config/routes | Overwrite the routes entity |
| ConfigApi | update_settings | Put /config/settings | Create or overwrite the settings object |
| ConfigApi | update_settings_discard_unsafe_fields | Put /config/settings/http/discard_unsafe_fields | Create or overwrite the discard_unsafe_fields option |
| ConfigApi | update_settings_http | Put /config/settings/http | Create or overwrite the http object |
| ConfigApi | update_settings_http_body_read_timeout | Put /config/settings/http/body_read_timeout | Create or overwrite the body_read_timeout option |
| ConfigApi | update_settings_http_header_read_timeout | Put /config/settings/http/header_read_timeout | Create or overwrite the header_read_timeout option |
| ConfigApi | update_settings_http_idle_timeout | Put /config/settings/http/idle_timeout | Create or overwrite the idle_timeout option |
| ConfigApi | update_settings_http_max_body_size | Put /config/settings/http/max_body_size | Create or overwrite the max_body_size option |
| ConfigApi | update_settings_http_send_timeout | Put /config/settings/http/send_timeout | Create or overwrite the send_timeout option |
| ConfigApi | update_settings_http_static | Put /config/settings/http/static | Create or overwrite the static object |
| ConfigApi | update_settings_http_static_mime_type | Put /config/settings/http/static/mime_types/{mimeType} | Create or overwrite the MIME type option |
| ConfigApi | update_settings_http_static_mime_types | Put /config/settings/http/static/mime_types | Create or overwrite the mime_types object |
| ConfigApi | update_settings_listen_threads | Put /config/settings/listen_threads | Create or overwrite the listen_threads option |
| ConfigApi | update_settings_log_route | Put /config/settings/http/log_route | Create or overwrite the log_route option |
| ConfigApi | update_settings_server_version | Put /config/settings/http/server_version | Create or overwrite the server_version option |
| ControlApi | get_app_restart | Get /control/applications/{appName}/restart | Restart the {appName} application |
| ListenersApi | delete_listener | Delete /config/listeners/{listenerName} | Delete a listener object |
| ListenersApi | delete_listener_forwarded_recursive | Delete /config/listeners/{listenerName}/forwarded/recursive | Delete the recursive object in a listener |
| ListenersApi | delete_listener_forwarded_source | Delete /config/listeners/{listenerName}/forwarded/source/{arrayIndex} | Delete a source array item in a listener |
| ListenersApi | delete_listener_forwarded_sources | Delete /config/listeners/{listenerName}/forwarded/source | Delete the source option in a listener |
| ListenersApi | delete_listener_forwared | Delete /config/listeners/{listenerName}/forwarded | Delete the forwarded object in a listener |
| ListenersApi | delete_listener_tls | Delete /config/listeners/{listenerName}/tls | Delete the tls object in a listener |
| ListenersApi | delete_listener_tls_certificate | Delete /config/listeners/{listenerName}/tls/certificate/{arrayIndex} | Delete a certificate array item in a listener |
| ListenersApi | delete_listener_tls_certificates | Delete /config/listeners/{listenerName}/tls/certificate | Delete the certificate option in a listener |
| ListenersApi | delete_listener_tls_conf_commands | Delete /config/listeners/{listenerName}/tls/conf_commands | Delete the conf_commands object in a listener |
| ListenersApi | delete_listener_tls_session | Delete /config/listeners/{listenerName}/tls/session | Delete the session object in a listener |
| ListenersApi | delete_listener_tls_session_ticket | Delete /config/listeners/{listenerName}/tls/session/tickets/{arrayIndex} | Delete a ticket array item in a listener |
| ListenersApi | delete_listener_tls_session_tickets | Delete /config/listeners/{listenerName}/tls/session/tickets | Delete the tickets option in a listener |
| ListenersApi | delete_listeners | Delete /config/listeners | Delete all the listeners |
| ListenersApi | get_listener | Get /config/listeners/{listenerName} | Retrieve a listener object |
| ListenersApi | get_listener_backlog | Get /config/listeners/{listenerName}/backlog | Retrieve the backlog option in a listener |
| ListenersApi | get_listener_forwarded | Get /config/listeners/{listenerName}/forwarded | Retrieve the forwarded object in a listener |
| ListenersApi | get_listener_forwarded_client_ip | Get /config/listeners/{listenerName}/forwarded/client_ip | Retrieve the client_ip option in a listener |
| ListenersApi | get_listener_forwarded_protocol | Get /config/listeners/{listenerName}/forwarded/protocol | Retrieve the protocol option in a listener |
| ListenersApi | get_listener_forwarded_recursive | Get /config/listeners/{listenerName}/forwarded/recursive | Retrieve the recursive option in a listener |
| ListenersApi | get_listener_forwarded_source | Get /config/listeners/{listenerName}/forwarded/source/{arrayIndex} | Retrieve a source array item in a listener |
| ListenersApi | get_listener_pass | Get /config/listeners/{listenerName}/pass | Retrieve the pass option in a listener |
| ListenersApi | get_listener_tls | Get /config/listeners/{listenerName}/tls | Retrieve the tls object in a listener |
| ListenersApi | get_listener_tls_certificate | Get /config/listeners/{listenerName}/tls/certificate/{arrayIndex} | Retrieve a certificate array item in a listener |
| ListenersApi | get_listener_tls_session | Get /config/listeners/{listenerName}/tls/session | Retrieve the session object in a listener |
| ListenersApi | get_listener_tls_session_ticket | Get /config/listeners/{listenerName}/tls/session/tickets/{arrayIndex} | Retrieve a ticket array item in a listener |
| ListenersApi | get_listeners | Get /config/listeners | Retrieve all the listeners |
| ListenersApi | insert_listener_forwarded_source | Post /config/listeners/{listenerName}/forwarded/source | Add a new source array item in a listener |
| ListenersApi | insert_listener_tls_certificate | Post /config/listeners/{listenerName}/tls/certificate | Add a new certificate array item in a listener |
| ListenersApi | insert_listener_tls_session_ticket | Post /config/listeners/{listenerName}/tls/session/tickets | Add a new tickets array item in a listener |
| ListenersApi | list_listener_forwarded_sources | Get /config/listeners/{listenerName}/forwarded/source | Retrieve the source option in a listener |
| ListenersApi | list_listener_tls_certificates | Get /config/listeners/{listenerName}/tls/certificate | Retrieve the certificate option in a listener |
| ListenersApi | list_listener_tls_conf_commands | Get /config/listeners/{listenerName}/tls/conf_commands | Retrieve the conf_commands object in a listener |
| ListenersApi | list_listener_tls_session_tickets | Get /config/listeners/{listenerName}/tls/session/tickets | Retrieve the tickets option in a listener |
| ListenersApi | update_listener | Put /config/listeners/{listenerName} | Create or overwrite a listener object |
| ListenersApi | update_listener_backlog | Put /config/listeners/{listenerName}/backlog | Update the backlog option in a listener |
| ListenersApi | update_listener_forwarded | Put /config/listeners/{listenerName}/forwarded | Create or overwrite the forwarded object in a listener |
| ListenersApi | update_listener_forwarded_client_ip | Put /config/listeners/{listenerName}/forwarded/client_ip | Create or overwrite the client_ip option in a listener |
| ListenersApi | update_listener_forwarded_protocol | Put /config/listeners/{listenerName}/forwarded/protocol | Create or overwrite the protocol option in a listener |
| ListenersApi | update_listener_forwarded_recursive | Put /config/listeners/{listenerName}/forwarded/recursive | Create or overwrite the recursive option in a listener |
| ListenersApi | update_listener_forwarded_source | Put /config/listeners/{listenerName}/forwarded/source/{arrayIndex} | Update a source array item in a listener |
| ListenersApi | update_listener_forwarded_sources | Put /config/listeners/{listenerName}/forwarded/source | Create or overwrite the source option in a listener |
| ListenersApi | update_listener_pass | Put /config/listeners/{listenerName}/pass | Update the pass option in a listener |
| ListenersApi | update_listener_tls | Put /config/listeners/{listenerName}/tls | Create or overwrite the tls object in a listener |
| ListenersApi | update_listener_tls_certificate | Put /config/listeners/{listenerName}/tls/certificate/{arrayIndex} | Update a certificate array item in a listener |
| ListenersApi | update_listener_tls_certificates | Put /config/listeners/{listenerName}/tls/certificate | Create or overwrite the certificate option in a listener |
| ListenersApi | update_listener_tls_conf_commands | Put /config/listeners/{listenerName}/tls/conf_commands | Create or overwrite the conf_commands object in a listener |
| ListenersApi | update_listener_tls_session | Put /config/listeners/{listenerName}/tls/session | Create or overwrite the session object in a listener |
| ListenersApi | update_listener_tls_session_ticket | Put /config/listeners/{listenerName}/tls/session/tickets/{arrayIndex} | Create or overwrite a ticket array item in a listener |
| ListenersApi | update_listener_tls_session_tickets | Put /config/listeners/{listenerName}/tls/session/tickets | Create or overwrite the tickets option in a listener |
| ListenersApi | update_listeners | Put /config/listeners | Create or overwrite all the listeners |
| RoutesApi | delete_routes | Delete /config/routes | Delete the routes entity |
| RoutesApi | get_routes | Get /config/routes | Retrieve the routes entity |
| RoutesApi | update_routes | Put /config/routes | Overwrite the routes entity |
| SettingsApi | delete_settings | Delete /config/settings | Delete the settings object |
| SettingsApi | delete_settings_discard_unsafe_fields | Delete /config/settings/http/discard_unsafe_fields | Delete the discard_unsafe_fields option |
| SettingsApi | delete_settings_http | Delete /config/settings/http | Delete the http object |
| SettingsApi | delete_settings_http_body_read_timeout | Delete /config/settings/http/body_read_timeout | Delete the body_read_timeout option |
| SettingsApi | delete_settings_http_header_read_timeout | Delete /config/settings/http/header_read_timeout | Delete the header_read_timeout option |
| SettingsApi | delete_settings_http_idle_timeout | Delete /config/settings/http/idle_timeout | Delete the idle_timeout option |
| SettingsApi | delete_settings_http_max_body_size | Delete /config/settings/http/max_body_size | Delete the max_body_size option |
| SettingsApi | delete_settings_http_send_timeout | Delete /config/settings/http/send_timeout | Delete the send_timeout option |
| SettingsApi | delete_settings_http_static | Delete /config/settings/http/static | Delete the static object |
| SettingsApi | delete_settings_http_static_mime_type | Delete /config/settings/http/static/mime_types/{mimeType} | Delete the MIME type option |
| SettingsApi | delete_settings_http_static_mime_types | Delete /config/settings/http/static/mime_types | Delete the mime_types object |
| SettingsApi | delete_settings_listen_threads | Delete /config/settings/listen_threads | Delete the listen_threads option |
| SettingsApi | delete_settings_log_route | Delete /config/settings/http/log_route | Delete the log_route option |
| SettingsApi | delete_settings_server_version | Delete /config/settings/http/server_version | Delete the server_version option |
| SettingsApi | delete_settings_telemetry | Delete /config/settings/telemetry | Delete the telemetry object |
| SettingsApi | get_settings | Get /config/settings | Retrieve the settings object |
| SettingsApi | get_settings_discard_unsafe_fields | Get /config/settings/http/discard_unsafe_fields | Retrieve the discard_unsafe_fields option from http settings |
| SettingsApi | get_settings_http | Get /config/settings/http | Retrieve the http object from settings |
| SettingsApi | get_settings_http_body_read_timeout | Get /config/settings/http/body_read_timeout | Retrieve the body_read_timeout option from http settings |
| SettingsApi | get_settings_http_header_read_timeout | Get /config/settings/http/header_read_timeout | Retrieve the header_read_timeout option from http settings |
| SettingsApi | get_settings_http_idle_timeout | Get /config/settings/http/idle_timeout | Retrieve the idle_timeout option from http settings |
| SettingsApi | get_settings_http_max_body_size | Get /config/settings/http/max_body_size | Retrieve the max_body_size option from http settings |
| SettingsApi | get_settings_http_send_timeout | Get /config/settings/http/send_timeout | Retrieve the send_timeout option from http settings |
| SettingsApi | get_settings_http_static | Get /config/settings/http/static | Retrieve the static object from http settings |
| SettingsApi | get_settings_http_static_mime_type | Get /config/settings/http/static/mime_types/{mimeType} | Retrieve the MIME type option from MIME type settings |
| SettingsApi | get_settings_http_static_mime_types | Get /config/settings/http/static/mime_types | Retrieve the mime_types object from static settings |
| SettingsApi | get_settings_listen_threads | Get /config/settings/listen_threads | Retrieve the listen_threads option from settings |
| SettingsApi | get_settings_log_route | Get /config/settings/http/log_route | Retrieve the log_route option from http settings |
| SettingsApi | get_settings_server_version | Get /config/settings/http/server_version | Retrieve the server_version option from http settings |
| SettingsApi | get_settings_telemetry | Get /config/settings/telemetry | Retrieve the telemetry object from settings |
| SettingsApi | put_settings_telemetry | Put /config/settings/telemetry | Create or update the telemetry object in settings |
| SettingsApi | update_settings | Put /config/settings | Create or overwrite the settings object |
| SettingsApi | update_settings_discard_unsafe_fields | Put /config/settings/http/discard_unsafe_fields | Create or overwrite the discard_unsafe_fields option |
| SettingsApi | update_settings_http | Put /config/settings/http | Create or overwrite the http object |
| SettingsApi | update_settings_http_body_read_timeout | Put /config/settings/http/body_read_timeout | Create or overwrite the body_read_timeout option |
| SettingsApi | update_settings_http_header_read_timeout | Put /config/settings/http/header_read_timeout | Create or overwrite the header_read_timeout option |
| SettingsApi | update_settings_http_idle_timeout | Put /config/settings/http/idle_timeout | Create or overwrite the idle_timeout option |
| SettingsApi | update_settings_http_max_body_size | Put /config/settings/http/max_body_size | Create or overwrite the max_body_size option |
| SettingsApi | update_settings_http_send_timeout | Put /config/settings/http/send_timeout | Create or overwrite the send_timeout option |
| SettingsApi | update_settings_http_static | Put /config/settings/http/static | Create or overwrite the static object |
| SettingsApi | update_settings_http_static_mime_type | Put /config/settings/http/static/mime_types/{mimeType} | Create or overwrite the MIME type option |
| SettingsApi | update_settings_http_static_mime_types | Put /config/settings/http/static/mime_types | Create or overwrite the mime_types object |
| SettingsApi | update_settings_listen_threads | Put /config/settings/listen_threads | Create or overwrite the listen_threads option |
| SettingsApi | update_settings_log_route | Put /config/settings/http/log_route | Create or overwrite the log_route option |
| SettingsApi | update_settings_server_version | Put /config/settings/http/server_version | Create or overwrite the server_version option |
| StatusApi | get_status | Get /status | Retrieve the status object |
| StatusApi | get_status_applications | Get /status/applications | Retrieve the applications status object |
| StatusApi | get_status_applications_app | Get /status/applications/{appName} | Retrieve the app status object |
| StatusApi | get_status_applications_app_processes | Get /status/applications/{appName}/processes | Retrieve the processes app status object |
| StatusApi | get_status_applications_app_processes_idle | Get /status/applications/{appName}/processes/idle | Retrieve the idle processes app status number |
| StatusApi | get_status_applications_app_processes_running | Get /status/applications/{appName}/processes/running | Retrieve the running processes app status number |
| StatusApi | get_status_applications_app_processes_starting | Get /status/applications/{appName}/processes/starting | Retrieve the starting processes app status number |
| StatusApi | get_status_applications_app_requests | Get /status/applications/{appName}/requests | Retrieve the requests app status object |
| StatusApi | get_status_applications_app_requests_active | Get /status/applications/{appName}/requests/active | Retrieve the active requests app status number |
| StatusApi | get_status_connections | Get /status/connections | Retrieve the connections status object |
| StatusApi | get_status_connections_accepted | Get /status/connections/accepted | Retrieve the accepted connections number |
| StatusApi | get_status_connections_active | Get /status/connections/active | Retrieve the active connections number |
| StatusApi | get_status_connections_closed | Get /status/connections/closed | Retrieve the closed connections number |
| StatusApi | get_status_connections_idle | Get /status/connections/idle | Retrieve the idle connections number |
| StatusApi | get_status_modules | Get /status/modules | Retrieve the modules status object |
| StatusApi | get_status_modules_lang | Get /status/modules/{langMod} | Retrieve the language module object |
| StatusApi | get_status_modules_lang_lib | Get /status/modules/{langMod}/lib | Retrieves the language module lib object |
| StatusApi | get_status_modules_lang_version | Get /status/modules/{langMod}/version | Retrieve the language module version object |
| StatusApi | get_status_requests | Get /status/requests | Retrieve the requests status object |
| StatusApi | get_status_requests_total | Get /status/requests/total | Retrieve the total requests number |
| TlsApi | delete_listener_tls | Delete /config/listeners/{listenerName}/tls | Delete the tls object in a listener |
| TlsApi | delete_listener_tls_certificate | Delete /config/listeners/{listenerName}/tls/certificate/{arrayIndex} | Delete a certificate array item in a listener |
| TlsApi | delete_listener_tls_certificates | Delete /config/listeners/{listenerName}/tls/certificate | Delete the certificate option in a listener |
| TlsApi | delete_listener_tls_conf_commands | Delete /config/listeners/{listenerName}/tls/conf_commands | Delete the conf_commands object in a listener |
| TlsApi | delete_listener_tls_session | Delete /config/listeners/{listenerName}/tls/session | Delete the session object in a listener |
| TlsApi | delete_listener_tls_session_ticket | Delete /config/listeners/{listenerName}/tls/session/tickets/{arrayIndex} | Delete a ticket array item in a listener |
| TlsApi | delete_listener_tls_session_tickets | Delete /config/listeners/{listenerName}/tls/session/tickets | Delete the tickets option in a listener |
| TlsApi | get_listener_tls | Get /config/listeners/{listenerName}/tls | Retrieve the tls object in a listener |
| TlsApi | get_listener_tls_certificate | Get /config/listeners/{listenerName}/tls/certificate/{arrayIndex} | Retrieve a certificate array item in a listener |
| TlsApi | get_listener_tls_session | Get /config/listeners/{listenerName}/tls/session | Retrieve the session object in a listener |
| TlsApi | get_listener_tls_session_ticket | Get /config/listeners/{listenerName}/tls/session/tickets/{arrayIndex} | Retrieve a ticket array item in a listener |
| TlsApi | insert_listener_tls_certificate | Post /config/listeners/{listenerName}/tls/certificate | Add a new certificate array item in a listener |
| TlsApi | insert_listener_tls_session_ticket | Post /config/listeners/{listenerName}/tls/session/tickets | Add a new tickets array item in a listener |
| TlsApi | list_listener_tls_certificates | Get /config/listeners/{listenerName}/tls/certificate | Retrieve the certificate option in a listener |
| TlsApi | list_listener_tls_conf_commands | Get /config/listeners/{listenerName}/tls/conf_commands | Retrieve the conf_commands object in a listener |
| TlsApi | list_listener_tls_session_tickets | Get /config/listeners/{listenerName}/tls/session/tickets | Retrieve the tickets option in a listener |
| TlsApi | update_listener_tls | Put /config/listeners/{listenerName}/tls | Create or overwrite the tls object in a listener |
| TlsApi | update_listener_tls_certificate | Put /config/listeners/{listenerName}/tls/certificate/{arrayIndex} | Update a certificate array item in a listener |
| TlsApi | update_listener_tls_certificates | Put /config/listeners/{listenerName}/tls/certificate | Create or overwrite the certificate option in a listener |
| TlsApi | update_listener_tls_conf_commands | Put /config/listeners/{listenerName}/tls/conf_commands | Create or overwrite the conf_commands object in a listener |
| TlsApi | update_listener_tls_session | Put /config/listeners/{listenerName}/tls/session | Create or overwrite the session object in a listener |
| TlsApi | update_listener_tls_session_ticket | Put /config/listeners/{listenerName}/tls/session/tickets/{arrayIndex} | Create or overwrite a ticket array item in a listener |
| TlsApi | update_listener_tls_session_tickets | Put /config/listeners/{listenerName}/tls/session/tickets | Create or overwrite the tickets option in a listener |
| XffApi | delete_listener_forwarded_recursive | Delete /config/listeners/{listenerName}/forwarded/recursive | Delete the recursive object in a listener |
| XffApi | delete_listener_forwarded_source | Delete /config/listeners/{listenerName}/forwarded/source/{arrayIndex} | Delete a source array item in a listener |
| XffApi | delete_listener_forwarded_sources | Delete /config/listeners/{listenerName}/forwarded/source | Delete the source option in a listener |
| XffApi | delete_listener_forwared | Delete /config/listeners/{listenerName}/forwarded | Delete the forwarded object in a listener |
| XffApi | get_listener_forwarded | Get /config/listeners/{listenerName}/forwarded | Retrieve the forwarded object in a listener |
| XffApi | get_listener_forwarded_client_ip | Get /config/listeners/{listenerName}/forwarded/client_ip | Retrieve the client_ip option in a listener |
| XffApi | get_listener_forwarded_protocol | Get /config/listeners/{listenerName}/forwarded/protocol | Retrieve the protocol option in a listener |
| XffApi | get_listener_forwarded_recursive | Get /config/listeners/{listenerName}/forwarded/recursive | Retrieve the recursive option in a listener |
| XffApi | get_listener_forwarded_source | Get /config/listeners/{listenerName}/forwarded/source/{arrayIndex} | Retrieve a source array item in a listener |
| XffApi | insert_listener_forwarded_source | Post /config/listeners/{listenerName}/forwarded/source | Add a new source array item in a listener |
| XffApi | list_listener_forwarded_sources | Get /config/listeners/{listenerName}/forwarded/source | Retrieve the source option in a listener |
| XffApi | update_listener_forwarded | Put /config/listeners/{listenerName}/forwarded | Create or overwrite the forwarded object in a listener |
| XffApi | update_listener_forwarded_client_ip | Put /config/listeners/{listenerName}/forwarded/client_ip | Create or overwrite the client_ip option in a listener |
| XffApi | update_listener_forwarded_protocol | Put /config/listeners/{listenerName}/forwarded/protocol | Create or overwrite the protocol option in a listener |
| XffApi | update_listener_forwarded_recursive | Put /config/listeners/{listenerName}/forwarded/recursive | Create or overwrite the recursive option in a listener |
| XffApi | update_listener_forwarded_source | Put /config/listeners/{listenerName}/forwarded/source/{arrayIndex} | Update a source array item in a listener |
| XffApi | update_listener_forwarded_sources | Put /config/listeners/{listenerName}/forwarded/source | Create or overwrite the source option in a listener |
To get access to the crate's generated documentation, use:
cargo doc --open