Jump to

• Request
• Response

Stop a Peer

post

/console/admin/api/v2/nodes/peers/{peerId}/stop

Stop designated peers.

Request

Supported Media Types

• application/json

Path Parameters

• peerId: string
  Peer ID

Back to Top

Response

Supported Media Types

• application/json

200 Response

Action result message

Body ()

Root Schema : schema

Type: object

Show Source

• status(optional): string
  Allowed Values: [ "down" ]

  Example: down

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"down",
            "enum":[
                "down"
            ]
        }
    }
}

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

404 Response

Not found

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