Previous Next JavaScript must be enabled to correctly display this content

## topology validate

post

/V0/nosql/admin/topology#validate

Validates the specified topology. If no `name` is provided, the current topology is validated. Validation generates violations and notes.

Violations are issues that can cause problems and should be investigated. Notes are informational and highlight configuration oddities that could be potential issues or may be expected.

### Request

There are no request parameters for this operation.

Supported Media Types

- application/json

Request Body - application/json ()
Root Schema : schema
Type: `object`
Show Source

- arguments(required): array arguments
- command(required): string
  Allowed Values: `[ "validate" ]`

    {
        "required":[
            "command",
            "arguments"
        ],
        "properties":{
            "command":{
                "type":"string",
                "enum":[
                    "validate"
                ]
            },
            "arguments":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "argumentName":{
                            "type":"string"
                        },
                        "argumentValue":{
                            "oneOf":[
                                {
                                    "type":"string"
                                },
                                {
                                    "type":"boolean"
                                }
                            ]
                        }
                    }
                }
            }
        },
        "example":{
            "command":"validate",
            "arguments":[
                {
                    "name":"Name of the topology to validate"
                }
            ]
        }
    }

Example:

    {
        "command":"validate",
        "arguments":[
            {
                "name":"Name of the topology to validate"
            }
        ]
    }

Nested Schema : arguments
Type: `array`
Show Source

- Array of: object items

    {
        "type":"array",
        "items":{
            "type":"object",
            "properties":{
                "argumentName":{
                    "type":"string"
                },
                "argumentValue":{
                    "oneOf":[
                        {
                            "type":"string"
                        },
                        {
                            "type":"boolean"
                        }
                    ]
                }
            }
        }
    }

Nested Schema : items
Type: `object`
Show Source

- argumentName: string
- argumentValue: argumentValue

    {
        "type":"object",
        "properties":{
            "argumentName":{
                "type":"string"
            },
            "argumentValue":{
                "oneOf":[
                    {
                        "type":"string"
                    },
                    {
                        "type":"boolean"
                    }
                ]
            }
        }
    }

Nested Schema : argumentValue
Match One Schema
Show Source

- string
- boolean

    {
        "oneOf":[
            {
                "type":"string"
            },
            {
                "type":"boolean"
            }
        ]
    }

Back to Top

### Response

Supported Media Types

- application/json

#### 200 Response

Operation ended successfully
Body ()
Root Schema : commonResponse
Type: `object`
Show Source

- description(required): string
- operation(required): string
- returnCode(required): string
- returnValue(required): object returnValue

    {
        "properties":{
            "operation":{
                "type":"string"
            },
            "returnCode":{
                "type":"string"
            },
            "description":{
                "type":"string"
            },
            "returnValue":{
                "type":"object"
            }
        },
        "example":{
            "operation":"operation executed",
            "returnCode":"5000 when success, 5100 infers illegal command, 5200 - 5500 infers connection/resource/internal problem at execution",
            "description":"error description when returnCode != 5000",
            "returnValue":"JSON object with the output returned by the command when returnCode: 5000(success). Otherwise, null"
        },
        "required":[
            "operation",
            "returnCode",
            "description",
            "returnValue"
        ]
    }

Example:

    {
        "operation":"operation executed",
        "returnCode":"5000 when success, 5100 infers illegal command, 5200 - 5500 infers connection/resource/internal problem at execution",
        "description":"error description when returnCode != 5000",
        "returnValue":"JSON object with the output returned by the command when returnCode: 5000(success). Otherwise, null"
    }

Nested Schema : returnValue
Type: `object`
Back to Top