Provenance API - Configuration Information

Note

This document has been machine translated.

This document describes configuration information. Some functions may refer to configuration information.
All executions use JSON-RPC v2.0.

prov.get_configs

Check the configuration. Values that are not private on the system will not be retrieved.
An example of a JSON-RPC request is shown below.

{
  "jsonrpc": "2.0",
  "method": "prov.get_configs",
  "params": {},
  "id": "provenance_jsonrpc_id"
}

The result of the execution returns an enumerated type (dictionary) of keys and values for the configuration.

{
  "id": "provenance_jsonrpc_id",
  "jsonrpc": "2.0",
  "result": {
    "TENANT_ID": "xxx",
    "TENANT_VERSION": "1.0"
  }
}

Parameters

No parameters can be specified.

prov.patch_config

Change the settings that can be edited on the system.
An example of a JSON-RPC request is shown below.

{
  "jsonrpc": "2.0",
  "method": "prov.patch_config",
  "params": {
    "key": "TARGET_KEY",
    "value": "VALUE"
  },
  "id": "provenance_jsonrpc_id"
}

An example of the execution result is shown below.

{
  "id": "provenance_jsonrpc_id",
  "jsonrpc": "2.0",
  "result": {
    "key": "xxx",
    "value": "xxx",
    "is_public": "xxx",
    "description": "xxx",
    "created_at": "2020-01-01T00:00:00+00:00",
    "updated_at": "2021-01-01T00:00:00+00:00"
  }
}

Parameters

The following parameters can be specified for params.

parameter name	data type	content	default value
key	string	variable name (uppercase)	required
value	string	setting value	required
value	string	set value	required