NGINX Unit

NGINX Unit 1.35.0

NGINX Unit is a lightweight and versatile application runtime that provides the essential components for your web application as a single open-source server:…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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/:


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](https://unit.nginx.org/howto/source/#source-startup) Unit with a TCP port as the control socket.

Endpoints 184

access log

  • GETRetrieve the access log/config/access_logRetrieves the access_log entity that represents Unit's access log.
  • PUTCreate or overwrite the access log/config/access_logCreates or overwrites the entire access_log entity.
  • DELETEDelete the access log/config/access_logDeletes the entire access_log section.
  • GETRetrieve the access log format option/config/access_log/formatRetrieves the format option that represents Unit's access log format in the access_log object.
  • PUTCreate or overwrite the access log format/config/access_log/formatCreates or overwrites the format option in the access_log object.
  • DELETEDelete the access log format/config/access_log/formatDeletes the format option from the access_log object.
  • GETRetrieve the access log path option/config/access_log/pathRetrieves the path option that represents Unit's access log path in the access_log object.
  • PUTCreate or overwrite the access log path/config/access_log/pathCreates or overwrites the path option in the access_log object.
  • DELETEDelete the access log path/config/access_log/pathDeletes the path option from the access_log object.

apps

  • GETRestart the {appName} application/control/applications/:appName/restartTells Unit to [restart] (https://unit.nginx.org/configuration/#process-management) the application identified by {appName}.

certificates

  • GETRetrieve the certificates object/certificatesRetrieves the entire /certificates section that represents Unit's stored certificates.
  • GETRetrieve the certificate bundle object/certificates/:bundleNameRetrieves the bundle description that represents Unit's [stored certificate bundle] (https://unit.nginx.org/certificates/).
  • PUTCreate or overwrite the actual certificate bundle/certificates/:bundleNameCreates or overwrites the [stored certificate bundle] (https://unit.nginx.org/certificates/) in Unit.
  • GETRetrieve the certificate bundle key type/certificates/:bundleName/keyRetrieves the bundle key type from a stored certificate bundle.
  • GETRetrieve the certificate bundle chain/certificates/:bundleName/chainRetrieves the bundle chain from a stored certificate bundle.
  • GETRetrieve certificate object from the chain array/certificates/:bundleName/chain/:arrayIndexRetrieves the individual certificate from a stored certificate bundle.
  • GETRetrieve the subject from the certificate object/certificates/:bundleName/chain/:arrayIndex/subjectRetrieves the subject from a stored certificate.
  • GETRetrieve the common name from the certificate subject/certificates/:bundleName/chain/:arrayIndex/subject/common_nameRetrieves the common name from a stored certificate's subject.
  • GETRetrieve the country code from the certificate subject/certificates/:bundleName/chain/:arrayIndex/subject/countryRetrieves the country code from a stored certificate's subject.
  • GETRetrieve the state or province code from the certificate subject/certificates/:bundleName/chain/:arrayIndex/subject/state_or_provinceRetrieves the state or province code from a stored certificate's subject.
  • GETRetrieve the organization name from the certificate subject/certificates/:bundleName/chain/:arrayIndex/subject/organizationRetrieves the organization name from a stored certificate's subject.
  • GETRetrieve the alternative names array from the certificate subject/certificates/:bundleName/chain/:arrayIndex/subject/alt_namesRetrieves the alternative names array from a stored certificate's subject.
  • GETRetrieve an alternative name from the certificate subject/certificates/:bundleName/chain/:arrayIndex/subject/alt_names/:arrayIndex2Retrieves an alternative name from a stored certificate's subject.
  • GETRetrieve the issuer object from the certificate object/certificates/:bundleName/chain/:arrayIndex/issuerRetrieves the issuer object from a stored certificate.
  • GETRetrieve the common name from the certificate issuer/certificates/:bundleName/chain/:arrayIndex/issuer/common_nameRetrieves the common name from a stored certificate's issuer.
  • GETRetrieve the country code from the certificate issuer/certificates/:bundleName/chain/:arrayIndex/issuer/countryRetrieves the country code from a stored certificate's issuer.
  • GETRetrieve the state or province code from the certificate issuer/certificates/:bundleName/chain/:arrayIndex/issuer/state_or_provinceRetrieves the state or province code from a stored certificate's issuer.
  • GETRetrieve the organization name from the certificate issuer/certificates/:bundleName/chain/:arrayIndex/issuer/organizationRetrieves the organization name from a stored certificate's issuer.
  • GETRetrieve the validity object from the certificate object/certificates/:bundleName/chain/:arrayIndex/validityRetrieves the validity object from a stored certificate.
  • GETRetrieve the starting time of certificate validity/certificates/:bundleName/chain/:arrayIndex/validity/sinceRetrieves the starting time of a stored certificate's validity.
  • GETRetrieve the ending time of certificate validity/certificates/:bundleName/chain/:arrayIndex/validity/untilRetrieves the ending time of a stored certificate's validity.

config

  • GETRetrieve the config/configRetrieves the config object that represents Unit's configuration.
  • PUTCreate or overwrite the config/configCreates or overwrites the entire config object.
  • DELETEDelete the config object/configDeletes the entire config object.
  • GETRetrieve the routes entity/config/routesRetrieves the routes entity that represents Unit's routes.
  • PUTOverwrite the routes entity/config/routesOverwrites the routes entity in the configuration.
  • DELETEDelete the routes entity/config/routesDeletes the routes entity from the configuration.

listeners

  • GETRetrieve all the listeners/config/listenersRetrieves the listeners object whose options represent individual listeners; each is a unique combination of a host IP address (or a * wildcard to match any…
  • PUTCreate or overwrite all the listeners/config/listenersCreates or overwrites the entire listeners section with an object whose options represent individual listeners; each is a unique combination of a host IP…
  • DELETEDelete all the listeners/config/listenersDeletes the entire listeners section.
  • GETRetrieve a listener object/config/listeners/:listenerNameRetrieves the {listenerName} object that configures a listener.
  • PUTCreate or overwrite a listener object/config/listeners/:listenerNameCreates or overwrites the {listenerName} object.
  • DELETEDelete a listener object/config/listeners/:listenerNameDeletes the {listenerName} object.
  • GETRetrieve the pass option in a listener/config/listeners/:listenerName/passRetrieves the pass option that configures the destination where the {listenerName} listener object passes its requests.
  • PUTUpdate the pass option in a listener/config/listeners/:listenerName/passOverwrites the pass option.
  • GETRetrieve the tls object in a listener/config/listeners/:listenerName/tlsRetrieves the tls object that configures [TLS settings] (https://unit.nginx.org/configuration/#ssl-tls-configuration) for the {listenerName} listener.
  • PUTCreate or overwrite the tls object in a listener/config/listeners/:listenerName/tlsCreates or overwrites the entire tls object.
  • DELETEDelete the tls object in a listener/config/listeners/:listenerName/tlsDeletes the tls object.
  • GETRetrieve the conf_commands object in a listener/config/listeners/:listenerName/tls/conf_commandsRetrieves the conf_commands object that sets [TLS configuration commands] (https://unit.nginx.org/configuration/#ssl-tls-configuration) for the {listenerName}…
  • PUTCreate or overwrite the conf_commands object in a listener/config/listeners/:listenerName/tls/conf_commandsCreates or overwrites the entire conf_commands object.
  • DELETEDelete the conf_commands object in a listener/config/listeners/:listenerName/tls/conf_commandsDeletes the conf_commands object.
  • GETRetrieve the session object in a listener/config/listeners/:listenerName/tls/sessionRetrieves the session object that configures [TLS session settings] (https://unit.nginx.org/configuration/#ssl-tls-configuration) for the {listenerName}…
  • PUTCreate or overwrite the session object in a listener/config/listeners/:listenerName/tls/sessionCreates or overwrites the entire session object.
  • DELETEDelete the session object in a listener/config/listeners/:listenerName/tls/sessionDeletes the session object.
  • GETRetrieve the tickets option in a listener/config/listeners/:listenerName/tls/session/ticketsRetrieves the tickets option that lists [TLS session ticket keys] (https://unit.nginx.org/configuration/#ssl-tls-configuration) used with the {listenerName}…
  • PUTCreate or overwrite the tickets option in a listener/config/listeners/:listenerName/tls/session/ticketsCreates or overwrites the entire tickets option with a boolean, string, or string array that configures [session ticket keys]…
  • POSTAdd a new tickets array item in a listener/config/listeners/:listenerName/tls/session/ticketsAdds a new session ticket key to the end of the tickets string array that lists [session ticket keys]…
  • DELETEDelete the tickets option in a listener/config/listeners/:listenerName/tls/session/ticketsDeletes the tickets option.
  • GETRetrieve a ticket array item in a listener/config/listeners/:listenerName/tls/session/tickets/:arrayIndexRetrieves the {arrayIndex}th item from the tickets string array.
  • PUTCreate or overwrite a ticket array item in a listener/config/listeners/:listenerName/tls/session/tickets/:arrayIndexOverwrites a single tickets string array item identified by {arrayIndex}.
  • DELETEDelete a ticket array item in a listener/config/listeners/:listenerName/tls/session/tickets/:arrayIndexDeletes an item from the tickets string array.
  • GETRetrieve the certificate option in a listener/config/listeners/:listenerName/tls/certificateRetrieves the certificate option that lists certificate bundles used with the {listenerName} listener.
  • PUTCreate or overwrite the certificate option in a listener/config/listeners/:listenerName/tls/certificateCreates or overwrites the entire certificate option.
  • POSTAdd a new certificate array item in a listener/config/listeners/:listenerName/tls/certificateAdds a new certificate bundle name to the end of the certificate string array.
  • DELETEDelete the certificate option in a listener/config/listeners/:listenerName/tls/certificateDeletes the certificate option.
  • GETRetrieve a certificate array item in a listener/config/listeners/:listenerName/tls/certificate/:arrayIndexRetrieves the {arrayIndex}th item from the certificate string array.
  • PUTUpdate a certificate array item in a listener/config/listeners/:listenerName/tls/certificate/:arrayIndexOverwrites a single certificate string array item identified by {arrayIndex}.
  • DELETEDelete a certificate array item in a listener/config/listeners/:listenerName/tls/certificate/:arrayIndexDeletes an item from the certificate string array.
  • GETRetrieve the forwarded object in a listener/config/listeners/:listenerName/forwardedRetrieves the forwarded object that configures [originating IP identification] (https://unit.nginx.org/configuration/#ip-protocol-forwarding) for the…
  • PUTCreate or overwrite the forwarded object in a listener/config/listeners/:listenerName/forwardedCreates or overwrites the entire forwarded object.
  • DELETEDelete the forwarded object in a listener/config/listeners/:listenerName/forwardedDeletes the forwarded object.
  • GETRetrieve the client_ip option in a listener/config/listeners/:listenerName/forwarded/client_ipRetrieves the client_ip option that configures the headers expected by the {listenerName} listener for [originating IP identification]…
  • PUTCreate or overwrite the client_ip option in a listener/config/listeners/:listenerName/forwarded/client_ipCreates or overwrites the client_ip option.
  • GETRetrieve the protocol option in a listener/config/listeners/:listenerName/forwarded/protocolRetrieves the protocol option that configures the protocol expected by the {listenerName} listener for [originating IP identification]…
  • PUTCreate or overwrite the protocol option in a listener/config/listeners/:listenerName/forwarded/protocolCreates or overwrites the protocol option.
  • GETRetrieve the recursive option in a listener/config/listeners/:listenerName/forwarded/recursiveRetrieves the recursive option that controls how the {listenerName} listener uses [originating IP identification]…
  • PUTCreate or overwrite the recursive option in a listener/config/listeners/:listenerName/forwarded/recursiveCreates or overwrites the recursive option.
  • DELETEDelete the recursive object in a listener/config/listeners/:listenerName/forwarded/recursiveDeletes the recursive object.
  • GETRetrieve the source option in a listener/config/listeners/:listenerName/forwarded/sourceRetrieves the source option that defines address patterns for trusted addresses, used by the {listenerName} listener for [originating IP identification]…
  • PUTCreate or overwrite the source option in a listener/config/listeners/:listenerName/forwarded/sourceCreates or overwrites the entire source option.
  • POSTAdd a new source array item in a listener/config/listeners/:listenerName/forwarded/sourceAdds a new source bundle name to the end of the source string array defines address patterns for trusted addresses, used by the {listenerName} listener for…
  • DELETEDelete the source option in a listener/config/listeners/:listenerName/forwarded/sourceDeletes the source option.
  • GETRetrieve a source array item in a listener/config/listeners/:listenerName/forwarded/source/:arrayIndexRetrieves the {arrayIndex}th item from the source string array.
  • PUTUpdate a source array item in a listener/config/listeners/:listenerName/forwarded/source/:arrayIndexOverwrites a single source string array item identified by {arrayIndex}.
  • DELETEDelete a source array item in a listener/config/listeners/:listenerName/forwarded/source/:arrayIndexDeletes an item from the source string array.
  • GETRetrieve the backlog option in a listener/config/listeners/:listenerName/backlogRetrieves the backlog option that configures the listen(2) backlog parameter where the {listenerName} listener object passes its requests.
  • PUTUpdate the backlog option in a listener/config/listeners/:listenerName/backlogOverwrites the backlog option.

settings

  • GETRetrieve the settings object/config/settingsRetrieves the settings object that represents Unit's global settings.
  • PUTCreate or overwrite the settings object/config/settingsCreates or overwrites the settings object in the configuration.
  • DELETEDelete the settings object/config/settingsDeletes the settings object from the configuration.
  • GETRetrieve the listen_threads option from settings/config/settings/listen_threadsRetrieves the listen_threads option that represents Unit's [listen threads] (https://unit.nginx.org/configuration/#settings).
  • PUTCreate or overwrite the listen_threads option/config/settings/listen_threadsCreates or overwrites the listen_threads option in the configuration.
  • DELETEDelete the listen_threads option/config/settings/listen_threadsDeletes the listen_threads option from the configuration.
  • GETRetrieve the `telemetry` object from settings/config/settings/telemetryRetrieves the telemetry object that represents Unit's Telemetry settings.
  • PUTCreate or update the `telemetry` object in settings/config/settings/telemetryCreates or updates the telemetry object that represents Unit's Telemetry settings.
  • DELETEDelete the telemetry object/config/settings/telemetryDeletes the telemetry object from the configuration.
  • GETRetrieve the http object from settings/config/settings/httpRetrieves the http object that represents Unit's HTTP settings.
  • PUTCreate or overwrite the http object/config/settings/httpCreates or overwrites the http object in the configuration.
  • DELETEDelete the http object/config/settings/httpDeletes the http object from the configuration.
  • GETRetrieve the body_read_timeout option from http settings/config/settings/http/body_read_timeoutRetrieves the body_read_timeout option that represents Unit's [request body read timeout] (https://unit.nginx.org/configuration/#settings).
  • PUTCreate or overwrite the body_read_timeout option/config/settings/http/body_read_timeoutCreates or overwrites the body_read_timeout option in the configuration.
  • DELETEDelete the body_read_timeout option/config/settings/http/body_read_timeoutDeletes the body_read_timeout option from the configuration.
  • GETRetrieve the compression object from http settings/config/settings/http/compressionRetrieves the compression object that represents Unit's [HTTP compression settings] (https://unit.nginx.org/configuration/#settings).
  • PUTCreate or overwrite the compression object/config/settings/http/compressionCreates or overwrites the compression object in the configuration.
  • DELETEDelete the compression object/config/settings/http/compressionDeletes the compression object from the configuration.
  • GETRetrieve the types option in HTTP compression/config/settings/http/compression/typesRetrieves the types option that lists the MIME types considered for compressing.
  • PUTCreate or overwrite the types option in HTTP compression/config/settings/http/compression/typesCreates or overwrites the entire types option with an array of MIME types that are considered for HTTP compression.
  • POSTAdd a new types array item in HTTP compression/config/settings/http/compression/typesAdds a new HTTP compression MIME type to the end of the types array that lists the MIME types that are considered for compression.
  • DELETEDelete the types option in HTTP compression/config/settings/http/compression/typesDeletes the types option.
  • GETRetrieve a types array item in HTTP compression/config/settings/http/compression/types/:arrayIndexRetrieves the {arrayIndex} item from the types string array.
  • PUTCreate or overwrite a types array item in HTTP compression/config/settings/http/compression/types/:arrayIndexOverwrites a single types string array item identified by {arrayIndex}.
  • DELETEDelete a types array item in HTTP compression/config/settings/http/compression/types/:arrayIndexDeletes an item from the types string array.
  • GETRetrieve the compressors HTTP compression object/config/settings/http/compression/compressorsRetrieves the compressors HTTP compression object that represents a list of enabled compression methods.
  • PUTCreate or overwrite the compressors option in HTTP compression/config/settings/http/compression/compressorsCreates or overwrites the entire compressors option with an array of compression methods.
  • POSTAdd a new compressor array item in HTTP compression/config/settings/http/compression/compressorsAdds a new HTTP compression compressor to the end of the compressors array that lists the enabled compression methods.
  • DELETEDelete the compressors option in HTTP compression/config/settings/http/compression/compressorsDeletes the compressors option.
  • GETRetrieve the compressor object/config/settings/http/compression/compressors/:arrayIndexRetrieves the {arrayIndex} object that represents an enabled compression method.
  • PUTCreate or overwrite a compressors array item in HTTP compression/config/settings/http/compression/compressors/:arrayIndexOverwrites a single compressors object array item identified by {arrayIndex}.
  • DELETEDelete a compressors array item in HTTP compression/config/settings/http/compression/compressors/:arrayIndexDeletes an item from the compressors object array.
  • GETRetrieve the compressor encoding string/config/settings/http/compression/compressors/:arrayIndex/encodingRetrieves the compressor encoding string that represents the compression method of the enabled compressor identified by {arrayIndex}.
  • PUTCreate or overwrite a compressors array encoding item in HTTP compression/config/settings/http/compression/compressors/:arrayIndex/encodingOverwrites the compressor encoding string that represents the compression method of the enabled compressor identified by {arrayIndex}.
  • DELETEDelete a compressors array encoding item in HTTP compression/config/settings/http/compression/compressors/:arrayIndex/encodingDeletes the compressor encoding string that represents the compression method of the enabled compressor identified by {arrayIndex}.
  • GETRetrieve the compressor level value/config/settings/http/compression/compressors/:arrayIndex/levelRetrieves the compressor level value that represents the compression level of the enabled compressor.
  • PUTCreate or overwrite a compressors array level item in HTTP compression/config/settings/http/compression/compressors/:arrayIndex/levelOverwrites the compressor level integer that represents the compression level of the enabled compressor identified by {arrayIndex}.
  • DELETEDelete a compressors array level item in HTTP compression/config/settings/http/compression/compressors/:arrayIndex/levelDeletes the compressor level integer that represents the compression level of the enabled compressor identified by {arrayIndex}.
  • GETRetrieve the compressor min_length object/config/settings/http/compression/compressors/:arrayIndex/min_lengthRetrieves the compressor min_length object that represents the minimum length of data to compress.
  • PUTCreate or overwrite a compressors array min_length item in HTTP compression/config/settings/http/compression/compressors/:arrayIndex/min_lengthOverwrites the compressor min_length integer that represents the minimum length of data to compress.
  • DELETEDelete a compressors array min_length item in HTTP compression/config/settings/http/compression/compressors/:arrayIndex/min_lengthDeletes the compressor min_length integer that represents the minimum length of data to compress.
  • GETRetrieve the discard_unsafe_fields option from http settings/config/settings/http/discard_unsafe_fieldsRetrieves the discard_unsafe_fields option that represents Unit's [header processing behavior] (https://unit.nginx.org/configuration/#settings).
  • PUTCreate or overwrite the discard_unsafe_fields option/config/settings/http/discard_unsafe_fieldsCreates or overwrites the discard_unsafe_fields option in the configuration.
  • DELETEDelete the discard_unsafe_fields option/config/settings/http/discard_unsafe_fieldsDeletes the discard_unsafe_fields option from the configuration.
  • GETRetrieve the header_read_timeout option from http settings/config/settings/http/header_read_timeoutRetrieves the header_read_timeout option that represents Unit's [request headers read timeout] (https://unit.nginx.org/configuration/#settings).
  • PUTCreate or overwrite the header_read_timeout option/config/settings/http/header_read_timeoutCreates or overwrites the header_read_timeout option in the configuration.
  • DELETEDelete the header_read_timeout option/config/settings/http/header_read_timeoutDeletes the header_read_timeout option from the configuration.
  • GETRetrieve the idle_timeout option from http settings/config/settings/http/idle_timeoutRetrieves the idle_timeout option that represents Unit's [keep-alive idling timeout] (https://unit.nginx.org/configuration/#settings).
  • PUTCreate or overwrite the idle_timeout option/config/settings/http/idle_timeoutCreates or overwrites the idle_timeout option in the configuration.
  • DELETEDelete the idle_timeout option/config/settings/http/idle_timeoutDeletes the idle_timeout option from the configuration.
  • GETRetrieve the log_route option from http settings/config/settings/http/log_routeRetrieves the log_route option that controls Unit's [router logging] (https://unit.nginx.org/troubleshooting/#router-log).
  • PUTCreate or overwrite the log_route option/config/settings/http/log_routeCreates or overwrites the log_route option in the configuration.
  • DELETEDelete the log_route option/config/settings/http/log_routeDeletes the log_route option from the configuration.
  • GETRetrieve the max_body_size option from http settings/config/settings/http/max_body_sizeRetrieves the max_body_size option that represents Unit's [request body size limit] (https://unit.nginx.org/configuration/#settings).
  • PUTCreate or overwrite the max_body_size option/config/settings/http/max_body_sizeCreates or overwrites the max_body_size option in the configuration.
  • DELETEDelete the max_body_size option/config/settings/http/max_body_sizeDeletes the max_body_size option from the configuration.
  • GETRetrieve the send_timeout option from http settings/config/settings/http/send_timeoutRetrieves the send_timeout option that represents Unit's [response send timeout] (https://unit.nginx.org/configuration/#settings).
  • PUTCreate or overwrite the send_timeout option/config/settings/http/send_timeoutCreates or overwrites the send_timeout option in the configuration.
  • DELETEDelete the send_timeout option/config/settings/http/send_timeoutDeletes the send_timeout option from the configuration.
  • GETRetrieve the server_version option from http settings/config/settings/http/server_versionRetrieves the server_version option that controls Unit's [Server header field versioning] (https://unit.nginx.org/configuration/#settings).
  • PUTCreate or overwrite the server_version option/config/settings/http/server_versionCreates or overwrites the server_version option in the configuration.
  • DELETEDelete the server_version option/config/settings/http/server_versionDeletes the server_version option from the configuration.
  • GETRetrieve the static object from http settings/config/settings/http/staticRetrieves the static object that represents Unit's [static content settings] (https://unit.nginx.org/configuration/#settings).
  • PUTCreate or overwrite the static object/config/settings/http/staticCreates or overwrites the static object in the configuration.
  • DELETEDelete the static object/config/settings/http/staticDeletes the static object from the configuration.
  • GETRetrieve the mime_types object from static settings/config/settings/http/static/mime_typesRetrieves the mime_types object that represents Unit's MIME type settings.
  • PUTCreate or overwrite the mime_types object/config/settings/http/static/mime_typesCreates or overwrites the mime_types object in the configuration.
  • DELETEDelete the mime_types object/config/settings/http/static/mime_typesDeletes the mime_types object from the configuration.
  • GETRetrieve the MIME type option from MIME type settings/config/settings/http/static/mime_types/:mimeTypeRetrieves the MIME type option that represents a MIME type supported by Unit.
  • PUTCreate or overwrite the MIME type option/config/settings/http/static/mime_types/:mimeTypeCreates or overwrites the MIME type option in the configuration.
  • DELETEDelete the MIME type option/config/settings/http/static/mime_types/:mimeTypeDeletes the MIME type option from the configuration.

status

  • GETRetrieve the status object/statusRetrieves the entire /status section that represents Unit's usage statistics and list of loaded modules.
  • GETRetrieve the modules status object/status/modulesRetrieves the modules status object that represents Unit's loaded language modules.
  • GETRetrieve the language module object/status/modules/:langModRetrieves the language module object that represents a currently loaded language module.
  • GETRetrieve the language module version object/status/modules/:langMod/versionRetrieves the language module version object that represents the version of a currently loaded language module.
  • GETRetrieves the language module lib object/status/modules/:langMod/libRetrieves the language module lib object that represents the file path to the loaded language module.
  • GETRetrieve the connections status object/status/connectionsRetrieves the connections status object that represents Unit's connection statistics.
  • GETRetrieve the accepted connections number/status/connections/acceptedRetrieves the accepted connections number that represents Unit's connection statistics.
  • GETRetrieve the active connections number/status/connections/activeRetrieves the active connections number that represents Unit's connection statistics.
  • GETRetrieve the idle connections number/status/connections/idleRetrieves the idle connections number that represents Unit's connection statistics.
  • GETRetrieve the closed connections number/status/connections/closedRetrieves the closed connections number that represents Unit's connection statistics.
  • GETRetrieve the requests status object/status/requestsRetrieves the requests status object that represents Unit's instance [request statistics] (https://unit.nginx.org/statusapi/).
  • GETRetrieve the total requests number/status/requests/totalRetrieves the total requests number that represents Unit's instance request statistics.
  • GETRetrieve the applications status object/status/applicationsRetrieves the applications status object that represents Unit's per-app process and request statistics.
  • GETRetrieve the app status object/status/applications/:appNameRetrieves the app status object that represents Unit's per-app process and request statistics.
  • GETRetrieve the processes app status object/status/applications/:appName/processesRetrieves the processes app status object that represents Unit's per-app process statistics.
  • GETRetrieve the running processes app status number/status/applications/:appName/processes/runningRetrieves the running processes number that represents Unit's per-app process statistics.
  • GETRetrieve the starting processes app status number/status/applications/:appName/processes/startingRetrieves the starting processes number that represents Unit's per-app process statistics.
  • GETRetrieve the idle processes app status number/status/applications/:appName/processes/idleRetrieves the idle processes number that represents Unit's per-app process statistics.
  • GETRetrieve the requests app status object/status/applications/:appName/requestsRetrieves the requests app status object that represents Unit's per-app request statistics.
  • GETRetrieve the active requests app status number/status/applications/:appName/requests/activeRetrieves the active requests number that represents Unit's per-app request statistics.

applications

  • GETRetrieve the applications object/config/applicationsRetrieves the applications object that represents Unit's applications.
  • PUTOverwrite the applications object/config/applicationsOverwrites the applications object in the configuration.
  • DELETEDelete the applications object/config/applicationsDeletes the applications object from the configuration.
  • GETRetrieve an application object/config/applications/:appNameRetrieves the {appName} object that represents an application in Unit's control API.
  • PUTCreate or overwrite the application object/config/applications/:appNameCreates or overwrites the {appName} object in the configuration.
  • DELETEDelete the application object/config/applications/:appNameDeletes the {appName} object from the configuration.

API details

Base URL
http://{server}:{port}
Authentication
None declared in the description
Operations
184 operations on 88 pathsGET 88PUT 48DELETE 43POST 5
Main resources
config 142settings 71listeners 50tls 23certificates 21status 20xff 17access log 9applications 6routes 3
Response formats
application/json application/jsons
Description format
OpenAPI 3.0.0, API version 0.2.0

How to test the NGINX Unit 1.35.0 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the NGINX Unit 1.35.0 collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Retrieve the access log” (GET /config/access_log), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the NGINX Unit 1.35.0?

NGINX Unit is a lightweight and versatile application runtime that provides the essential components for your web application as a single open-source server:… It is listed under Developer tools and has 184 endpoints.

Who publishes the NGINX Unit 1.35.0?

It is listed from NGINX Unit's public API description (an OpenAPI document), not published by NGINX Unit on Swastik Codes. Anyone who controls unit.nginx.org can claim the profile by adding a DNS TXT record.

What is the base URL of the NGINX Unit 1.35.0?

Requests go to http://{server}:{port}. Endpoint paths are added to this base URL.

How do I authenticate with the NGINX Unit 1.35.0?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the NGINX Unit 1.35.0 have?

184 operations on 88 paths (88 GET, 48 PUT, 43 DELETE, 5 POST). The largest groups are config, settings, listeners, tls.

Is forking the NGINX Unit 1.35.0 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.