Jump to

• Request
• Response
• Examples

Export Nodes

get

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

Export a node. nodeType specifies a node type list to be exported. nodes specifies an object which points out which nodes to be exported.

Request

Supported Media Types

• application/json

Query Parameters

• nodeType: string
  Types of nodes to export

  Default Value: ["peer"]
• nodes(optional): string
  Nodes to export

  Default Value: {"peers":["defaultPeerId"]}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Nodes exported successfully

Body ()

Root Schema : exportedNodes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "organization":{
                "type":"string"
            },
            "nodes":{
                "type":"object",
                "properties":{
                    "peers":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "peerId":{
                                    "type":"string"
                                },
                                "displayName":{
                                    "type":"string"
                                },
                                "url":{
                                    "type":"string"
                                },
                                "eventUrl":{
                                    "type":"string"
                                },
                                "mspId":{
                                    "type":"string"
                                },
                                "joinedChannels":{
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                },
                                "installedChaincodes":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "name":{
                                                "type":"string"
                                            },
                                            "version":{
                                                "type":"string"
                                            },
                                            "path":{
                                                "type":"string"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "tlsCACert":{
                "type":"string"
            },
            "signature":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• nodes(optional): object nodes
• organization(optional): string
• signature(optional): string
• tlsCACert(optional): string

{
    "type":"object",
    "properties":{
        "organization":{
            "type":"string"
        },
        "nodes":{
            "type":"object",
            "properties":{
                "peers":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "peerId":{
                                "type":"string"
                            },
                            "displayName":{
                                "type":"string"
                            },
                            "url":{
                                "type":"string"
                            },
                            "eventUrl":{
                                "type":"string"
                            },
                            "mspId":{
                                "type":"string"
                            },
                            "joinedChannels":{
                                "type":"array",
                                "items":{
                                    "type":"string"
                                }
                            },
                            "installedChaincodes":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "name":{
                                            "type":"string"
                                        },
                                        "version":{
                                            "type":"string"
                                        },
                                        "path":{
                                            "type":"string"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "tlsCACert":{
            "type":"string"
        },
        "signature":{
            "type":"string"
        }
    }
}

Nested Schema : nodes

Type: object

Show Source

• peers(optional): array peers

{
    "type":"object",
    "properties":{
        "peers":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "peerId":{
                        "type":"string"
                    },
                    "displayName":{
                        "type":"string"
                    },
                    "url":{
                        "type":"string"
                    },
                    "eventUrl":{
                        "type":"string"
                    },
                    "mspId":{
                        "type":"string"
                    },
                    "joinedChannels":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "installedChaincodes":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "name":{
                                    "type":"string"
                                },
                                "version":{
                                    "type":"string"
                                },
                                "path":{
                                    "type":"string"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : peers

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "peerId":{
                "type":"string"
            },
            "displayName":{
                "type":"string"
            },
            "url":{
                "type":"string"
            },
            "eventUrl":{
                "type":"string"
            },
            "mspId":{
                "type":"string"
            },
            "joinedChannels":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "installedChaincodes":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "name":{
                            "type":"string"
                        },
                        "version":{
                            "type":"string"
                        },
                        "path":{
                            "type":"string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• displayName(optional): string
• eventUrl(optional): string
• installedChaincodes(optional): array installedChaincodes
• joinedChannels(optional): array joinedChannels
• mspId(optional): string
• peerId(optional): string
• url(optional): string

{
    "type":"object",
    "properties":{
        "peerId":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "url":{
            "type":"string"
        },
        "eventUrl":{
            "type":"string"
        },
        "mspId":{
            "type":"string"
        },
        "joinedChannels":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "installedChaincodes":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string"
                    },
                    "version":{
                        "type":"string"
                    },
                    "path":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : installedChaincodes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string"
            },
            "version":{
                "type":"string"
            },
            "path":{
                "type":"string"
            }
        }
    }
}

Nested Schema : joinedChannels

Type: array

Show Source

• Array of: string

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

Nested Schema : items

Type: object

Show Source

• name(optional): string
• path(optional): string
• version(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "path":{
            "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

Examples

The following example shows how to export a peer node by submitting a GET request on the REST resource using cURL.

curl -u <username>:<password>\
 -X GET -k -g -H "Content-Type: application/x-www-form-urlencoded" -H
      "Authorization: Basic xxxxxxxxxxxxxxxxxxxxxxxxxx=="
      'https://<rest_server_url:port>/console/admin/api/v1.1/nodes/export?nodeType=["peer"]&nodes={"peers":["xxxxxxxxdevp2peer0","xxxxxxxxdevp2peer1"]}'
 

Back to Top