VMware Cloud Foundation API Reference Guide

3. Paths

3.1. Create a Cluster and add to an existing Domain

POST /v1/clusters

3.1.1. Parameters

Type	Name	Description	Schema
Body	clusterCreationSpec required	Cluster Creation Spec	ClusterCreationSpec

3.1.2. Responses

HTTP Code	Description	Schema
200	OK	Task
202	Accepted	Task
400	Bad Request	Error
500	InternalServerError	Error

3.1.3. Consumes

• application/json

3.1.4. Produces

• application/json

3.1.5. Tags

• Clusters

3.1.6. Security

Type	Name
basic	basicAuth

3.1.7. Example HTTP request

Request path

/v1/clusters

Request body

{
  "computeSpec" : {
    "clusterSpecs" : [ {
      "advancedOptions" : {
        "evcMode" : "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN",
        "highAvailability" : {
          "enabled" : true
        }
      },
      "datastoreSpec" : {
        "nfsDatastoreSpecs" : [ {
          "datastoreName" : "string",
          "nasVolume" : {
            "path" : "string",
            "readOnly" : true,
            "serverName" : [ "string" ],
            "userTag" : "string"
          }
        } ],
        "vsanDatastoreSpec" : {
          "datastoreName" : "string",
          "dedupAndCompressionEnabled" : true,
          "failuresToTolerate" : 0,
          "licenseKey" : "string"
        }
      },
      "hostSpecs" : [ {
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "string",
            "vdsName" : "string"
          } ]
        },
        "id" : "string",
        "licenseKey" : "string"
      } ],
      "name" : "string",
      "networkSpec" : {
        "nsxClusterSpec" : {
          "nsxTClusterSpec" : {
            "geneveVlanId" : 0
          },
          "nsxVClusterSpec" : {
            "licenseKey" : "string",
            "vdsNameForVxlanConfig" : "string",
            "vlanId" : 0
          }
        },
        "vdsSpecs" : [ {
          "name" : "string",
          "niocBandwidthAllocationSpecs" : [ {
            "niocTrafficResourceAllocation" : {
              "limit" : 0,
              "reservation" : 0
            },
            "type" : "string"
          } ],
          "portGroupSpecs" : [ {
            "name" : "string",
            "transportType" : "One among: MANAGEMENT, NFS, PUBLIC, VMOTION, VSAN"
          } ]
        } ]
      }
    } ]
  },
  "domainId" : "string"
}

3.1.8. Example HTTP response

Response 200

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 202

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.2. Get the Clusters

GET /v1/clusters

3.2.1. Responses

HTTP Code	Description	Schema
200	Ok	PageOfCluster
400	Bad Request	Error
500	InternalServerError	Error

3.2.2. Consumes

• application/json

3.2.3. Produces

• application/json

3.2.4. Tags

• Clusters

3.2.5. Security

Type	Name
basic	basicAuth

3.2.6. Example HTTP request

Request path

/v1/clusters

3.2.7. Example HTTP response

Response 200

{
  "elements" : [ {
    "hosts" : [ {
      "id" : "string"
    } ],
    "id" : "string",
    "name" : "string"
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.3. Validate the input spec for creating and adding a Cluster to an existing Domain

POST /v1/clusters/validations/creations

3.3.1. Parameters

Type	Name	Description	Schema
Body	clusterCreationSpec required	Cluster Creation Spec	ClusterCreationSpec

3.3.2. Responses

HTTP Code	Description	Schema
200	Ok	Validation
400	Bad Request	Error
500	InternalServerError	Error

3.3.3. Consumes

• application/json

3.3.4. Produces

• application/json

3.3.5. Tags

• Clusters

3.3.6. Security

Type	Name
basic	basicAuth

3.3.7. Example HTTP request

Request path

/v1/clusters/validations/creations

Request body

{
  "computeSpec" : {
    "clusterSpecs" : [ {
      "advancedOptions" : {
        "evcMode" : "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN",
        "highAvailability" : {
          "enabled" : true
        }
      },
      "datastoreSpec" : {
        "nfsDatastoreSpecs" : [ {
          "datastoreName" : "string",
          "nasVolume" : {
            "path" : "string",
            "readOnly" : true,
            "serverName" : [ "string" ],
            "userTag" : "string"
          }
        } ],
        "vsanDatastoreSpec" : {
          "datastoreName" : "string",
          "dedupAndCompressionEnabled" : true,
          "failuresToTolerate" : 0,
          "licenseKey" : "string"
        }
      },
      "hostSpecs" : [ {
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "string",
            "vdsName" : "string"
          } ]
        },
        "id" : "string",
        "licenseKey" : "string"
      } ],
      "name" : "string",
      "networkSpec" : {
        "nsxClusterSpec" : {
          "nsxTClusterSpec" : {
            "geneveVlanId" : 0
          },
          "nsxVClusterSpec" : {
            "licenseKey" : "string",
            "vdsNameForVxlanConfig" : "string",
            "vlanId" : 0
          }
        },
        "vdsSpecs" : [ {
          "name" : "string",
          "niocBandwidthAllocationSpecs" : [ {
            "niocTrafficResourceAllocation" : {
              "limit" : 0,
              "reservation" : 0
            },
            "type" : "string"
          } ],
          "portGroupSpecs" : [ {
            "name" : "string",
            "transportType" : "One among: MANAGEMENT, NFS, PUBLIC, VMOTION, VSAN"
          } ]
        } ]
      }
    } ]
  },
  "domainId" : "string"
}

3.3.8. Example HTTP response

Response 200

{
  "description" : "string",
  "executionStatus" : "One among: COMPLETED, FAILED, IN_PROGRESS",
  "id" : "string",
  "resultStatus" : "One among: FAILED, FAILED_WITH_WARNINGS, SUCCEEDED",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "resultStatus" : "One among: FAILED, SUCCEEDED",
    "severity" : "One among: ERROR, WARNING"
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.4. Get a Cluster

GET /v1/clusters/{id}

3.4.1. Parameters

Type	Name	Description	Schema
Path	id required	Cluster ID	string

3.4.2. Responses

HTTP Code	Description	Schema
200	Ok	Cluster
404	Cluster not found	Error
500	InternalServerError	Error

3.4.3. Consumes

• application/json

3.4.4. Produces

• application/json

3.4.5. Tags

• Clusters

3.4.6. Security

Type	Name
basic	basicAuth

3.4.7. Example HTTP request

Request path

/v1/clusters/string

3.4.8. Example HTTP response

Response 200

{
  "hosts" : [ {
    "id" : "string"
  } ],
  "id" : "string",
  "name" : "string"
}

Response 404

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.5. Delete a Cluster from a Domain if it has been previously initialized for deletion

DELETE /v1/clusters/{id}

3.5.1. Parameters

Type	Name	Description	Schema
Path	id required	Cluster ID	string

3.5.2. Responses

HTTP Code	Description	Schema
200	OK	Task
202	Accepted	Task
400	Bad Request	Error
404	Not Found	Error
500	InternalServerError	Error

3.5.3. Consumes

• application/json

3.5.4. Produces

• application/json

3.5.5. Tags

• Clusters

3.5.6. Security

Type	Name
basic	basicAuth

3.5.7. Example HTTP request

Request path

/v1/clusters/string

3.5.8. Example HTTP response

Response 200

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 202

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 404

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.6. Update a Cluster by adding or removing Hosts, or by marking for deletion

PATCH /v1/clusters/{id}

3.6.1. Parameters

Type	Name	Description	Schema
Path	id required	Cluster ID	string
Body	clusterUpdateSpec required	Cluster Update Data	ClusterUpdateSpec

3.6.2. Responses

HTTP Code	Description	Schema
200	Ok	Task
202	Accepted	Task
400	Bad Request	Error
404	Not Found	Error
500	InternalServerError	Error

3.6.3. Consumes

• application/json

3.6.4. Produces

• application/json

3.6.5. Tags

• Clusters

3.6.6. Security

Type	Name
basic	basicAuth

3.6.7. Example HTTP request

Request path

/v1/clusters/string

Request body

{
  "clusterCompactionSpec" : {
    "force" : true,
    "hosts" : [ {
      "id" : "string"
    } ]
  },
  "clusterExpansionSpec" : {
    "hostSpecs" : [ {
      "hostNetworkSpec" : {
        "vmNics" : [ {
          "id" : "string",
          "vdsName" : "string"
        } ]
      },
      "id" : "string",
      "licenseKey" : "string"
    } ]
  },
  "markForDeletion" : true
}

3.6.8. Example HTTP response

Response 200

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 202

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 404

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.7. Validate the spec to update a Cluster by adding or removing Hosts

POST /v1/clusters/{id}/validations/updates

3.7.1. Parameters

Type	Name	Description	Schema
Path	id required	Cluster ID	string
Body	clusterUpdateSpec required	clusterUpdateSpec	ClusterUpdateSpec

3.7.2. Responses

HTTP Code	Description	Schema
200	Ok	Validation
400	Bad Request	Error
404	Not Found	Error
500	InternalServerError	Error

3.7.3. Consumes

• application/json

3.7.4. Produces

• application/json

3.7.5. Tags

• Clusters

3.7.6. Security

Type	Name
basic	basicAuth

3.7.7. Example HTTP request

Request path

/v1/clusters/string/validations/updates

Request body

{
  "clusterCompactionSpec" : {
    "force" : true,
    "hosts" : [ {
      "id" : "string"
    } ]
  },
  "clusterExpansionSpec" : {
    "hostSpecs" : [ {
      "hostNetworkSpec" : {
        "vmNics" : [ {
          "id" : "string",
          "vdsName" : "string"
        } ]
      },
      "id" : "string",
      "licenseKey" : "string"
    } ]
  },
  "markForDeletion" : true
}

3.7.8. Example HTTP response

Response 200

{
  "description" : "string",
  "executionStatus" : "One among: COMPLETED, FAILED, IN_PROGRESS",
  "id" : "string",
  "resultStatus" : "One among: FAILED, FAILED_WITH_WARNINGS, SUCCEEDED",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "resultStatus" : "One among: FAILED, SUCCEEDED",
    "severity" : "One among: ERROR, WARNING"
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 404

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.8. Get the Credentials

GET /v1/credentials

3.8.1. Description

Get the Credentials

3.8.2. Parameters

Type	Name	Description	Schema
Header	privileged-password required	The privileged user password	string
Header	privileged-username required	The privileged user name	string
Query	domainName optional	The name of the domain to which the resource belongs to (may be null in case there is no associated domain)	string
Query	resourceIp optional	The IP address of the resource	string
Query	resourceName optional	The name of the resource	string
Query	resourceType optional	The type of the resource. One among: ESXI , SDDC_MANAGER , VCENTER , PSC , NSX_MANAGER , NSX_CONTROLLER , NSX_EDGE , NSXT_MANAGER , NSXT_CONTROLLER , NSXT_EDGE , VRLI , VROPS , LCM_REPO , VRA , VRSLCM , DEPOT_USER , VXRAIL_MANAGER , AD , BACKUP	string

3.8.3. Responses

HTTP Code	Description	Schema
200	OK	PageOfCredential
400	Bad Request	Error
401	Unauthorized	Error
403	Forbidden	Error
500	Internal Server Error	Error

3.8.4. Consumes

• application/json

3.8.5. Produces

• application/json

3.8.6. Tags

• Credentials

3.8.7. Security

Type	Name
basic	basicAuth

3.8.8. Example HTTP request

Request path

/v1/credentials

Request header

privileged-username:"string"

3.8.9. Example HTTP response

Response 200

{
  "elements" : [ {
    "credentialType" : "One among: SSO, SSH, API, BASIC_AUTH, ADMINISTRATOR, FTP, JDBC, LDAP_DOMAIN_ADMIN, LDAP_READ_WRITE_ACCOUNT, VDI_ADMIN, SQL_SUPER_USER, SQL_DB_OWNER, SERVICE_ACCOUNT",
    "id" : "string",
    "password" : "string",
    "resource" : {
      "domainName" : "string",
      "resourceId" : "string",
      "resourceIp" : "string",
      "resourceName" : "string",
      "resourceType" : "One among: ESXI , SDDC_MANAGER , VCENTER , PSC , NSX_MANAGER , NSX_CONTROLLER , NSX_EDGE , NSXT_MANAGER , NSXT_CONTROLLER , NSXT_EDGE , VRLI , VROPS , LCM_REPO , VRA , VRSLCM , DEPOT_USER , VXRAIL_MANAGER , AD , BACKUP",
      "serviceType" : "One among: ESXI , SDDC_MANAGER , VCENTER , PSC , NSX_MANAGER , NSX_CONTROLLER , NSX_EDGE , NSXT_MANAGER , NSXT_CONTROLLER , NSXT_EDGE , VRLI , VROPS , LCM_REPO , VRA , VRSLCM , DEPOT_USER , VXRAIL_MANAGER , AD , BACKUP",
      "targetType" : "One among: ESXI , SDDC_MANAGER , VCENTER , PSC , NSX_MANAGER , NSX_CONTROLLER , NSX_EDGE , NSXT_MANAGER , NSXT_CONTROLLER , NSXT_EDGE , VRLI , VROPS , LCM_REPO , VRA , VRSLCM , DEPOT_USER , VXRAIL_MANAGER , AD , BACKUP"
    },
    "username" : "string"
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 401

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 403

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.9. Update or rotate passwords for a list of resources

PATCH /v1/credentials

3.9.1. Description

Update passwords for given list of resources by supplying new passwords or rotate the passwords using system generated passwords

3.9.2. Parameters

Type	Name	Description	Schema
Header	privileged-password required	The privileged user password	string
Header	privileged-username required	The privileged user name	string
Body	credentialsUpdateSpec required	credentialsUpdateSpec	CredentialsUpdateSpec

3.9.3. Responses

HTTP Code	Description	Schema
200	OK	Task
202	Accepted	Task
400	Bad Request	Error
401	Unauthorized	Error
403	Forbidden	Error
500	Internal Server Error	Error

3.9.4. Consumes

• application/json

3.9.5. Produces

• application/json

3.9.6. Tags

• Credentials

3.9.7. Security

Type	Name
basic	basicAuth

3.9.8. Example HTTP request

Request path

/v1/credentials

Request header

privileged-username:"string"

Request body

{
  "elements" : [ {
    "credentials" : [ {
      "credentialType" : "One among: SSO, SSH, API, BASIC_AUTH, ADMINISTRATOR, FTP, JDBC, LDAP_DOMAIN_ADMIN, LDAP_READ_WRITE_ACCOUNT, VDI_ADMIN, SQL_SUPER_USER, SQL_DB_OWNER, SERVICE_ACCOUNT",
      "password" : "string",
      "username" : "string"
    } ],
    "resourceId" : "string",
    "resourceName" : "string",
    "resourceType" : "One among: ESXI , SDDC_MANAGER , VCENTER , PSC , NSX_MANAGER , NSX_CONTROLLER , NSX_EDGE , NSXT_MANAGER , NSXT_CONTROLLER , NSXT_EDGE , VRLI , VROPS , LCM_REPO , VRA , VRSLCM , DEPOT_USER , VXRAIL_MANAGER , AD , BACKUP"
  } ],
  "operationType" : "One among: UPDATE, ROTATE"
}

3.9.9. Example HTTP response

Response 200

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 202

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 401

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 403

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.10. Fetch the credentials tasks

GET /v1/credentials/tasks

3.10.1. Description

Fetch all credentials tasks in reverse chronological order

3.10.2. Parameters

Type	Name	Description	Schema
Query	limit optional	The number of elements to be returned in the result	integer (int32)

3.10.3. Responses

HTTP Code	Description	Schema
200	OK	PageOfCredentialsTask
400	Bad Request	Error
500	Internal Server Error	Error

3.10.4. Consumes

• application/json

3.10.5. Produces

• application/json

3.10.6. Tags

• Credentials

3.10.7. Security

Type	Name
basic	basicAuth

3.10.8. Example HTTP request

Request path

/v1/credentials/tasks

3.10.9. Example HTTP response

Response 200

{
  "elements" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "id" : "string",
    "name" : "string",
    "status" : "One among: PENDING, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT",
    "subTasks" : [ {
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "dependentSubTasks" : [ {
        "creationTimestamp" : {
          "epochSecond" : 0,
          "nano" : 0
        },
        "dependentSubTasks" : [ "..." ],
        "description" : "string",
        "errors" : [ {
          "arguments" : [ "string" ],
          "causes" : [ {
            "message" : "string",
            "type" : "string"
          } ],
          "context" : {
            "string" : "string"
          },
          "errorCode" : "string",
          "message" : "string",
          "nestedErrors" : [ "..." ],
          "referenceToken" : "string",
          "remediationMessage" : "string"
        } ],
        "name" : "string",
        "status" : "One among: PENDING, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT"
      } ],
      "description" : "string",
      "errors" : [ "..." ],
      "name" : "string",
      "status" : "One among: PENDING, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT"
    } ]
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.11. Fetch a credentials task

GET /v1/credentials/tasks/{id}

3.11.1. Description

Fetch credentials task for a given ID

3.11.2. Parameters

Type	Name	Description	Schema
Path	id required	The ID of the credentials task	string

3.11.3. Responses

HTTP Code	Description	Schema
200	OK	CredentialsTask
400	Bad Request	Error
500	Internal Server Error	Error

3.11.4. Consumes

• application/json

3.11.5. Produces

• application/json

3.11.6. Tags

• Credentials

3.11.7. Security

Type	Name
basic	basicAuth

3.11.8. Example HTTP request

Request path

/v1/credentials/tasks/string

3.11.9. Example HTTP response

Response 200

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "status" : "One among: PENDING, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "dependentSubTasks" : [ {
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "dependentSubTasks" : [ "..." ],
      "description" : "string",
      "errors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "name" : "string",
      "status" : "One among: PENDING, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT"
    } ],
    "description" : "string",
    "errors" : [ "..." ],
    "name" : "string",
    "status" : "One among: PENDING, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT"
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.12. Cancel a failed credentials task for a given ID

DELETE /v1/credentials/tasks/{id}

3.12.1. Description

Cancel a failed credentials task for a given ID

3.12.2. Parameters

Type	Name	Description	Schema
Path	id required	Task ID of the failed operation required to be cancelled	string

3.12.3. Responses

HTTP Code	Description	Schema
200	OK	Task
204	No content	Task
400	Bad Request	Error
500	Internal Server Error	Error

3.12.4. Consumes

• application/json

3.12.5. Produces

• application/json

3.12.6. Tags

• Credentials

3.12.7. Security

Type	Name
basic	basicAuth

3.12.8. Example HTTP request

Request path

/v1/credentials/tasks/string

3.12.9. Example HTTP response

Response 200

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 204

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.13. Retry a failed credentials task for a given ID

PATCH /v1/credentials/tasks/{id}

3.13.1. Description

Retry a failed credentials task for a given ID

3.13.2. Parameters

Type	Name	Description	Schema
Header	privileged-password required	The privileged user password	string
Header	privileged-username required	The privileged user name	string
Path	id required	Task ID of the failed operation that is to be retried	string
Body	credentialsUpdateSpec required	credentialsUpdateSpec	CredentialsUpdateSpec

3.13.3. Responses

HTTP Code	Description	Schema
200	OK	Task
202	Accepted	Task
400	Bad Request	Error
401	Unauthorized	Error
403	Forbidden	Error
500	Internal Server Error	Error

3.13.4. Consumes

• application/json

3.13.5. Produces

• application/json

3.13.6. Tags

• Credentials

3.13.7. Security

Type	Name
basic	basicAuth

3.13.8. Example HTTP request

Request path

/v1/credentials/tasks/string

Request header

privileged-username:"string"

Request body

{
  "elements" : [ {
    "credentials" : [ {
      "credentialType" : "One among: SSO, SSH, API, BASIC_AUTH, ADMINISTRATOR, FTP, JDBC, LDAP_DOMAIN_ADMIN, LDAP_READ_WRITE_ACCOUNT, VDI_ADMIN, SQL_SUPER_USER, SQL_DB_OWNER, SERVICE_ACCOUNT",
      "password" : "string",
      "username" : "string"
    } ],
    "resourceId" : "string",
    "resourceName" : "string",
    "resourceType" : "One among: ESXI , SDDC_MANAGER , VCENTER , PSC , NSX_MANAGER , NSX_CONTROLLER , NSX_EDGE , NSXT_MANAGER , NSXT_CONTROLLER , NSXT_EDGE , VRLI , VROPS , LCM_REPO , VRA , VRSLCM , DEPOT_USER , VXRAIL_MANAGER , AD , BACKUP"
  } ],
  "operationType" : "One among: UPDATE, ROTATE"
}

3.13.9. Example HTTP response

Response 200

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 202

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 401

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 403

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.14. Fetch resource credentials for a given credentials task ID

GET /v1/credentials/tasks/{id}/resource-credentials

3.14.1. Description

Fetch resource credentials for a given credentials task ID

3.14.2. Parameters

Type	Name	Description	Schema
Path	id required	The ID of the credentials task	string

3.14.3. Responses

HTTP Code	Description	Schema
200	OK	< ResourceCredentials > array
400	Bad Request	Error
500	Internal Server Error	Error

3.14.4. Consumes

• application/json

3.14.5. Produces

• application/json

3.14.6. Tags

• Credentials

3.14.7. Security

Type	Name
basic	basicAuth

3.14.8. Example HTTP request

Request path

/v1/credentials/tasks/string/resource-credentials

3.14.9. Example HTTP response

Response 200

[ {
  "credentials" : [ {
    "credentialType" : "One among: SSO, SSH, API, BASIC_AUTH, ADMINISTRATOR, FTP, JDBC, LDAP_DOMAIN_ADMIN, LDAP_READ_WRITE_ACCOUNT, VDI_ADMIN, SQL_SUPER_USER, SQL_DB_OWNER, SERVICE_ACCOUNT",
    "password" : "string",
    "username" : "string"
  } ],
  "resourceId" : "string",
  "resourceName" : "string",
  "resourceType" : "One among: ESXI , SDDC_MANAGER , VCENTER , PSC , NSX_MANAGER , NSX_CONTROLLER , NSX_EDGE , NSXT_MANAGER , NSXT_CONTROLLER , NSXT_EDGE , VRLI , VROPS , LCM_REPO , VRA , VRSLCM , DEPOT_USER , VXRAIL_MANAGER , AD , BACKUP"
} ]

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.15. Get a Credential

GET /v1/credentials/{id}

3.15.1. Description

Get a Credential

3.15.2. Parameters

Type	Name	Description	Schema
Header	privileged-password required	The privileged user password	string
Header	privileged-username required	The privileged user name	string
Path	id required	The ID of the credential	string

3.15.3. Responses

HTTP Code	Description	Schema
200	OK	Credential
400	Bad Request	Error
401	Unauthorized	Error
403	Forbidden	Error
404	Not Found	Error
500	Internal Server Error	Error

3.15.4. Consumes

• application/json

3.15.5. Produces

• application/json

3.15.6. Tags

• Credentials

3.15.7. Security

Type	Name
basic	basicAuth

3.15.8. Example HTTP request

Request path

/v1/credentials/string

Request header

privileged-username:"string"

3.15.9. Example HTTP response

Response 200

{
  "credentialType" : "One among: SSO, SSH, API, BASIC_AUTH, ADMINISTRATOR, FTP, JDBC, LDAP_DOMAIN_ADMIN, LDAP_READ_WRITE_ACCOUNT, VDI_ADMIN, SQL_SUPER_USER, SQL_DB_OWNER, SERVICE_ACCOUNT",
  "id" : "string",
  "password" : "string",
  "resource" : {
    "domainName" : "string",
    "resourceId" : "string",
    "resourceIp" : "string",
    "resourceName" : "string",
    "resourceType" : "One among: ESXI , SDDC_MANAGER , VCENTER , PSC , NSX_MANAGER , NSX_CONTROLLER , NSX_EDGE , NSXT_MANAGER , NSXT_CONTROLLER , NSXT_EDGE , VRLI , VROPS , LCM_REPO , VRA , VRSLCM , DEPOT_USER , VXRAIL_MANAGER , AD , BACKUP",
    "serviceType" : "One among: ESXI , SDDC_MANAGER , VCENTER , PSC , NSX_MANAGER , NSX_CONTROLLER , NSX_EDGE , NSXT_MANAGER , NSXT_CONTROLLER , NSXT_EDGE , VRLI , VROPS , LCM_REPO , VRA , VRSLCM , DEPOT_USER , VXRAIL_MANAGER , AD , BACKUP",
    "targetType" : "One among: ESXI , SDDC_MANAGER , VCENTER , PSC , NSX_MANAGER , NSX_CONTROLLER , NSX_EDGE , NSXT_MANAGER , NSXT_CONTROLLER , NSXT_EDGE , VRLI , VROPS , LCM_REPO , VRA , VRSLCM , DEPOT_USER , VXRAIL_MANAGER , AD , BACKUP"
  },
  "username" : "string"
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 401

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 403

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 404

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.16. Create a Domain

POST /v1/domains

3.16.1. Parameters

Type	Name	Description	Schema
Body	domainCreationSpec required	Domain creation data	DomainCreationSpec

3.16.2. Responses

HTTP Code	Description	Schema
200	OK	Task
202	Accepted	Task
400	Bad Request	Error
500	InternalServerError	Error

3.16.3. Consumes

• application/json

3.16.4. Produces

• application/json

3.16.5. Tags

• Domains

3.16.6. Security

Type	Name
basic	basicAuth

3.16.7. Example HTTP request

Request path

/v1/domains

Request body

{
  "computeSpec" : {
    "clusterSpecs" : [ {
      "advancedOptions" : {
        "evcMode" : "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN",
        "highAvailability" : {
          "enabled" : true
        }
      },
      "datastoreSpec" : {
        "nfsDatastoreSpecs" : [ {
          "datastoreName" : "string",
          "nasVolume" : {
            "path" : "string",
            "readOnly" : true,
            "serverName" : [ "string" ],
            "userTag" : "string"
          }
        } ],
        "vsanDatastoreSpec" : {
          "datastoreName" : "string",
          "dedupAndCompressionEnabled" : true,
          "failuresToTolerate" : 0,
          "licenseKey" : "string"
        }
      },
      "hostSpecs" : [ {
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "string",
            "vdsName" : "string"
          } ]
        },
        "id" : "string",
        "licenseKey" : "string"
      } ],
      "name" : "string",
      "networkSpec" : {
        "nsxClusterSpec" : {
          "nsxTClusterSpec" : {
            "geneveVlanId" : 0
          },
          "nsxVClusterSpec" : {
            "licenseKey" : "string",
            "vdsNameForVxlanConfig" : "string",
            "vlanId" : 0
          }
        },
        "vdsSpecs" : [ {
          "name" : "string",
          "niocBandwidthAllocationSpecs" : [ {
            "niocTrafficResourceAllocation" : {
              "limit" : 0,
              "reservation" : 0
            },
            "type" : "string"
          } ],
          "portGroupSpecs" : [ {
            "name" : "string",
            "transportType" : "One among: MANAGEMENT, NFS, PUBLIC, VMOTION, VSAN"
          } ]
        } ]
      }
    } ]
  },
  "domainName" : "string",
  "nsxTSpec" : {
    "licenseKey" : "string",
    "nsxManagerAdminPassword" : "string",
    "nsxManagerSpecs" : [ {
      "name" : "string",
      "networkDetailsSpec" : {
        "dnsName" : "string",
        "gateway" : "string",
        "ipAddress" : "string",
        "subnetMask" : "string"
      }
    } ],
    "vip" : "string",
    "vipFqdn" : "string"
  },
  "nsxVSpec" : {
    "licenseKey" : "string",
    "nsxManagerAdminPassword" : "string",
    "nsxManagerEnablePassword" : "string",
    "nsxManagerSpec" : {
      "name" : "string",
      "networkDetailsSpec" : {
        "dnsName" : "string",
        "gateway" : "string",
        "ipAddress" : "string",
        "subnetMask" : "string"
      }
    },
    "nsxVControllerSpec" : {
      "nsxControllerGateway" : "string",
      "nsxControllerIps" : [ "string" ],
      "nsxControllerPassword" : "string",
      "nsxControllerSubnetMask" : "string"
    }
  },
  "vcenterSpec" : {
    "datacenterName" : "string",
    "licenseKey" : "string",
    "name" : "string",
    "networkDetailsSpec" : {
      "dnsName" : "string",
      "gateway" : "string",
      "ipAddress" : "string",
      "subnetMask" : "string"
    },
    "rootPassword" : "string"
  }
}

3.16.8. Example HTTP response

Response 200

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 202

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.17. Get the Domains

GET /v1/domains

3.17.1. Responses

HTTP Code	Description	Schema
200	Ok	Domain
400	Bad Request	Error
500	InternalServerError	Error

3.17.2. Consumes

• application/json

3.17.3. Produces

• application/json

3.17.4. Tags

• Domains

3.17.5. Security

Type	Name
basic	basicAuth

3.17.6. Example HTTP request

Request path

/v1/domains

3.17.7. Example HTTP response

Response 200

{
  "clusters" : [ {
    "id" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "vcenters" : [ {
    "fqdn" : "string"
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.18. Validate the input spec for creating a Domain

POST /v1/domains/validations/creations

3.18.1. Parameters

Type	Name	Description	Schema
Body	domainCreationSpec required	Domain creation data	DomainCreationSpec

3.18.2. Responses

HTTP Code	Description	Schema
200	Ok	Validation
400	Bad Request	Error
500	InternalServerError	Error

3.18.3. Consumes

• application/json

3.18.4. Produces

• application/json

3.18.5. Tags

• Domains

3.18.6. Security

Type	Name
basic	basicAuth

3.18.7. Example HTTP request

Request path

/v1/domains/validations/creations

Request body

{
  "computeSpec" : {
    "clusterSpecs" : [ {
      "advancedOptions" : {
        "evcMode" : "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN",
        "highAvailability" : {
          "enabled" : true
        }
      },
      "datastoreSpec" : {
        "nfsDatastoreSpecs" : [ {
          "datastoreName" : "string",
          "nasVolume" : {
            "path" : "string",
            "readOnly" : true,
            "serverName" : [ "string" ],
            "userTag" : "string"
          }
        } ],
        "vsanDatastoreSpec" : {
          "datastoreName" : "string",
          "dedupAndCompressionEnabled" : true,
          "failuresToTolerate" : 0,
          "licenseKey" : "string"
        }
      },
      "hostSpecs" : [ {
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "string",
            "vdsName" : "string"
          } ]
        },
        "id" : "string",
        "licenseKey" : "string"
      } ],
      "name" : "string",
      "networkSpec" : {
        "nsxClusterSpec" : {
          "nsxTClusterSpec" : {
            "geneveVlanId" : 0
          },
          "nsxVClusterSpec" : {
            "licenseKey" : "string",
            "vdsNameForVxlanConfig" : "string",
            "vlanId" : 0
          }
        },
        "vdsSpecs" : [ {
          "name" : "string",
          "niocBandwidthAllocationSpecs" : [ {
            "niocTrafficResourceAllocation" : {
              "limit" : 0,
              "reservation" : 0
            },
            "type" : "string"
          } ],
          "portGroupSpecs" : [ {
            "name" : "string",
            "transportType" : "One among: MANAGEMENT, NFS, PUBLIC, VMOTION, VSAN"
          } ]
        } ]
      }
    } ]
  },
  "domainName" : "string",
  "nsxTSpec" : {
    "licenseKey" : "string",
    "nsxManagerAdminPassword" : "string",
    "nsxManagerSpecs" : [ {
      "name" : "string",
      "networkDetailsSpec" : {
        "dnsName" : "string",
        "gateway" : "string",
        "ipAddress" : "string",
        "subnetMask" : "string"
      }
    } ],
    "vip" : "string",
    "vipFqdn" : "string"
  },
  "nsxVSpec" : {
    "licenseKey" : "string",
    "nsxManagerAdminPassword" : "string",
    "nsxManagerEnablePassword" : "string",
    "nsxManagerSpec" : {
      "name" : "string",
      "networkDetailsSpec" : {
        "dnsName" : "string",
        "gateway" : "string",
        "ipAddress" : "string",
        "subnetMask" : "string"
      }
    },
    "nsxVControllerSpec" : {
      "nsxControllerGateway" : "string",
      "nsxControllerIps" : [ "string" ],
      "nsxControllerPassword" : "string",
      "nsxControllerSubnetMask" : "string"
    }
  },
  "vcenterSpec" : {
    "datacenterName" : "string",
    "licenseKey" : "string",
    "name" : "string",
    "networkDetailsSpec" : {
      "dnsName" : "string",
      "gateway" : "string",
      "ipAddress" : "string",
      "subnetMask" : "string"
    },
    "rootPassword" : "string"
  }
}

3.18.8. Example HTTP response

Response 200

{
  "description" : "string",
  "executionStatus" : "One among: COMPLETED, FAILED, IN_PROGRESS",
  "id" : "string",
  "resultStatus" : "One among: FAILED, FAILED_WITH_WARNINGS, SUCCEEDED",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "resultStatus" : "One among: FAILED, SUCCEEDED",
    "severity" : "One among: ERROR, WARNING"
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.19. Get a Domain

GET /v1/domains/{id}

3.19.1. Parameters

Type	Name	Description	Schema
Path	id required	Domain ID	string

3.19.2. Responses

HTTP Code	Description	Schema
200	Ok	Domain
404	Domain not found	Error
500	InternalServerError	Error

3.19.3. Consumes

• application/json

3.19.4. Produces

• application/json

3.19.5. Tags

• Domains

3.19.6. Security

Type	Name
basic	basicAuth

3.19.7. Example HTTP request

Request path

/v1/domains/string

3.19.8. Example HTTP response

Response 200

{
  "clusters" : [ {
    "id" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "vcenters" : [ {
    "fqdn" : "string"
  } ]
}

Response 404

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.20. Delete a Domain if it has been previously initialized for deletion

DELETE /v1/domains/{id}

3.20.1. Parameters

Type	Name	Description	Schema
Path	id required	Domain ID	string

3.20.2. Responses

HTTP Code	Description	Schema
200	OK	Task
202	Accepted	Task
400	Bad Request	Error
404	Not Found	Error
500	InternalServerError	Error

3.20.3. Consumes

• application/json

3.20.4. Produces

• application/json

3.20.5. Tags

• Domains

3.20.6. Security

Type	Name
basic	basicAuth

3.20.7. Example HTTP request

Request path

/v1/domains/string

3.20.8. Example HTTP response

Response 200

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 202

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 404

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.21. Update a Domain by marking for deletion

PATCH /v1/domains/{id}

3.21.1. Parameters

Type	Name	Description	Schema
Path	id required	Domain ID	string
Body	domainUpdateSpec required	Domain Update Data	DomainUpdateSpec

3.21.2. Responses

HTTP Code	Description	Schema
200	Ok	Task
400	Bad Request	Error
404	Not Found	Error
500	InternalServerError	Error

3.21.3. Consumes

• application/json

3.21.4. Produces

• application/json

3.21.5. Tags

• Domains

3.21.6. Security

Type	Name
basic	basicAuth

3.21.7. Example HTTP request

Request path

/v1/domains/string

Request body

{
  "markForDeletion" : true
}

3.21.8. Example HTTP response

Response 200

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 404

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.22. Commission the Hosts

POST /v1/hosts

3.22.1. Parameters

Type	Name	Description	Schema
Body	hostCommissionSpecs required	hostCommissionSpecs	< HostCommissionSpec > array

3.22.2. Responses

HTTP Code	Description	Schema
200	OK	Task
202	Accepted	Task
400	Bad Request	Error
500	Internal server error	Error

3.22.3. Consumes

• application/json

3.22.4. Produces

• application/json

3.22.5. Tags

• Hosts

3.22.6. Security

Type	Name
basic	basicAuth

3.22.7. Example HTTP request

Request path

/v1/hosts

Request body

[ {
  "fqdn" : "string",
  "networkPoolId" : "string",
  "networkPoolName" : "string",
  "password" : "string",
  "storageType" : "One among: VSAN, NFS",
  "username" : "string"
} ]

3.22.8. Example HTTP response

Response 200

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 202

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.23. Get the Hosts

GET /v1/hosts

3.23.1. Parameters

Type	Name	Description	Schema
Query	status optional	Status of the Host	string

3.23.2. Responses

HTTP Code	Description	Schema
200	Ok	PageOfHost
400	Bad Request	Error
500	Internal Server Error	Error

3.23.3. Consumes

• application/json

3.23.4. Produces

• application/json

3.23.5. Tags

• Hosts

3.23.6. Security

Type	Name
basic	basicAuth

3.23.7. Example HTTP request

Request path

/v1/hosts

3.23.8. Example HTTP response

Response 200

{
  "elements" : [ {
    "cluster" : {
      "id" : "string"
    },
    "cpu" : {
      "cores" : 0,
      "cpuCores" : [ {
        "frequencyMHz" : 0.0,
        "manufacturer" : "string",
        "model" : "string"
      } ],
      "frequencyMHz" : 0.0
    },
    "domain" : {
      "id" : "string"
    },
    "esxiVersion" : "string",
    "fqdn" : "string",
    "hardwareModel" : "string",
    "hardwareVendor" : "string",
    "id" : "string",
    "ipAddresses" : [ {
      "ipAddress" : "string",
      "type" : "One among: MANAGEMENT, NFS, VMOTION, VSAN"
    } ],
    "memory" : {
      "totalCapacityMB" : 0.0
    },
    "physicalNics" : [ {
      "deviceName" : "string",
      "macAddress" : "string"
    } ],
    "status" : "One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_USEABLE",
    "storage" : {
      "disks" : [ {
        "capacityMB" : 0.0,
        "diskType" : "One among: FLASH, HDD",
        "manufacturer" : "string",
        "model" : "string"
      } ],
      "totalCapacityMB" : 0.0
    }
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.24. Decommission the Hosts

DELETE /v1/hosts

3.24.1. Parameters

Type	Name	Description	Schema
Body	hostDecommissionSpecs required	hostDecommissionSpecs	< HostDecommissionSpec > array

3.24.2. Responses

HTTP Code	Description	Schema
200	OK	Task
202	Accepted	Task
400	Bad Request	Error
500	Internal server error	No Content

3.24.3. Consumes

• application/json

3.24.4. Produces

• application/json

3.24.5. Tags

• Hosts

3.24.6. Security

Type	Name
basic	basicAuth

3.24.7. Example HTTP request

Request path

/v1/hosts

Request body

[ {
  "fqdn" : "string"
} ]

3.24.8. Example HTTP response

Response 200

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 202

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.25. Validate the input specification to commission the Hosts

POST /v1/hosts/validations/commissions

3.25.1. Parameters

Type	Name	Description	Schema
Body	hostCommissionSpecs required	hostCommissionSpecs	< HostCommissionSpec > array

3.25.2. Responses

HTTP Code	Description	Schema
200	OK	Validation
202	Accepted	Validation
400	Bad Request	Error
500	Internal server error	No Content

3.25.3. Consumes

• application/json

3.25.4. Produces

• application/json

3.25.5. Tags

• Hosts

3.25.6. Security

Type	Name
basic	basicAuth

3.25.7. Example HTTP request

Request path

/v1/hosts/validations/commissions

Request body

[ {
  "fqdn" : "string",
  "networkPoolId" : "string",
  "networkPoolName" : "string",
  "password" : "string",
  "storageType" : "One among: VSAN, NFS",
  "username" : "string"
} ]

3.25.8. Example HTTP response

Response 200

{
  "description" : "string",
  "executionStatus" : "One among: COMPLETED, FAILED, IN_PROGRESS",
  "id" : "string",
  "resultStatus" : "One among: FAILED, FAILED_WITH_WARNINGS, SUCCEEDED",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "resultStatus" : "One among: FAILED, SUCCEEDED",
    "severity" : "One among: ERROR, WARNING"
  } ]
}

Response 202

{
  "description" : "string",
  "executionStatus" : "One among: COMPLETED, FAILED, IN_PROGRESS",
  "id" : "string",
  "resultStatus" : "One among: FAILED, FAILED_WITH_WARNINGS, SUCCEEDED",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "resultStatus" : "One among: FAILED, SUCCEEDED",
    "severity" : "One among: ERROR, WARNING"
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.26. Get the status of the validation of the input specification to commission the Hosts

GET /v1/hosts/validations/{id}

3.26.1. Parameters

Type	Name	Description	Schema
Path	id required	The validation ID	string

3.26.2. Responses

HTTP Code	Description	Schema
200	OK	Validation
400	Bad Request	Error
500	Internal server error	No Content

3.26.3. Consumes

• application/json

3.26.4. Produces

• application/json

3.26.5. Tags

• Hosts

3.26.6. Security

Type	Name
basic	basicAuth

3.26.7. Example HTTP request

Request path

/v1/hosts/validations/string

3.26.8. Example HTTP response

Response 200

{
  "description" : "string",
  "executionStatus" : "One among: COMPLETED, FAILED, IN_PROGRESS",
  "id" : "string",
  "resultStatus" : "One among: FAILED, FAILED_WITH_WARNINGS, SUCCEEDED",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "resultStatus" : "One among: FAILED, SUCCEEDED",
    "severity" : "One among: ERROR, WARNING"
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.27. Get a Host

GET /v1/hosts/{id}

3.27.1. Parameters

Type	Name	Description	Schema
Path	id required	id	string

3.27.2. Responses

HTTP Code	Description	Schema
200	Ok	Host
400	Bad Request	Error
404	Host Not Found	Error
500	Internal Server Error	Error

3.27.3. Consumes

• application/json

3.27.4. Produces

• application/json

3.27.5. Tags

• Hosts

3.27.6. Security

Type	Name
basic	basicAuth

3.27.7. Example HTTP request

Request path

/v1/hosts/string

3.27.8. Example HTTP response

Response 200

{
  "cluster" : {
    "id" : "string"
  },
  "cpu" : {
    "cores" : 0,
    "cpuCores" : [ {
      "frequencyMHz" : 0.0,
      "manufacturer" : "string",
      "model" : "string"
    } ],
    "frequencyMHz" : 0.0
  },
  "domain" : {
    "id" : "string"
  },
  "esxiVersion" : "string",
  "fqdn" : "string",
  "hardwareModel" : "string",
  "hardwareVendor" : "string",
  "id" : "string",
  "ipAddresses" : [ {
    "ipAddress" : "string",
    "type" : "One among: MANAGEMENT, NFS, VMOTION, VSAN"
  } ],
  "memory" : {
    "totalCapacityMB" : 0.0
  },
  "physicalNics" : [ {
    "deviceName" : "string",
    "macAddress" : "string"
  } ],
  "status" : "One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_USEABLE",
  "storage" : {
    "disks" : [ {
      "capacityMB" : 0.0,
      "diskType" : "One among: FLASH, HDD",
      "manufacturer" : "string",
      "model" : "string"
    } ],
    "totalCapacityMB" : 0.0
  }
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 404

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.28. Add a License Key

POST /v1/license-keys

3.28.1. Parameters

Type	Name	Description	Schema
Body	licenseKey required	License key with other attributes	LicenseKey

3.28.2. Responses

HTTP Code	Description	Schema
200	OK	LicenseKey
201	Created	LicenseKey
500	Internal server error	Error

3.28.3. Consumes

• application/json

3.28.4. Produces

• */*

3.28.5. Tags

• License Keys

3.28.6. Security

Type	Name
basic	basicAuth

3.28.7. Example HTTP request

Request path

/v1/license-keys

Request body

{
  "description" : "string",
  "id" : "string",
  "isUnlimited" : true,
  "key" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "licenseKeyUsage" : {
    "licenseUnit" : "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER",
    "remaining" : 0,
    "total" : 0,
    "used" : 0
  },
  "licenseKeyValidity" : {
    "expiryDate" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "licenseKeyStatus" : "One among: EXPIRED, ACTIVE, NEVER_EXPIRES"
  },
  "productType" : "One among: SDDC_MANAGER, VCENTER, NSXV, VSAN, ESXI, VRA, VROPS, NSXT"
}

3.28.8. Example HTTP response

Response 200

{
  "description" : "string",
  "id" : "string",
  "isUnlimited" : true,
  "key" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "licenseKeyUsage" : {
    "licenseUnit" : "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER",
    "remaining" : 0,
    "total" : 0,
    "used" : 0
  },
  "licenseKeyValidity" : {
    "expiryDate" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "licenseKeyStatus" : "One among: EXPIRED, ACTIVE, NEVER_EXPIRES"
  },
  "productType" : "One among: SDDC_MANAGER, VCENTER, NSXV, VSAN, ESXI, VRA, VROPS, NSXT"
}

Response 201

{
  "description" : "string",
  "id" : "string",
  "isUnlimited" : true,
  "key" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "licenseKeyUsage" : {
    "licenseUnit" : "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER",
    "remaining" : 0,
    "total" : 0,
    "used" : 0
  },
  "licenseKeyValidity" : {
    "expiryDate" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "licenseKeyStatus" : "One among: EXPIRED, ACTIVE, NEVER_EXPIRES"
  },
  "productType" : "One among: SDDC_MANAGER, VCENTER, NSXV, VSAN, ESXI, VRA, VROPS, NSXT"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.29. Get the License Keys

GET /v1/license-keys

3.29.1. Parameters

Type	Name	Description	Schema
Query	licenseKeyStatus optional	Status of a License Key	< string > array(multi)
Query	productType optional	Type of a Product	< string > array(multi)

3.29.2. Responses

HTTP Code	Description	Schema
200	Successful	PageOfLicenseKey
500	Internal server error	Error

3.29.3. Consumes

• application/json

3.29.4. Produces

• */*

3.29.5. Tags

• License Keys

3.29.6. Security

Type	Name
basic	basicAuth

3.29.7. Example HTTP request

Request path

/v1/license-keys

3.29.8. Example HTTP response

Response 200

{
  "elements" : [ {
    "description" : "string",
    "id" : "string",
    "isUnlimited" : true,
    "key" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "licenseKeyUsage" : {
      "licenseUnit" : "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER",
      "remaining" : 0,
      "total" : 0,
      "used" : 0
    },
    "licenseKeyValidity" : {
      "expiryDate" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "licenseKeyStatus" : "One among: EXPIRED, ACTIVE, NEVER_EXPIRES"
    },
    "productType" : "One among: SDDC_MANAGER, VCENTER, NSXV, VSAN, ESXI, VRA, VROPS, NSXT"
  } ]
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.30. Get a License Key by key

GET /v1/license-keys/{key}

3.30.1. Parameters

Type	Name	Description	Schema
Path	key required	The 29 alpha numeric character license key with hyphens	string

3.30.2. Responses

HTTP Code	Description	Schema
200	Successful	LicenseKey
404	License key not found	Error
500	Internal server error	Error

3.30.3. Consumes

• application/json

3.30.4. Produces

• */*

3.30.5. Tags

• License Keys

3.30.6. Security

Type	Name
basic	basicAuth

3.30.7. Example HTTP request

Request path

/v1/license-keys/string

3.30.8. Example HTTP response

Response 200

{
  "description" : "string",
  "id" : "string",
  "isUnlimited" : true,
  "key" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "licenseKeyUsage" : {
    "licenseUnit" : "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER",
    "remaining" : 0,
    "total" : 0,
    "used" : 0
  },
  "licenseKeyValidity" : {
    "expiryDate" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "licenseKeyStatus" : "One among: EXPIRED, ACTIVE, NEVER_EXPIRES"
  },
  "productType" : "One among: SDDC_MANAGER, VCENTER, NSXV, VSAN, ESXI, VRA, VROPS, NSXT"
}

Response 404

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.31. Delete a License Key

DELETE /v1/license-keys/{key}

3.31.1. Parameters

Type	Name	Description	Schema
Path	key required	The 29 alpha numeric character license key with hyphens	string

3.31.2. Responses

HTTP Code	Description	Schema
200	OK	No Content
204	No content	No Content
404	License key not found	No Content
500	Internal server error	Error

3.31.3. Consumes

• application/json

3.31.4. Produces

• */*

3.31.5. Tags

• License Keys

3.31.6. Security

Type	Name
basic	basicAuth

3.31.7. Example HTTP request

Request path

/v1/license-keys/string

3.31.8. Example HTTP response

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.32. Create a Network Pool

POST /v1/network-pools

3.32.1. Description

Create a Network Pool

3.32.2. Parameters

Type	Name	Description	Schema
Body	networkPool required	Specification of the Network pool to create	NetworkPool

3.32.3. Responses

HTTP Code	Description	Schema
200	OK	NetworkPool
201	The newly created network pool	NetworkPool
400	Errors due to network pool validations failures	Error
500	Unexpected error	Error

3.32.4. Consumes

• application/json

3.32.5. Produces

• application/json

3.32.6. Tags

• Network Pools

3.32.7. Security

Type	Name
basic	basicAuth

3.32.8. Example HTTP request

Request path

/v1/network-pools

Request body

{
  "id" : "string",
  "name" : "string",
  "networks" : [ {
    "freeIps" : [ "string" ],
    "gateway" : "string",
    "id" : "string",
    "ipPools" : [ {
      "end" : "string",
      "start" : "string"
    } ],
    "mask" : "string",
    "mtu" : 0,
    "subnet" : "string",
    "type" : "string",
    "usedIps" : [ "string" ],
    "vlanId" : 0
  } ]
}

3.32.9. Example HTTP response

Response 200

{
  "id" : "string",
  "name" : "string",
  "networks" : [ {
    "freeIps" : [ "string" ],
    "gateway" : "string",
    "id" : "string",
    "ipPools" : [ {
      "end" : "string",
      "start" : "string"
    } ],
    "mask" : "string",
    "mtu" : 0,
    "subnet" : "string",
    "type" : "string",
    "usedIps" : [ "string" ],
    "vlanId" : 0
  } ]
}

Response 201

{
  "id" : "string",
  "name" : "string",
  "networks" : [ {
    "freeIps" : [ "string" ],
    "gateway" : "string",
    "id" : "string",
    "ipPools" : [ {
      "end" : "string",
      "start" : "string"
    } ],
    "mask" : "string",
    "mtu" : 0,
    "subnet" : "string",
    "type" : "string",
    "usedIps" : [ "string" ],
    "vlanId" : 0
  } ]
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.33. Get the Network Pools

GET /v1/network-pools

3.33.1. Description

Get the Network Pools

3.33.2. Responses

HTTP Code	Description	Schema
200	Referenced network pool	PageOfNetworkPool
404	Referenced network pool not found	Error
500	Unexpected error	Error

3.33.3. Consumes

• application/json

3.33.4. Produces

• application/json

3.33.5. Tags

• Network Pools

3.33.6. Security

Type	Name
basic	basicAuth

3.33.7. Example HTTP request

Request path

/v1/network-pools

3.33.8. Example HTTP response

Response 200

{
  "elements" : [ {
    "id" : "string",
    "name" : "string",
    "networks" : [ {
      "freeIps" : [ "string" ],
      "gateway" : "string",
      "id" : "string",
      "ipPools" : [ {
        "end" : "string",
        "start" : "string"
      } ],
      "mask" : "string",
      "mtu" : 0,
      "subnet" : "string",
      "type" : "string",
      "usedIps" : [ "string" ],
      "vlanId" : 0
    } ]
  } ]
}

Response 404

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.34. Get a Network Pool

GET /v1/network-pools/{id}

3.34.1. Description

Get a Network Pool by ID, if it exists

3.34.2. Parameters

Type	Name	Description	Schema
Path	id required	ID of the network pool to fetch	string

3.34.3. Responses

HTTP Code	Description	Schema
200	Referenced network pool	NetworkPool
404	Referenced network pool not found	Error
500	Unexpected error	Error

3.34.4. Consumes

• application/json

3.34.5. Produces

• application/json

3.34.6. Tags

• Network Pools

3.34.7. Security

Type	Name
basic	basicAuth

3.34.8. Example HTTP request

Request path

/v1/network-pools/string

3.34.9. Example HTTP response

Response 200

{
  "id" : "string",
  "name" : "string",
  "networks" : [ {
    "freeIps" : [ "string" ],
    "gateway" : "string",
    "id" : "string",
    "ipPools" : [ {
      "end" : "string",
      "start" : "string"
    } ],
    "mask" : "string",
    "mtu" : 0,
    "subnet" : "string",
    "type" : "string",
    "usedIps" : [ "string" ],
    "vlanId" : 0
  } ]
}

Response 404

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.35. Delete a Network Pool

DELETE /v1/network-pools/{id}

3.35.1. Description

Delete the Network Pool by the ID, if it exists and is unused

3.35.2. Parameters

Type	Name	Description	Schema
Path	id required	ID of the network pool	string

3.35.3. Responses

HTTP Code	Description	Schema
200	OK	No Content
204	The specification of the deleted network pool	No Content
400	Hosts are still associated with NetworkPool	Error
404	Referenced network pool not found	Error
500	Unexpected error	Error

3.35.4. Consumes

• application/json

3.35.5. Produces

• */*

3.35.6. Tags

• Network Pools

3.35.7. Security

Type	Name
basic	basicAuth

3.35.8. Example HTTP request

Request path

/v1/network-pools/string

3.35.9. Example HTTP response

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 404

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.36. Get the Networks of a Network Pool

GET /v1/network-pools/{id}/networks

3.36.1. Description

Get the Networks that are part of a Network Pool

3.36.2. Parameters

Type	Name	Description	Schema
Path	id required	ID for Networkpool to get the networks from	string

3.36.3. Responses

HTTP Code	Description	Schema
200	Networks for referenced network pool	PageOfNetwork
404	Network pool not found	Error
500	Unexpected error	Error

3.36.4. Consumes

• application/json

3.36.5. Produces

• application/json

3.36.6. Tags

• Network Pools

3.36.7. Security

Type	Name
basic	basicAuth

3.36.8. Example HTTP request

Request path

/v1/network-pools/string/networks

3.36.9. Example HTTP response

Response 200

{
  "elements" : [ {
    "freeIps" : [ "string" ],
    "gateway" : "string",
    "id" : "string",
    "ipPools" : [ {
      "end" : "string",
      "start" : "string"
    } ],
    "mask" : "string",
    "mtu" : 0,
    "subnet" : "string",
    "type" : "string",
    "usedIps" : [ "string" ],
    "vlanId" : 0
  } ]
}

Response 404

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.37. Get a Network of a Network Pool

GET /v1/network-pools/{id}/networks/{networkId}

3.37.1. Description

Get a Network that is part of a Network Pool

3.37.2. Parameters

Type	Name	Description	Schema
Path	id required	Id of the Network pool	string
Path	networkId required	Id of the Network	string

3.37.3. Responses

HTTP Code	Description	Schema
200	Network for referenced network pool	Network
404	Networkpool not found	Error
500	Unexpected error	Error

3.37.4. Consumes

• application/json

3.37.5. Produces

• application/json

3.37.6. Tags

• Network Pools

3.37.7. Security

Type	Name
basic	basicAuth

3.37.8. Example HTTP request

Request path

/v1/network-pools/string/networks/string

3.37.9. Example HTTP response

Response 200

{
  "freeIps" : [ "string" ],
  "gateway" : "string",
  "id" : "string",
  "ipPools" : [ {
    "end" : "string",
    "start" : "string"
  } ],
  "mask" : "string",
  "mtu" : 0,
  "subnet" : "string",
  "type" : "string",
  "usedIps" : [ "string" ],
  "vlanId" : 0
}

Response 404

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.38. Add an IP Pool to a Network of a Network Pool

POST /v1/network-pools/{id}/networks/{networkId}/ip-pools

3.38.1. Description

Add an IP Pool to a Network of a Network Pool

3.38.2. Parameters

Type	Name	Description	Schema
Path	id required	Id of the networkpoolk	string
Path	networkId required	Id of the network	string
Body	ipPool required	ipPool	IpPool

3.38.3. Responses

HTTP Code	Description	Schema
200	Add the IP Pool associated with a Network of a Network Pool	Network
400	IP range validation failed error	Error
404	Either Network Pool ID or Network ID not found	Error
500	Unexpected error	Error

3.38.4. Consumes

• application/json

3.38.5. Produces

• application/json

3.38.6. Tags

• Network Pools

3.38.7. Security

Type	Name
basic	basicAuth

3.38.8. Example HTTP request

Request path

/v1/network-pools/string/networks/string/ip-pools

Request body

{
  "end" : "string",
  "start" : "string"
}

3.38.9. Example HTTP response

Response 200

{
  "freeIps" : [ "string" ],
  "gateway" : "string",
  "id" : "string",
  "ipPools" : [ {
    "end" : "string",
    "start" : "string"
  } ],
  "mask" : "string",
  "mtu" : 0,
  "subnet" : "string",
  "type" : "string",
  "usedIps" : [ "string" ],
  "vlanId" : 0
}

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 404

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.39. Delete an IP Pool from a Network of a Network Pool

DELETE /v1/network-pools/{id}/networks/{networkId}/ip-pools

3.39.1. Description

Delete an IP Pool from a Network of a Network Pool

3.39.2. Parameters

Type	Name	Description	Schema
Path	id required	ID of the networkpool	string
Path	networkId required	ID of the network	string
Body	ipPool required	ipPool	IpPool

3.39.3. Responses

HTTP Code	Description	Schema
200	Delete the IP Pool associated with a Network of a Network Pool	No Content
400	Errors due to network/networkpool validations failures	Error
404	Either network or Network pool not found	Error
500	Unexpected error	Error

3.39.4. Consumes

• application/json

3.39.5. Produces

• application/json

3.39.6. Tags

• Network Pools

3.39.7. Security

Type	Name
basic	basicAuth

3.39.8. Example HTTP request

Request path

/v1/network-pools/string/networks/string/ip-pools

Request body

{
  "end" : "string",
  "start" : "string"
}

3.39.9. Example HTTP response

Response 400

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 404

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.40. Get the Tasks

GET /v1/tasks

3.40.1. Description

Get the Tasks

3.40.2. Parameters

Type	Name	Description	Schema
Query	limit optional	The number of elements to be returned in the result	integer (int32)

3.40.3. Responses

HTTP Code	Description	Schema
200	Returns the list of tasks.	PageOfTask
500	Unexpected error	Error

3.40.4. Consumes

• application/json

3.40.5. Produces

• application/json

3.40.6. Tags

• Tasks

3.40.7. Security

Type	Name
basic	basicAuth

3.40.8. Example HTTP request

Request path

/v1/tasks

3.40.9. Example HTTP response

Response 200

{
  "elements" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "id" : "string",
    "name" : "string",
    "resources" : [ {
      "resourceId" : "string",
      "type" : "string"
    } ],
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
    "subTasks" : [ {
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "errors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "name" : "string",
      "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
    } ]
  } ]
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.41. Get a Task

GET /v1/tasks/{id}

3.41.1. Description

Get a Task by ID, if it exists

3.41.2. Parameters

Type	Name	Description	Schema
Path	id required	Task id to retrieve	string

3.41.3. Responses

HTTP Code	Description	Schema
200	A task object.	Task
404	Task not found	Error
500	Unexpected error	Error

3.41.4. Consumes

• application/json

3.41.5. Produces

• application/json

3.41.6. Tags

• Tasks

3.41.7. Security

Type	Name
basic	basicAuth

3.41.8. Example HTTP request

Request path

/v1/tasks/string

3.41.9. Example HTTP response

Response 200

{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "status" : "One among: FAILED, IN_PROGRESS, PENDING, SUCCESSFUL"
  } ]
}

Response 404

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.42. Retry a Task

PATCH /v1/tasks/{id}

3.42.1. Description

Retry a failed Task by ID, if it exists

3.42.2. Parameters

Type	Name	Description	Schema
Path	id required	Task id retry	string

3.42.3. Responses

HTTP Code	Description	Schema
200	Task was retried successfully.	No Content
404	Task not found	Error
409	Task can not be retried. Only a failed Task can be retried.	Error
500	Unexpected error	Error

3.42.4. Consumes

• application/json

3.42.5. Produces

• */*

3.42.6. Tags

• Tasks

3.42.7. Security

Type	Name
basic	basicAuth

3.42.8. Example HTTP request

Request path

/v1/tasks/string

3.42.9. Example HTTP response

Response 404

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 409

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Response 500

{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

Last updated 2019-09-03 15:16:59 +0530