Jump to

• Request
• Response

Join a Peer to a Channel

post

/console/admin/api/v1.1/nodes/peers/{peerId}/joinChannel

You can add a peer node to a channel so that the node can use it to exchange private transaction information with other peer nodes on the channel.

Request

Supported Media Types

• application/json

Path Parameters

• peerId: string
  ID of peer to join the channel

Body ()

Channel name

Root Schema : joinChannel

Type: object

Show Source

• channelName(optional): string

{
    "type":"object",
    "properties":{
        "channelName":{
            "type":"string"
        }
    },
    "example":{
        "channelName":"mychannel1"
    }
}

Example:

{
    "channelName":"mychannel1"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Peer joined channel successfully

Body ()

Root Schema : 200successModels

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "example":{
        "status":"success"
    }
}

Example:

{
    "status":"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

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