Jump to

• Request
• Response

Get Node List

get

/console/admin/api/v1.1/nodes

Returns a node list by given node type.

Request

Supported Media Types

• application/json

Query Parameters

• nodeType(optional): string
  Node type

  Allowed Values: [ "CA", "PEER", "ORDERER", "RESTPROXY" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Nodes response

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object nodes

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/nodes"
    }
}

Nested Schema : nodes

Type: object

Show Source

• fabricCAs(optional): array fabricCAs
• orderers(optional): array orderers
• peers(optional): array peers
• RESTProxies(optional): array RESTProxies

{
    "type":"object",
    "properties":{
        "peers":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/peer"
            }
        },
        "orderers":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/orderer"
            }
        },
        "fabricCAs":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FabricCA"
            }
        },
        "RESTProxies":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RESTProxy"
            }
        }
    }
}

Nested Schema : fabricCAs

Type: array

Show Source

• Array of: object FabricCA

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/FabricCA"
    }
}

Nested Schema : orderers

Type: array

Show Source

• Array of: object orderer

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/orderer"
    }
}

Nested Schema : peers

Type: array

Show Source

• Array of: object peer

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/peer"
    }
}

Nested Schema : RESTProxies

Type: array

Show Source

• Array of: object RESTProxy

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/RESTProxy"
    }
}

Nested Schema : FabricCA

Type: object

Show Source

• displayName(optional): string
• fabricCAId(optional): string
• mspId(optional): string
• status(optional): string
  Allowed Values: [ "up", "down" ]
• url(optional): string

{
    "type":"object",
    "properties":{
        "fabricCAId":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "enum":[
                "up",
                "down"
            ]
        },
        "url":{
            "type":"string"
        },
        "mspId":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        }
    }
}

Nested Schema : orderer

Type: object

Show Source

• adminUrl(optional): string
• displayName(optional): string
• mspId(optional): string
• ordererId(optional): string
• status(optional): string
  Allowed Values: [ "up", "down" ]
• url(optional): string

{
    "type":"object",
    "properties":{
        "ordererId":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "enum":[
                "up",
                "down"
            ]
        },
        "url":{
            "type":"string"
        },
        "adminUrl":{
            "type":"string"
        },
        "mspId":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        }
    }
}

Nested Schema : peer

Type: object

Show Source

• displayName(optional): string
• eventUrl(optional): string
• mspId(optional): string
• peerId: string
• role(optional): string
  Allowed Values: [ "Member", "Admin" ]
• status(optional): string
  Allowed Values: [ "up", "down" ]
• url(optional): string

{
    "type":"object",
    "required":[
        "peerId"
    ],
    "properties":{
        "peerId":{
            "type":"string"
        },
        "mspId":{
            "type":"string"
        },
        "role":{
            "type":"string",
            "enum":[
                "Member",
                "Admin"
            ]
        },
        "status":{
            "type":"string",
            "enum":[
                "up",
                "down"
            ]
        },
        "url":{
            "type":"string"
        },
        "eventUrl":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        }
    }
}

Nested Schema : RESTProxy

Type: object

Show Source

• displayName(optional): string
• mspId(optional): string
• RESTProxyId(optional): string
• status(optional): string
• url(optional): string

{
    "type":"object",
    "properties":{
        "RESTProxyId":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "url":{
            "type":"string"
        },
        "mspId":{
            "type":"string"
        },
        "displayName":{
            "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