diff --git a/config_defaults.json b/config_defaults.json index bfdfcf3c8..b3dd7c7a7 100644 --- a/config_defaults.json +++ b/config_defaults.json @@ -60,7 +60,8 @@ "/api/core/v3/rewards*", "/api/core/v3/committee", "/api/debug/v2/*", - "/api/indexer/v2/*" + "/api/indexer/v2/*", + "/api/mqtt/v2" ], "protectedRoutes": [ "/api/*" diff --git a/documentation/docs/references/configuration.md b/documentation/docs/references/configuration.md index df3d0e2a2..be605103c 100644 --- a/documentation/docs/references/configuration.md +++ b/documentation/docs/references/configuration.md @@ -176,19 +176,19 @@ Example: ## 5. RestAPI -| Name | Description | Type | Default value | -| --------------------------- | ---------------------------------------------------------------------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| enabled | Whether the REST API plugin is enabled | boolean | true | -| bindAddress | The bind address on which the REST API listens on | string | "0.0.0.0:8080" | -| publicRoutes | The HTTP REST routes which can be called without authorization. Wildcards using \* are allowed | array | /health
/api/routes
/api/core/v3/info
/api/core/v3/blocks\*
/api/core/v3/transactions\*
/api/core/v3/commitments\*
/api/core/v3/outputs\*
/api/core/v3/accounts\*
/api/core/v3/validators\*
/api/core/v3/rewards\*
/api/core/v3/committee
/api/debug/v2/\*
/api/indexer/v2/\* | -| protectedRoutes | The HTTP REST routes which need to be called with authorization. Wildcards using \* are allowed | array | /api/\* | -| debugRequestLoggerEnabled | Whether the debug logging for requests should be enabled | boolean | false | -| allowIncompleteBlock | Whether the node allows to fill in incomplete block and issue it for user | boolean | false | -| maxPageSize | The maximum number of results per page | uint | 100 | -| [jwtAuth](#restapi_jwtauth) | Configuration for jwtAuth | object | | -| [limits](#restapi_limits) | Configuration for limits | object | | -| blockIssuerAccount | The accountID of the account that will issue the blocks | string | "" | -| blockIssuerPrivateKey | The private key of the account that will issue the blocks | string | "" | +| Name | Description | Type | Default value | +| --------------------------- | ---------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| enabled | Whether the REST API plugin is enabled | boolean | true | +| bindAddress | The bind address on which the REST API listens on | string | "0.0.0.0:8080" | +| publicRoutes | The HTTP REST routes which can be called without authorization. Wildcards using \* are allowed | array | /health
/api/routes
/api/core/v3/info
/api/core/v3/blocks\*
/api/core/v3/transactions\*
/api/core/v3/commitments\*
/api/core/v3/outputs\*
/api/core/v3/accounts\*
/api/core/v3/validators\*
/api/core/v3/rewards\*
/api/core/v3/committee
/api/debug/v2/\*
/api/indexer/v2/\*
/api/mqtt/v2 | +| protectedRoutes | The HTTP REST routes which need to be called with authorization. Wildcards using \* are allowed | array | /api/\* | +| debugRequestLoggerEnabled | Whether the debug logging for requests should be enabled | boolean | false | +| allowIncompleteBlock | Whether the node allows to fill in incomplete block and issue it for user | boolean | false | +| maxPageSize | The maximum number of results per page | uint | 100 | +| [jwtAuth](#restapi_jwtauth) | Configuration for jwtAuth | object | | +| [limits](#restapi_limits) | Configuration for limits | object | | +| blockIssuerAccount | The accountID of the account that will issue the blocks | string | "" | +| blockIssuerPrivateKey | The private key of the account that will issue the blocks | string | "" | ### JwtAuth @@ -223,7 +223,8 @@ Example: "/api/core/v3/rewards*", "/api/core/v3/committee", "/api/debug/v2/*", - "/api/indexer/v2/*" + "/api/indexer/v2/*", + "/api/mqtt/v2" ], "protectedRoutes": [ "/api/*"