Jump to

• Request
• Response

Set Orderer Service for an Organization

post

/console/admin/api/v2/organizations/{orgName}/setOrderingService

This endpoint sets the orderer service settings for a participant organization, including the MSP ID, certificates, and ordering service node addresses. This API is only available on the participant.

Request

Supported Media Types

• application/json

Path Parameters

• orgName: string
  Organization name

Body ()

Orderer setting information

Root Schema : ordererSettingInfo

Type: object

Show Source

• certs(optional): object certs
• mspId(optional): string
• orderingServiceNodes(optional): array orderingServiceNodes
• signature(optional): string

{
    "type":"object",
    "properties":{
        "mspId":{
            "type":"string"
        },
        "certs":{
            "type":"object",
            "properties":{
                "adminCert":{
                    "type":"string"
                },
                "CACert":{
                    "type":"string"
                },
                "tlsCACert":{
                    "type":"string"
                },
                "intermediateCerts":{
                    "type":"string"
                }
            }
        },
        "orderingServiceNodes":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "address":{
                        "type":"string"
                    },
                    "adminAddress":{
                        "type":"string"
                    }
                }
            }
        },
        "signature":{
            "type":"string"
        }
    }
}

Nested Schema : certs

Type: object

Show Source

• adminCert(optional): string
• CACert(optional): string
• intermediateCerts(optional): string
• tlsCACert(optional): string

{
    "type":"object",
    "properties":{
        "adminCert":{
            "type":"string"
        },
        "CACert":{
            "type":"string"
        },
        "tlsCACert":{
            "type":"string"
        },
        "intermediateCerts":{
            "type":"string"
        }
    }
}

Nested Schema : orderingServiceNodes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "address":{
                "type":"string"
            },
            "adminAddress":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• address(optional): string
• adminAddress(optional): string

{
    "type":"object",
    "properties":{
        "address":{
            "type":"string"
        },
        "adminAddress":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: object

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