{"swagger":"2.0","info":{"description":"The vCloud Availability API enables user session management, vApp replication management and monitoring, and system monitoring, in vCloud Availability.","version":"v3.0","title":"vCloud Availability API Reference"},"host":"localhost","basePath":"/","tags":[{"name":"session","description":"Session management operations"},{"name":"vapp-replications","description":"vApp-level replication management operations"},{"name":"tasks","description":"Task monitoring operations"},{"name":"diagnostics","description":"Support & diagnostics operations"}],"schemes":["https"],"paths":{"/diagnostics/about":{"get":{"tags":["diagnostics"],"summary":"Shows information about the product","description":"Shows information about the product","operationId":"aboutInfo","produces":["application/vnd.vmware.h4-v3+json;charset=UTF-8","application/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":"Returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(server stacktrace provided only when the client has admin privileges)"}}},"500":{"description":"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":"(server stacktrace provided only when the client has admin privileges)"}}}},"security":[{"vCloud Availability vApp Replication Manager cookie":[]}],"deprecated":false}},"/diagnostics/bundles":{"get":{"tags":["diagnostics"],"summary":"List the bundles available for download","description":"List all support bundles available for download.","operationId":"list","produces":["application/vnd.vmware.h4-v3+json;charset=UTF-8","application/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":"Returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(server stacktrace provided only when the client has admin privileges)"}}},"403":{"description":"Returned error codes include (but are not limited to):\n * Forbidden","schema":{"$ref":"#/definitions/ApiError"},"examples":{"Forbidden":{"args":[],"code":"Forbidden","msg":"Permission denied.","stacktrace":"(server stacktrace provided only when the client has admin privileges)"}}},"500":{"description":"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":"(server stacktrace provided only when the client has admin privileges)"}}}},"security":[{"vCloud Availability vApp Replication Manager cookie":[]}],"deprecated":false},"post":{"tags":["diagnostics"],"summary":"Generate a support bundle","description":"Generate a new support bundle. This operation requires administrative permissions and may take a while.","operationId":"generate","consumes":["application/json"],"produces":["application/vnd.vmware.h4-v3+json;charset=UTF-8","application/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":"Returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(server stacktrace provided only when the client has admin privileges)"}}},"403":{"description":"Returned error codes include (but are not limited to):\n * Forbidden","schema":{"$ref":"#/definitions/ApiError"},"examples":{"Forbidden":{"args":[],"code":"Forbidden","msg":"Permission denied.","stacktrace":"(server stacktrace provided only when the client has admin privileges)"}}},"500":{"description":"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":"(server stacktrace provided only when the client has admin privileges)"}}}},"security":[{"vCloud Availability vApp Replication Manager cookie":[]}],"deprecated":false}},"/diagnostics/bundles/cookie/{bundleId}":{"get":{"tags":["diagnostics"],"summary":"Download with a one-time cookie","description":"Downloads the respective support bundle, without requiring a correct API key to be provided. Suitable for use in client-side web browser applications.","operationId":"downloadWithCookie","produces":["application/vnd.vmware.h4-v3+json;charset=UTF-8","application/json;charset=UTF-8"],"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":{"$ref":"#/definitions/FileSystemResource"}},"401":{"description":"Returned error codes include (but are not limited to):\n * InvalidDownloadCookieException","schema":{"$ref":"#/definitions/ApiError"},"examples":{"InvalidDownloadCookieException":{"args":["cookie"],"code":"InvalidDownloadCookieException","msg":"Provided cookie is invalid: 'cookie'","stacktrace":"(server stacktrace provided only when the client has admin privileges)"}}},"404":{"description":"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":"(server stacktrace provided only when the client has admin privileges)"}}},"500":{"description":"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":"(server stacktrace provided only when the client has admin privileges)"}}}},"security":[{"vCloud Availability vApp Replication Manager cookie":[]}],"deprecated":false},"post":{"tags":["diagnostics"],"summary":"Generate a one-time download cookie","description":"Generate a one-time cookie with which to download a support bundle without providing the correct API key.","operationId":"generateCookie","consumes":["application/json"],"produces":["application/vnd.vmware.h4-v3+json;charset=UTF-8","application/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/SupportBundleCookie"}},"401":{"description":"Returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(server stacktrace provided only when the client has admin privileges)"}}},"403":{"description":"Returned error codes include (but are not limited to):\n * Forbidden","schema":{"$ref":"#/definitions/ApiError"},"examples":{"Forbidden":{"args":[],"code":"Forbidden","msg":"Permission denied.","stacktrace":"(server stacktrace provided only when the client has admin privileges)"}}},"500":{"description":"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":"(server stacktrace provided only when the client has admin privileges)"}}}},"security":[{"vCloud Availability vApp Replication Manager cookie":[]}],"deprecated":false}},"/diagnostics/bundles/{bundleId}":{"get":{"tags":["diagnostics"],"summary":"Download a support bundle","description":"Download the respective support bundle.","operationId":"download","produces":["application/vnd.vmware.h4-v3+json;charset=UTF-8","application/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":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FileSystemResource"}},"401":{"description":"Returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(server stacktrace provided only when the client has admin privileges)"}}},"403":{"description":"Returned error codes include (but are not limited to):\n * Forbidden","schema":{"$ref":"#/definitions/ApiError"},"examples":{"Forbidden":{"args":[],"code":"Forbidden","msg":"Permission denied.","stacktrace":"(server stacktrace provided only when the client has admin privileges)"}}},"404":{"description":"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":"(server stacktrace provided only when the client has admin privileges)"}}},"500":{"description":"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":"(server stacktrace provided only when the client has admin privileges)"}}}},"security":[{"vCloud Availability vApp Replication Manager cookie":[]}],"deprecated":false},"post":{"tags":["diagnostics"],"summary":"Generate a support bundle with a specific id (UUID)","description":"Generate a new support bundle with a specific id (UUID). This operation requires administrative permissions and may take a while.","operationId":"generateWithId","consumes":["application/json"],"produces":["application/vnd.vmware.h4-v3+json;charset=UTF-8","application/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":"Returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(server stacktrace provided only when the client has admin privileges)"}}},"403":{"description":"Returned error codes include (but are not limited to):\n * Forbidden","schema":{"$ref":"#/definitions/ApiError"},"examples":{"Forbidden":{"args":[],"code":"Forbidden","msg":"Permission denied.","stacktrace":"(server stacktrace provided only when the client has admin privileges)"}}},"500":{"description":"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":"(server stacktrace provided only when the client has admin privileges)"}}}},"security":[{"vCloud Availability vApp Replication Manager cookie":[]}],"deprecated":false},"delete":{"tags":["diagnostics"],"summary":"Delete a support bundle","description":"Delete the respective support bundle, reclaiming the disk space taken by it.","operationId":"delete","produces":["application/vnd.vmware.h4-v3+json;charset=UTF-8","application/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":"Returned error codes include (but are not limited to):\n * NotAuthenticated","schema":{"$ref":"#/definitions/ApiError"},"examples":{"NotAuthenticated":{"args":[],"code":"NotAuthenticated","msg":"Authentication required.","stacktrace":"(server stacktrace provided only when the client has admin privileges)"}}},"403":{"description":"Returned error codes include (but are not limited to):\n * Forbidden","schema":{"$ref":"#/definitions/ApiError"},"examples":{"Forbidden":{"args":[],"code":"Forbidden","msg":"Permission denied.","stacktrace":"(server stacktrace provided only when the client has admin privileges)"}}},"404":{"description":"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":"(server stacktrace provided only when the client has admin privileges)"}}},"500":{"description":"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":"(server stacktrace provided only when the client has admin privileges)"}}}},"security":[{"vCloud Availability vApp Replication Manager cookie":[]}],"deprecated":false}},"/diagnostics/health":{"get":{"tags":["diagnostics"],"summary":"Health info of the C4 service","description":"This request will provide the following information: