feature
The feature command returns information about amendments this server knows about, including whether they are enabled and if the server knows how to apply the amendments.
This is the non-admin version of the feature admin command. It follows the same formatting as the admin command, but hides potentially sensitive data.
Request Format
An example of the request format:
{
"command": "feature",
"feature": "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373"
}The request includes the following parameters:
Field | Type | Description |
|---|---|---|
feature | String | (Optional) The unique ID of an amendment, as hexadecimal; or the short name of the amendment. If provided, limits the response to one amendment. Otherwise, the response lists all amendments. |
Response Format
An example of a successful response:
{
"result": {
"4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373": {
"enabled": false,
"name": "MultiSign",
"supported": true
}
},
"status": "success",
"type": "response"
}The response follows the standard format, with a successful result containing a map of amendments as a JSON object. The keys of the object are amendment IDs. The values for each key are amendment objects that describe the status of the amendment with that ID. If the request specified a feature, the map contains only the requested amendment object, after applying any changes from the request. Each amendment object has the following fields:
Field | Type | Description |
|---|---|---|
enabled | Boolean | Whether this amendment is currently enabled in the latest ledger. |
name | String | (May be omitted) The human-readable name for this amendment, if known. |
supported | Boolean | Whether the server knows how to apply this amendment. If this field is set to false (the server does not know how to apply this amendment) and enabled is set to true (this amendment is enabled in the latest ledger), this amendment may cause your server to be amendment blocked. |
name for an amendment does not strictly indicate what that amendment does. The name is not guaranteed to be unique or consistent across servers.Possible Errors
- Any of the universal error types.
badFeature- Thefeaturespecified was invalidly formatted, or the server does not know an amendment with that name.noPermission- The server does not have permission to run the specified command. For example, this can occur if the request includes admin-only fields that are not allowed, such as thevetoedrequest parameter.reportingUnsupported- (Reporting Mode servers only) This method is not available in Reporting Mode.