Jump to

• Request
• Response

Update Channel Configuration (Deprecated in v19.1.3)

patch

/console/admin/api/v1.1/channels/{channelName}

You can modify a channel's configuration by supplying updated channel configuration information.

Request

Supported Media Types

• application/json

Path Parameters

• channelName: string
  Channel name

Body ()

Updated channel information

Root Schema : patchChannel

Type: object

Show Source

• organizations(optional): array organizations
• policies(optional): object policies

{
    "type":"object",
    "properties":{
        "organizations":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "mspId":{
                        "type":"string"
                    },
                    "certs":{
                        "type":"object",
                        "properties":{
                            "adminCert":{
                                "type":"string"
                            },
                            "CACert":{
                                "type":"string"
                            },
                            "tlsCACert":{
                                "type":"string"
                            }
                        }
                    },
                    "signature":{
                        "type":"string"
                    }
                }
            }
        },
        "policies":{
            "type":"object",
            "properties":{
                "readers":{
                    "type":"object",
                    "properties":{
                        "mspIds":{
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        }
                    }
                },
                "writers":{
                    "type":"object",
                    "properties":{
                        "mspIds":{
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        }
                    }
                }
            }
        }
    },
    "example":{
        "organizations":[
            {
                "name":"Org1MSP",
                "mspId":"Org1MSP",
                "certs":{
                    "adminCert":"example",
                    "CACert":"example",
                    "tlsCACert":"example"
                },
                "signature":"example"
            }
        ],
        "policies":{
            "readers":{
                "mspids":[
                    "org1",
                    "org2"
                ]
            },
            "writers":{
                "mspids":[
                    "org1",
                    "org2"
                ]
            }
        }
    }
}

Example:

{
    "organizations":[
        {
            "name":"Org1MSP",
            "mspId":"Org1MSP",
            "certs":{
                "adminCert":"example",
                "CACert":"example",
                "tlsCACert":"example"
            },
            "signature":"example"
        }
    ],
    "policies":{
        "readers":{
            "mspids":[
                "org1",
                "org2"
            ]
        },
        "writers":{
            "mspids":[
                "org1",
                "org2"
            ]
        }
    }
}

Nested Schema : organizations

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "mspId":{
                "type":"string"
            },
            "certs":{
                "type":"object",
                "properties":{
                    "adminCert":{
                        "type":"string"
                    },
                    "CACert":{
                        "type":"string"
                    },
                    "tlsCACert":{
                        "type":"string"
                    }
                }
            },
            "signature":{
                "type":"string"
            }
        }
    }
}

Nested Schema : policies

Type: object

Show Source

• readers(optional): object readers
• writers(optional): object writers

{
    "type":"object",
    "properties":{
        "readers":{
            "type":"object",
            "properties":{
                "mspIds":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "writers":{
            "type":"object",
            "properties":{
                "mspIds":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• certs(optional): object certs
• mspId(optional): string
• signature(optional): string

{
    "type":"object",
    "properties":{
        "mspId":{
            "type":"string"
        },
        "certs":{
            "type":"object",
            "properties":{
                "adminCert":{
                    "type":"string"
                },
                "CACert":{
                    "type":"string"
                },
                "tlsCACert":{
                    "type":"string"
                }
            }
        },
        "signature":{
            "type":"string"
        }
    }
}

Nested Schema : certs

Type: object

Show Source

• adminCert(optional): string
• CACert(optional): string
• tlsCACert(optional): string

{
    "type":"object",
    "properties":{
        "adminCert":{
            "type":"string"
        },
        "CACert":{
            "type":"string"
        },
        "tlsCACert":{
            "type":"string"
        }
    }
}

Nested Schema : readers

Type: object

Show Source

• mspIds(optional): array mspIds

{
    "type":"object",
    "properties":{
        "mspIds":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : writers

Type: object

Show Source

• mspIds(optional): array mspIds

{
    "type":"object",
    "properties":{
        "mspIds":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : mspIds

Type: array

Show Source

• Array of: string

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

Nested Schema : mspIds

Type: array

Show Source

• Array of: string

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

400 Response

Invalid argument

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

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