Jump to

• Request
• Response

Get Channel List

get

/console/admin/api/v2/channels

Get a list of channels, optionally filtering by whether they have a given chaincode instantiated or a given peer joined. If a chaincode is specified, channels on which chaincodes with the same name are committed will be returned. If peerId is specified, channels which this peer has joined will be returned.

Request

Supported Media Types

• application/json

Query Parameters

• chaincode(optional): string
  Get channels on which chaincodes with the same name are committed
• peerId(optional): string
  Get channels which this peer has joined

Back to Top

Response

Supported Media Types

• application/json

200 Response

List of channels meeting query criteria

Body ()

Root Schema : channels

Type: array

Show Source

• Array of: object items

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

Nested Schema : items

Type: object

Show Source

• channelName(optional): string
• creator(optional): string
• mspIds(optional): array mspIds

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

Nested Schema : mspIds

Type: array

Show Source

• Array of: string

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

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

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