Jump to

• Request
• Response

Install a Chaincode

post

/console/admin/api/v1.1/chaincodes

Installs a chaincode on a specified peer. The chaincode must be BASE64 encoded zip file.

Request

Supported Media Types

• application/json

Body ()

Root Schema : installChaincode

Type: object

Show Source

• chaincodeId(optional): string
• chaincodeVersion(optional): string
• peers(optional): array peers
• source(optional): object source

{
    "type":"object",
    "properties":{
        "source":{
            "type":"object",
            "properties":{
                "content":{
                    "type":"string",
                    "description":"The content should be a base64-encoded string of chaincode, which could be a source file or zip package"
                },
                "fileName":{
                    "type":"string"
                }
            }
        },
        "chaincodeId":{
            "type":"string"
        },
        "chaincodeVersion":{
            "type":"string"
        },
        "peers":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "url":{
                        "type":"string"
                    }
                }
            }
        }
    },
    "example":{
        "source":{
            "fileName":"example_cc",
            "content":"example chaincode code (BASE64 encoded)"
        },
        "chaincodeId":"exampleChaincodeId",
        "chaincodeVersion":"v1",
        "peers":[
            {
                "url":"grpcs://peer0.org1.example.com:7051"
            }
        ]
    }
}

Example:

{
    "source":{
        "fileName":"example_cc",
        "content":"example chaincode code (BASE64 encoded)"
    },
    "chaincodeId":"exampleChaincodeId",
    "chaincodeVersion":"v1",
    "peers":[
        {
            "url":"grpcs://peer0.org1.example.com:7051"
        }
    ]
}

Nested Schema : peers

Type: array

Show Source

• Array of: object items

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

Nested Schema : source

Type: object

Show Source

• content(optional): string
  The content should be a base64-encoded string of chaincode, which could be a source file or zip package
• fileName(optional): string

{
    "type":"object",
    "properties":{
        "content":{
            "type":"string",
            "description":"The content should be a base64-encoded string of chaincode, which could be a source file or zip package"
        },
        "fileName":{
            "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

Installed 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"
}

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

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