Drain and Remove Cw VM by Id - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Drain and Remove Cw VM by Id","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/e7cf6406-31b8-3f42-91c0-19f86a4708d2","info":{"title":"Crosswork VM Node Install APIs","description":"Crosswork VM Node Install APIs allow users to add and delete nodes.","version":"3.0.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/VM_INSTALL/vm-install-overview.md"}},"swagger":"2.0","basePath":"/crosswork/platform/v1","schemes":["http","https"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Bearer token for API authentication."}}},"spec":{"description":"Drain and remove from the cluster the VM identified by its Id. This does not destroy the VM.","summary":"Drain and Remove Cw VM by Id","operationId":"CwVmMangager_DrainRemoveVM","responses":{"200":{"description":"A successful response.","schema":{"type":"object","properties":{"Result":{"description":"ResultValue indicates the success/failure for the requested operation.","type":"string","enum":["NOOP","SUCCESS","FAILURE"],"default":"NOOP","example":"SUCCESS","$$ref":"#/definitions/install_apiResultValue"},"Description":{"type":"string","title":"Addional response information"},"ResultMap":{"type":"object","additionalProperties":{"type":"string"},"title":"Supplementary keyed response info for the operation (for example: version number, error message)"},"ResultString":{"type":"array","items":{"type":"string"},"title":"Simple result string"},"Id":{"type":"string","title":"Resource Identifier returned by operation, if any"}},"description":"OpResult is used to indicate whether an operation has been accepted or not. A string or map payload provides the additional response information (for example: version number, error data).","example":{"Result":"SUCCESS","Description":"Operation completed successfully.","ResultMap":{"version":"1.0","message":"No errors"},"ResultString":["Operation successful"],"Id":"resource-123"},"$$ref":"#/definitions/install_apiOpResult"}},"default":{"description":"An unexpected error response.","schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"type_url":{"type":"string"},"value":{"type":"string","format":"byte"}},"example":{"type_url":"type.googleapis.com/google.protobuf.Any","value":"Error details in binary format"},"$$ref":"#/definitions/protobufAny"}}},"example":{"error":"RuntimeException","code":500,"message":"An unexpected error occurred during execution.","details":[{"type_url":"type.googleapis.com/google.protobuf.Any","value":"Error details in binary format"}]},"$$ref":"#/definitions/runtimeError"}}},"parameters":[{"name":"Id","description":"Id of service or app name or resource as assigned by Crossworks.","in":"path","required":true,"type":"string"}],"tags":["CwVmMangager"],"__originalOperationId":"CwVmMangager_DrainRemoveVM","consumes":["application/json"],"produces":["application/json"],"security":[{"bearerAuth":[]}],"method":"post","path":"/node-manager/vms/{Id}/remove"}}