Jump to

• Request
• Response

Get Channel Information

get

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

You can query by channel name to get information for a channel.

Request

Supported Media Types

• application/json

Path Parameters

• channelName: string
  Channel name

Back to Top

Response

Supported Media Types

• application/json

200 Response

Information for the channel

Body ()

Root Schema : channelinfo

Type: object

Show Source

• ACL(optional): object ACL
• orgUnits(optional): object orgUnits

{
    "type":"object",
    "properties":{
        "orgUnits":{
            "type":"object",
            "properties":{
                "MSPs":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "type":"string"
                            }
                        }
                    }
                },
                "anchorpeers":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            },
            "example":{
                "MSPs":[
                    {
                        "id":"org1MSP"
                    }
                ],
                "anchorpeers":[
                ]
            }
        },
        "ACL":{
            "type":"object"
        }
    }
}

Nested Schema : ACL

Type: object

Nested Schema : orgUnits

Type: object

Show Source

• anchorpeers(optional): array anchorpeers
• MSPs(optional): array MSPs

{
    "type":"object",
    "properties":{
        "MSPs":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "type":"string"
                    }
                }
            }
        },
        "anchorpeers":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "example":{
        "MSPs":[
            {
                "id":"org1MSP"
            }
        ],
        "anchorpeers":[
        ]
    }
}

Example:

{
    "MSPs":[
        {
            "id":"org1MSP"
        }
    ],
    "anchorpeers":[
    ]
}

Nested Schema : anchorpeers

Type: array

Show Source

• Array of: string

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

Nested Schema : MSPs

Type: array

Show Source

• Array of: object items

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

Nested Schema : items

Type: object

Show Source

• id(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

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

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