REST API for Oracle Blockchain Platform Enterprise Edition

Get REST Proxy Node Configuration

get

/console/admin/api/v2/nodes/restproxies/{restProxyId}

A REST proxy node's configuration determines how the node performs and behaves on the network. Use this endpoint to get a REST proxy node configuration.

Request

Supported Media Types

application/json

Path Parameters

restProxyId(required): string

Unique ID of the REST proxy node

Response

Supported Media Types

application/json

200 Response

REST Proxy configuration

Root Schema : restProxyConfig

Type: object

Show Source

channels(required): array channels
logLevel: string

Allowed Values: [ "INFO", "DEBUG", "WARNING", "ERROR" ]
logTransactionEvents: boolean

Default Value: false
proposalWaitTime(required): integer(int32)

Default Value: 60000

Example: 60000
RESTProxyId(required): string
transactionWaitTime(required): integer(int32)

Default Value: 300000

Example: 300000

{
    "type":"object",
    "required":[
        "RESTProxyId",
        "proposalWaitTime",
        "transactionWaitTime",
        "channels"
    ],
    "properties":{
        "RESTProxyId":{
            "type":"string"
        },
        "proposalWaitTime":{
            "type":"integer",
            "format":"int32",
            "example":"60000",
            "default":"60000"
        },
        "transactionWaitTime":{
            "type":"integer",
            "format":"int32",
            "example":"300000",
            "default":"300000"
        },
        "logLevel":{
            "type":"string",
            "enum":[
                "INFO",
                "DEBUG",
                "WARNING",
                "ERROR"
            ]
        },
        "logTransactionEvents":{
            "type":"boolean",
            "default":false
        },
        "channels":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "example":"mychannel"
                    },
                    "chaincodes":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "name":{
                                    "type":"string"
                                },
                                "endorsers":{
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                }
                            }
                        },
                        "example":[
                            {
                                "name":"mycc",
                                "endorsers":[
                                    "peer0.org1.example.com",
                                    "peer1.org1.example.com"
                                ]
                            }
                        ]
                    }
                }
            }
        }
    }
}

Nested Schema : channels

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string",
                "example":"mychannel"
            },
            "chaincodes":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "name":{
                            "type":"string"
                        },
                        "endorsers":{
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        }
                    }
                },
                "example":[
                    {
                        "name":"mycc",
                        "endorsers":[
                            "peer0.org1.example.com",
                            "peer1.org1.example.com"
                        ]
                    }
                ]
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

chaincodes: array chaincodes
name: string

Example: mychannel

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "example":"mychannel"
        },
        "chaincodes":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string"
                    },
                    "endorsers":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                }
            },
            "example":[
                {
                    "name":"mycc",
                    "endorsers":[
                        "peer0.org1.example.com",
                        "peer1.org1.example.com"
                    ]
                }
            ]
        }
    }
}

Nested Schema : chaincodes

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string"
            },
            "endorsers":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        }
    },
    "example":[
        {
            "name":"mycc",
            "endorsers":[
                "peer0.org1.example.com",
                "peer1.org1.example.com"
            ]
        }
    ]
}

Example:

[
    {
        "name":"mycc",
        "endorsers":[
            "peer0.org1.example.com",
            "peer1.org1.example.com"
        ]
    }
]

Nested Schema : items

Type: object

Show Source

endorsers: array endorsers
name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "endorsers":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : endorsers

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Invalid argument

Root Schema : 400errorModels

Type: object

Show Source

key: string
value: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "example":{
        "respMesg":"invalid argument"
    }
}

Example:

{
    "respMesg":"invalid argument"
}

401 Response

Unauthorized

500 Response

Internal server error

Root Schema : 500errorModels

Type: object

Show Source

key: string
value: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Default Response

Unexpected error

Root Schema : errorModel

Type: object

Show Source

code(required): integer(int32)
message(required): string

{
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "type":"string"
        }
    }
}