Jump to

• Request
• Response

Start an Orderer Node

post

/console/admin/api/v1.1/nodes/orderers/{ordererId}/start

Start an orderer node. This should be done after any changes are made to the node.

On Oracle Cloud Infrastructure (Gen 2) you must specify the content length using the -H "content-length: 0" parameter.

Request

Supported Media Types

• application/json

Path Parameters

• ordererId: string
  ID of orderer being started

Back to Top

Response

Supported Media Types

• application/json

200 Response

Orderer status

Body ()

Root Schema : schema

Type: object

Example:

{
    "status":"up"
}

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