{"swagger":"2.0","info":{"description":"The VMware Cloud Director Availability API enables user session management, system monitoring and replication management and monitoring, in VMware Cloud Director Availability.","version":"v4.1","title":"VMware Cloud Director Availability API Reference"},"host":"localhost","basePath":"/","tags":[{"name":"session","description":"Sessions management operations"},{"name":"vapp-replications","description":"vApp replications management operations"},{"name":"vm-replications","description":"VM replications management operations"},{"name":"tasks","description":"Tasks monitoring operations"},{"name":"diagnostics","description":"Diagnostics, health, and support bundles operations"},{"name":"policies","description":"Replication policies operations"},{"name":"resource-usage-summaries","description":"Resource usage summary operations"},{"name":"sla-profiles","description":"Replication SLA profiles operations"},{"name":"tenant-resources","description":"Tenant resources operations"},{"name":"backups","description":"Backup operations"}],"schemes":["https"],"paths":{"/backups":{"get":{"tags":["backups"],"summary":"Get the backups available for download","description":"This request returns a list of all the backups that are available for download.","operationId":"list-backups","produces":["application/json;charset=UTF-8","application/vnd.vmware.h4-v4.1+json;charset=UTF-8"],"parameters":[{"name":"operationID","in":"header","description":"Operation ID for correlating logs across multiple services","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BackupInfo"}}},"401":{"description":"The returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}},"500":{"description":"The returned error codes include (but are not limited to):\n * GeneralServerFailure","schema":{"$ref":"#/definitions/ApiError"},"examples":{"GeneralServerFailure":{"args":["args"],"code":"GeneralServerFailure","msg":"Operation aborted due to an unexpected error.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}}},"security":[{"VMware Cloud Director Availability vApp Replication Manager cookie":[]}],"deprecated":false},"post":{"tags":["backups"],"summary":"Generate a backup","description":"This request generates a new backup. This operation requires administrative permissions and may take some time to complete.","operationId":"generate-backup","consumes":["application/json"],"produces":["application/json;charset=UTF-8","application/vnd.vmware.h4-v4.1+json;charset=UTF-8"],"parameters":[{"name":"operationID","in":"header","description":"Operation ID for correlating logs across multiple services","required":false,"type":"string"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/NewBackupRequest"}}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ApiTaskOfBackupInfo"}},"401":{"description":"The returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}},"500":{"description":"The returned error codes include (but are not limited to):\n * GeneralServerFailure","schema":{"$ref":"#/definitions/ApiError"},"examples":{"GeneralServerFailure":{"args":["args"],"code":"GeneralServerFailure","msg":"Operation aborted due to an unexpected error.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}}},"security":[{"VMware Cloud Director Availability vApp Replication Manager cookie":[]}],"deprecated":false}},"/backups/cookie/{backupId}":{"get":{"tags":["backups"],"summary":"Download the backup by using a one-time cookie","description":"This request downloads the specified backup, without requiring a valid API key. This API is suitable for use in client-side web browsers.","operationId":"download-backup-with-cookie","parameters":[{"name":"backupId","in":"path","description":"backupId","required":true,"type":"string","format":"uuid"},{"name":"cookie","in":"query","description":"cookie","required":true,"type":"string"},{"name":"operationID","in":"header","description":"Operation ID for correlating logs across multiple services","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"file"}},"401":{"description":"The returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}},"500":{"description":"The returned error codes include (but are not limited to):\n * GeneralServerFailure","schema":{"$ref":"#/definitions/ApiError"},"examples":{"GeneralServerFailure":{"args":["args"],"code":"GeneralServerFailure","msg":"Operation aborted due to an unexpected error.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}}},"security":[{"VMware Cloud Director Availability vApp Replication Manager cookie":[]}],"deprecated":false},"post":{"tags":["backups"],"summary":"Generate a one-time cookie for downloading the backup","description":"This request generates a one-time cookie used to download the specified backup without providing a valid API key.","operationId":"generate-backup-download-cookie","consumes":["application/json"],"produces":["application/json;charset=UTF-8","application/vnd.vmware.h4-v4.1+json;charset=UTF-8"],"parameters":[{"name":"backupId","in":"path","description":"backupId","required":true,"type":"string","format":"uuid"},{"name":"operationID","in":"header","description":"Operation ID for correlating logs across multiple services","required":false,"type":"string"}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/DownloadCookie"}},"401":{"description":"The returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}},"500":{"description":"The returned error codes include (but are not limited to):\n * GeneralServerFailure","schema":{"$ref":"#/definitions/ApiError"},"examples":{"GeneralServerFailure":{"args":["args"],"code":"GeneralServerFailure","msg":"Operation aborted due to an unexpected error.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}}},"security":[{"VMware Cloud Director Availability vApp Replication Manager cookie":[]}],"deprecated":false}},"/backups/{backupId}":{"get":{"tags":["backups"],"summary":"Download the backup","description":"This request downloads the specified backup.","operationId":"download-backup","parameters":[{"name":"backupId","in":"path","description":"backupId","required":true,"type":"string","format":"uuid"},{"name":"operationID","in":"header","description":"Operation ID for correlating logs across multiple services","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"file"}},"401":{"description":"The returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}},"500":{"description":"The returned error codes include (but are not limited to):\n * GeneralServerFailure","schema":{"$ref":"#/definitions/ApiError"},"examples":{"GeneralServerFailure":{"args":["args"],"code":"GeneralServerFailure","msg":"Operation aborted due to an unexpected error.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}}},"security":[{"VMware Cloud Director Availability vApp Replication Manager cookie":[]}],"deprecated":false},"post":{"tags":["backups"],"summary":"Generate a backup with a specific ID (UUID)","description":"This request generates a new backup with a specific ID (UUID). This operation requires administrative permissions and may take some time to complete.","operationId":"generate-backup-with-id","consumes":["application/json"],"produces":["application/json;charset=UTF-8","application/vnd.vmware.h4-v4.1+json;charset=UTF-8"],"parameters":[{"name":"backupId","in":"path","description":"backupId","required":true,"type":"string","format":"uuid"},{"name":"operationID","in":"header","description":"Operation ID for correlating logs across multiple services","required":false,"type":"string"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/NewBackupRequest"}}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ApiTaskOfBackupInfo"}},"401":{"description":"The returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}},"500":{"description":"The returned error codes include (but are not limited to):\n * GeneralServerFailure","schema":{"$ref":"#/definitions/ApiError"},"examples":{"GeneralServerFailure":{"args":["args"],"code":"GeneralServerFailure","msg":"Operation aborted due to an unexpected error.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}}},"security":[{"VMware Cloud Director Availability vApp Replication Manager cookie":[]}],"deprecated":false},"delete":{"tags":["backups"],"summary":"Delete the backup","description":"This request deletes the specified backup, freeing the disk space it takes.","operationId":"delete-backup","produces":["application/json;charset=UTF-8","application/vnd.vmware.h4-v4.1+json;charset=UTF-8"],"parameters":[{"name":"backupId","in":"path","description":"backupId","required":true,"type":"string","format":"uuid"},{"name":"operationID","in":"header","description":"Operation ID for correlating logs across multiple services","required":false,"type":"string"}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ApiTaskOfVoid"}},"401":{"description":"The returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}},"500":{"description":"The returned error codes include (but are not limited to):\n * GeneralServerFailure","schema":{"$ref":"#/definitions/ApiError"},"examples":{"GeneralServerFailure":{"args":["args"],"code":"GeneralServerFailure","msg":"Operation aborted due to an unexpected error.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}}},"security":[{"VMware Cloud Director Availability vApp Replication Manager cookie":[]}],"deprecated":false}},"/diagnostics/about":{"get":{"tags":["diagnostics"],"summary":"Get information about the product","description":"This request returns information about the product.","operationId":"aboutInfo","produces":["application/json;charset=UTF-8","application/vnd.vmware.h4-v4.1+json;charset=UTF-8"],"parameters":[{"name":"operationID","in":"header","description":"Operation ID for correlating logs across multiple services","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AboutInfo"}},"401":{"description":"The returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}},"500":{"description":"The returned error codes include (but are not limited to):\n * GeneralServerFailure","schema":{"$ref":"#/definitions/ApiError"},"examples":{"GeneralServerFailure":{"args":["args"],"code":"GeneralServerFailure","msg":"Operation aborted due to an unexpected error.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}}},"security":[{"VMware Cloud Director Availability vApp Replication Manager cookie":[]}],"deprecated":false}},"/diagnostics/bundles":{"get":{"tags":["diagnostics"],"summary":"Get the bundles available for download","description":"This request returns a list of all the support bundles that are available for download.","operationId":"list","produces":["application/json;charset=UTF-8","application/vnd.vmware.h4-v4.1+json;charset=UTF-8"],"parameters":[{"name":"operationID","in":"header","description":"Operation ID for correlating logs across multiple services","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SupportBundleInfo"}}},"401":{"description":"The returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}},"403":{"description":"The returned error codes include (but are not limited to):\n * Forbidden","schema":{"$ref":"#/definitions/ApiError"},"examples":{"Forbidden":{"args":[],"code":"Forbidden","msg":"Permission denied.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}},"500":{"description":"The returned error codes include (but are not limited to):\n * GeneralServerFailure","schema":{"$ref":"#/definitions/ApiError"},"examples":{"GeneralServerFailure":{"args":["args"],"code":"GeneralServerFailure","msg":"Operation aborted due to an unexpected error.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}}},"security":[{"VMware Cloud Director Availability vApp Replication Manager cookie":[]}],"deprecated":false},"post":{"tags":["diagnostics"],"summary":"Generate a support bundle","description":"This request generates a new support bundle. This operation requires administrative permissions and may take some time to complete.","operationId":"generate","consumes":["application/json"],"produces":["application/json;charset=UTF-8","application/vnd.vmware.h4-v4.1+json;charset=UTF-8"],"parameters":[{"name":"operationID","in":"header","description":"Operation ID for correlating logs across multiple services","required":false,"type":"string"}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ApiTaskOfSupportBundleInfo"}},"401":{"description":"The returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}},"403":{"description":"The returned error codes include (but are not limited to):\n * Forbidden","schema":{"$ref":"#/definitions/ApiError"},"examples":{"Forbidden":{"args":[],"code":"Forbidden","msg":"Permission denied.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}},"500":{"description":"The returned error codes include (but are not limited to):\n * GeneralServerFailure","schema":{"$ref":"#/definitions/ApiError"},"examples":{"GeneralServerFailure":{"args":["args"],"code":"GeneralServerFailure","msg":"Operation aborted due to an unexpected error.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}}},"security":[{"VMware Cloud Director Availability vApp Replication Manager cookie":[]}],"deprecated":false}},"/diagnostics/bundles/cookie/{bundleId}":{"get":{"tags":["diagnostics"],"summary":"Get the support bundle by using a one-time cookie","description":"This request downloads the specified support bundle, without requiring a valid API key. This API is suitable for use in client-side web browsers.","operationId":"download-with-cookie","parameters":[{"name":"bundleId","in":"path","description":"bundleId","required":true,"type":"string","format":"uuid"},{"name":"cookie","in":"query","description":"cookie","required":true,"type":"string"},{"name":"operationID","in":"header","description":"Operation ID for correlating logs across multiple services","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"file"}},"401":{"description":"The returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}},"500":{"description":"The returned error codes include (but are not limited to):\n * GeneralServerFailure","schema":{"$ref":"#/definitions/ApiError"},"examples":{"GeneralServerFailure":{"args":["args"],"code":"GeneralServerFailure","msg":"Operation aborted due to an unexpected error.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}}},"security":[{"VMware Cloud Director Availability vApp Replication Manager cookie":[]}],"deprecated":false},"post":{"tags":["diagnostics"],"summary":"Generate a one-time cookie for downloading the support bundle","description":"This request generates a one-time cookie used to download the specified support bundle without providing a valid API key.","operationId":"generate-cookie","consumes":["application/json"],"produces":["application/json;charset=UTF-8","application/vnd.vmware.h4-v4.1+json;charset=UTF-8"],"parameters":[{"name":"bundleId","in":"path","description":"bundleId","required":true,"type":"string","format":"uuid"},{"name":"operationID","in":"header","description":"Operation ID for correlating logs across multiple services","required":false,"type":"string"}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/DownloadCookie"}},"401":{"description":"The returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}},"500":{"description":"The returned error codes include (but are not limited to):\n * GeneralServerFailure","schema":{"$ref":"#/definitions/ApiError"},"examples":{"GeneralServerFailure":{"args":["args"],"code":"GeneralServerFailure","msg":"Operation aborted due to an unexpected error.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}}},"security":[{"VMware Cloud Director Availability vApp Replication Manager cookie":[]}],"deprecated":false}},"/diagnostics/bundles/{bundleId}":{"get":{"tags":["diagnostics"],"summary":"Get the support bundle","description":"This request downloads the specified support bundle.","operationId":"download","parameters":[{"name":"bundleId","in":"path","description":"bundleId","required":true,"type":"string","format":"uuid"},{"name":"operationID","in":"header","description":"Operation ID for correlating logs across multiple services","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"file"}},"401":{"description":"The returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}},"403":{"description":"The returned error codes include (but are not limited to):\n * Forbidden","schema":{"$ref":"#/definitions/ApiError"},"examples":{"Forbidden":{"args":[],"code":"Forbidden","msg":"Permission denied.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}},"404":{"description":"The returned error codes include (but are not limited to):\n * SupportBundleNotFound","schema":{"$ref":"#/definitions/ApiError"},"examples":{"SupportBundleNotFound":{"args":["bundleId"],"code":"SupportBundleNotFound","msg":"Support bundle with id 'bundleId' was not found.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}},"500":{"description":"The returned error codes include (but are not limited to):\n * GeneralServerFailure","schema":{"$ref":"#/definitions/ApiError"},"examples":{"GeneralServerFailure":{"args":["args"],"code":"GeneralServerFailure","msg":"Operation aborted due to an unexpected error.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}}},"security":[{"VMware Cloud Director Availability vApp Replication Manager cookie":[]}],"deprecated":false},"post":{"tags":["diagnostics"],"summary":"Generate a support bundle with a specific ID (UUID)","description":"This request generates a new support bundle with a specific ID (UUID). This operation requires administrative permissions and may take some time to complete.","operationId":"generate-with-id","consumes":["application/json"],"produces":["application/json;charset=UTF-8","application/vnd.vmware.h4-v4.1+json;charset=UTF-8"],"parameters":[{"name":"bundleId","in":"path","description":"bundleId","required":true,"type":"string","format":"uuid"},{"name":"operationID","in":"header","description":"Operation ID for correlating logs across multiple services","required":false,"type":"string"}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ApiTaskOfSupportBundleInfo"}},"401":{"description":"The returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}},"500":{"description":"The returned error codes include (but are not limited to):\n * GeneralServerFailure","schema":{"$ref":"#/definitions/ApiError"},"examples":{"GeneralServerFailure":{"args":["args"],"code":"GeneralServerFailure","msg":"Operation aborted due to an unexpected error.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}}},"security":[{"VMware Cloud Director Availability vApp Replication Manager cookie":[]}],"deprecated":false},"delete":{"tags":["diagnostics"],"summary":"Delete the support bundle","description":"This request deletes the specified support bundle, freeing the disk space it takes.","operationId":"delete","produces":["application/json;charset=UTF-8","application/vnd.vmware.h4-v4.1+json;charset=UTF-8"],"parameters":[{"name":"bundleId","in":"path","description":"bundleId","required":true,"type":"string","format":"uuid"},{"name":"operationID","in":"header","description":"Operation ID for correlating logs across multiple services","required":false,"type":"string"}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ApiTaskOfSupportBundleInfo"}},"401":{"description":"The returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}},"403":{"description":"The returned error codes include (but are not limited to):\n * Forbidden","schema":{"$ref":"#/definitions/ApiError"},"examples":{"Forbidden":{"args":[],"code":"Forbidden","msg":"Permission denied.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}},"404":{"description":"The returned error codes include (but are not limited to):\n * SupportBundleNotFound","schema":{"$ref":"#/definitions/ApiError"},"examples":{"SupportBundleNotFound":{"args":["bundleId"],"code":"SupportBundleNotFound","msg":"Support bundle with id 'bundleId' was not found.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}},"500":{"description":"The returned error codes include (but are not limited to):\n * GeneralServerFailure","schema":{"$ref":"#/definitions/ApiError"},"examples":{"GeneralServerFailure":{"args":["args"],"code":"GeneralServerFailure","msg":"Operation aborted due to an unexpected error.","stacktrace":"(The server stacktrace is provided only when the client has administrator privileges)"}}}},"security":[{"VMware Cloud Director Availability vApp Replication Manager cookie":[]}],"deprecated":false}},"/diagnostics/health":{"get":{"tags":["diagnostics"],"summary":"Get health information about the Cloud service","description":"This request returns the following health information about the Cloud service: