Configuration API

Golden 3.0.0 public API reference. Parameters, responses, and schemas for supported customer operations.

7 operations.

POST /api/configuration

Saves a configuration.

Operation ID: saveConfiguration

Saves indicated configuration. Requires the ADMIN role.

Security: bearerAuth

Request body

Configuration to save

Responses

GET /api/configuration/category/{category}

Retrieves a configuration by identifier.

Operation ID: listConfigurations

Retrieves a configuration with indicated identifier. Requires the ADMIN role.

Security: bearerAuth

Parameters

Responses

DELETE /api/configuration/category/{category}

Deletes configurations by category.

Operation ID: deleteConfigurationsByCategory

Locates all configurations for indicated category and deletes them. 404 when no configuration carries that category, like the delete by identifier. Requires the ADMIN role.

Security: bearerAuth

Parameters

Responses

GET /api/configuration/id/{id}

Retrieves a configuration by identifier.

Operation ID: getConfiguration

Retrieves a configuration with indicated identifier. Requires the ADMIN role.

Security: bearerAuth

Parameters

Responses

DELETE /api/configuration/id/{id}

Deletes a configuration by identifier.

Operation ID: deleteConfigurationById

Locates a configuration with indicated identifier and deletes it. Requires the ADMIN role.

Security: bearerAuth

Parameters

Responses

GET /api/configuration/openapi

Retrieves OpenAPI definition.

Operation ID: getOpenApi

Retrieves latest OpenAPI definition in JSON format. Restricted to authenticated users.

Security: bearerAuth

Responses

GET /api/configuration/version

Retrieves product version.

Operation ID: getVersion

Retrieves product version. Restricted to authenticated users.

Security: bearerAuth

Responses