Jump to

• Request
• Response

Update REST Proxy Node Configuration

patch

/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 modify the REST proxy node configuration.

Request

Supported Media Types

• application/json

Path Parameters

• restProxyId: string
  ID of the REST proxy node

Body ()

The REST Proxy configuration object

Root Schema : restProxyWritableConfig

Type: object

Show Source

• channels(optional): array channels
• logLevel(optional): string
  Allowed Values: [ "INFO", "DEBUG", "WARNING", "ERROR" ]
• logTransactionEvents(optional): boolean
  Default Value: false
• proposalWaitTime(optional): integer(int32)
  Default Value: 60000

  Example: 60000
• transactionWaitTime(optional): integer(int32)
  Default Value: 300000

  Example: 300000

{
    "type":"object",
    "properties":{
        "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(optional): array chaincodes
• name(optional): 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(optional): array endorsers
• name(optional): 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"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Action result

Body ()

Root Schema : schema

Type: object

Example:

{
    "status":"SUCCESS",
    "message":"content"
}

400 Response

Invalid arguments

Body ()

Root Schema : 400errorModels

Type: object

Show Source

• key(optional): string
• value(optional): string

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

Example:

{
    "respMesg":"invalid argument"
}

401 Response

Unauthorized

403 Response

Forbidden

500 Response

Internal server error

Body ()

Root Schema : 500errorModels

Type: object

Show Source

• key(optional): string
• value(optional): string

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

Default Response

Unexpected error

Body ()

Root Schema : errorModel

Type: object

Show Source

• code: integer(int32)
• message: string

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

Back to Top