All URIs are relative to http://localhost/api/v2.0
Method | HTTP request | Description |
---|---|---|
GetConfigurations | Get /configurations | Get system configurations. |
GetInternalconfig | Get /internalconfig | Get internal configurations. |
UpdateConfigurations | Put /configurations | Modify system configurations. |
ConfigurationsResponse GetConfigurations(ctx, optional) Get system configurations.
This endpoint is for retrieving system configurations that only provides for admin user.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
optional | *ConfigureApiGetConfigurationsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ConfigureApiGetConfigurationsOpts struct
Name | Type | Description | Notes |
---|---|---|---|
xRequestId | optional.String | An unique ID for the request |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InternalConfigurationsResponse GetInternalconfig(ctx, optional) Get internal configurations.
This endpoint is for retrieving system configurations that only provides for internal api call.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
optional | *ConfigureApiGetInternalconfigOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ConfigureApiGetInternalconfigOpts struct
Name | Type | Description | Notes |
---|---|---|---|
xRequestId | optional.String | An unique ID for the request |
InternalConfigurationsResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateConfigurations(ctx, configurations, optional) Modify system configurations.
This endpoint is for modifying system configurations that only provides for admin user.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
configurations | Configurations | The configuration map can contain a subset of the attributes of the schema, which are to be updated. | |
optional | *ConfigureApiUpdateConfigurationsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ConfigureApiUpdateConfigurationsOpts struct
Name | Type | Description | Notes |
---|
xRequestId | optional.String| An unique ID for the request |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]