Jump to

• Request
• Response

Instantiate a Chaincode

post

/console/admin/api/v1.1/chaincodes/{chaincodeName}/instantiate

Instantiates a chaincode on a channel.

Request

Supported Media Types

• application/json

Path Parameters

• chaincodeName: string
  Name of the chaincode to instantiate.

Body ()

Information about where and how to instantiate the chaincode.

Root Schema : instantiateChaincode

Type: object

Show Source

• args(optional): array args
• chaincodeType(optional): string
  Allowed Values: [ "golang", "node", "java" ]
• chaincodeVersion(optional): string
• channelName(optional): string
• dataCollectionConfig(optional): array dataCollectionConfig
• endorsementPolicy(optional): object endorsementPolicy
• peers(optional): array peers
• transientMap(optional): object transientMap
• upgrade(optional): boolean

{
    "type":"object",
    "properties":{
        "channelName":{
            "type":"string"
        },
        "chaincodeVersion":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "transientMap":{
            "type":"object"
        },
        "endorsementPolicy":{
            "type":"object",
            "properties":{
                "identities":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "role":{
                                "type":"object",
                                "properties":{
                                    "name":{
                                        "type":"string",
                                        "enum":[
                                            "member",
                                            "admin"
                                        ]
                                    },
                                    "mspId":{
                                        "type":"string"
                                    }
                                }
                            }
                        }
                    }
                },
                "policy":{
                    "type":"object"
                }
            }
        },
        "dataCollectionConfig":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string"
                    },
                    "policy":{
                        "type":"string"
                    },
                    "requiredPeerCount":{
                        "type":"number"
                    },
                    "maxPeerCount":{
                        "type":"number"
                    },
                    "blockToLive":{
                        "type":"number"
                    }
                }
            }
        },
        "upgrade":{
            "type":"boolean"
        },
        "chaincodeType":{
            "type":"string",
            "enum":[
                "golang",
                "node",
                "java"
            ]
        },
        "peers":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "url":{
                        "type":"string"
                    }
                }
            }
        }
    },
    "example":{
        "channelName":"mychannel1",
        "chaincodeVersion":"v1",
        "transientMap":{
        },
        "endorsementPolicy":{
            "identities":[
            ],
            "policy":{
                "0-of":[
                ]
            }
        },
        "args":[
            "a",
            "100",
            "b",
            "200"
        ],
        "dataCollectionConfig":{
            "name":"",
            "policy":"",
            "requiredPeerCount":1,
            "maxPeerCount":2,
            "blockToLive":10
        },
        "chaincodeType":"golang",
        "peers":[
            {
                "url":"grpcs://peer0.org1.example.com:7051"
            }
        ]
    }
}

Example:

{
    "channelName":"mychannel1",
    "chaincodeVersion":"v1",
    "transientMap":{
    },
    "endorsementPolicy":{
        "identities":[
        ],
        "policy":{
            "0-of":[
            ]
        }
    },
    "args":[
        "a",
        "100",
        "b",
        "200"
    ],
    "dataCollectionConfig":{
        "name":"",
        "policy":"",
        "requiredPeerCount":1,
        "maxPeerCount":2,
        "blockToLive":10
    },
    "chaincodeType":"golang",
    "peers":[
        {
            "url":"grpcs://peer0.org1.example.com:7051"
        }
    ]
}

Nested Schema : args

Type: array

Show Source

• Array of: string

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

Nested Schema : dataCollectionConfig

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string"
            },
            "policy":{
                "type":"string"
            },
            "requiredPeerCount":{
                "type":"number"
            },
            "maxPeerCount":{
                "type":"number"
            },
            "blockToLive":{
                "type":"number"
            }
        }
    }
}

Nested Schema : endorsementPolicy

Type: object

Show Source

• identities(optional): array identities
• policy(optional): object policy

{
    "type":"object",
    "properties":{
        "identities":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "role":{
                        "type":"object",
                        "properties":{
                            "name":{
                                "type":"string",
                                "enum":[
                                    "member",
                                    "admin"
                                ]
                            },
                            "mspId":{
                                "type":"string"
                            }
                        }
                    }
                }
            }
        },
        "policy":{
            "type":"object"
        }
    }
}

Nested Schema : peers

Type: array

Show Source

• Array of: object items

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

Nested Schema : transientMap

Type: object

Nested Schema : items

Type: object

Show Source

• blockToLive(optional): number
• maxPeerCount(optional): number
• name(optional): string
• policy(optional): string
• requiredPeerCount(optional): number

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "policy":{
            "type":"string"
        },
        "requiredPeerCount":{
            "type":"number"
        },
        "maxPeerCount":{
            "type":"number"
        },
        "blockToLive":{
            "type":"number"
        }
    }
}

Nested Schema : identities

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "role":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "enum":[
                            "member",
                            "admin"
                        ]
                    },
                    "mspId":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : policy

Type: object

Nested Schema : items

Type: object

Show Source

• role(optional): object role

{
    "type":"object",
    "properties":{
        "role":{
            "type":"object",
            "properties":{
                "name":{
                    "type":"string",
                    "enum":[
                        "member",
                        "admin"
                    ]
                },
                "mspId":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : role

Type: object

Show Source

• mspId(optional): string
• name(optional): string
  Allowed Values: [ "member", "admin" ]

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "enum":[
                "member",
                "admin"
            ]
        },
        "mspId":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• url(optional): string

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Instantiated chaincode 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"
}

202 Response

In Progress

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