Channel

1. Create

POST api/v1/channels/

Create a channel

Body ParametersTypeNote
namestring
orderers arrayarray of orderers' id
peersarrayarray of peers'id

Example Request Body

{
    "name": "channel1",
    "orderers": [
        "edc9a85c-c9d8-44d1-a246-53a15e73eb23"
    ],
    "peers": [
        "6b103991-dc4b-42b3-a9b3-8d11d449b194"
    ]

Example Response Body

{
    "data": {
        "id": "89cab0f6-47a8-4335-b217-7ec39cfcf65f"
    },
    "msg": null,
    "status": "successful"
}


2. List

GET api/v1/channels/

List channel which the organizaion_id

Query ParametersTypeNote
pageint
per_pageint

Example Respone Body

{
    "data": {
        "total": 1,
        "data": [
            {
                "id": "89cab0f6-47a8-4335-b217-7ec39cfcf65f",
                "name": "channel1",
                "network": {
                    "id": "bfb3484d-dc5c-4cc4-8be0-0251eefd2c57",
                    "name": "test1"
                },
                "organizations": [
                    {
                        "id": "76ebf68b-019f-45ff-abef-67e3a3d1752f",
                        "name": "org1.cello.com"
                    }
                ],
                "create_ts": "2021-12-10T05:52:30.931971Z"
            }
        ]
    },
    "msg": null,
    "status": "successful"
}


3. Retrieve

GET api/v1/channels/{id}/

Get info on the channel

Path ParametersTypeNote
idUUIDchannel id

Example Response Body

{
    "data": {
        "id": "89cab0f6-47a8-4335-b217-7ec39cfcf65f",
        "name": "channel1",
        "network": {
            "id": "bfb3484d-dc5c-4cc4-8be0-0251eefd2c57",
            "name": "test1"
        },
        "organizations": [
            {
                "id": "76ebf68b-019f-45ff-abef-67e3a3d1752f",
                "name": "org1.cello.com"
            }
        ],
        "create_ts": "2021-12-10T05:52:30.931971Z"
    },
    "msg": null,
    "status": "successful"
}


4. Add organization

5. Delete Organization

6. Export Configuration

GET api/v1/channels/:channel_id/config

Download the configuration block file

Path ParametersTypeNote
idUUIDchannel id


https://github.com/hyperledger/cello/pull/479