{ "opencollection": "1.0.0", "info": { "name": "YugabyteDB Aeon REST Access Keys Universe Upgrades Management API", "version": "v1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Universe Upgrades Management", "type": "folder" }, "items": [ { "info": { "name": "YugabyteDB Anywhere Modify Audit Logging Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/audit_log_config", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "WARNING: This is a preview API that could change. Modifies the audit logging configuration for a universe." }, { "info": { "name": "YugabyteDB Anywhere Upgrade Certs", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/upgrade/certs", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Queues a task to perform certificate rotation and rolling restart in a universe." }, { "info": { "name": "YugabyteDB Anywhere Upgrade DB Version", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/upgrade/db_version", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "WARNING: This is a preview API that could change. This is a two step DB software version upgrade, Upgrade DB version and then finalize software which would be same as of upgrade software but additionally support rollback before upgrade finalize. " }, { "info": { "name": "YugabyteDB Anywhere Finalize Upgrade", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/upgrade/finalize", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "WARNING: This is a preview API that could change. Queues a task to finalize upgrade in a universe." }, { "info": { "name": "YugabyteDB Anywhere Finalize Software Upgrade Info", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/upgrade/finalize/info", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "WARNING: This is a preview API that could change. Provides pre-finalize software upgrade info." }, { "info": { "name": "YugabyteDB Anywhere Upgrade GFlags", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/upgrade/gflags", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Queues a task to perform gflags upgrade and rolling restart in a universe." }, { "info": { "name": "YugabyteDB Anywhere Upgrade Kubernetes Universe to Toggle Immutable YBC", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/upgrade/k8s_immutable_ybc", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "WARNING: This is a preview API that could change. Queues a task to toggle immutable YBC on Kubernetes universe." }, { "info": { "name": "YugabyteDB Anywhere Upgrade KubernetesOverrides", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/upgrade/kubernetes_overrides", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Queues a task to perform Kubernetesoverrides upgrade for a kubernetes universe." }, { "info": { "name": "YugabyteDB Anywhere Provision Universe Nodes", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/upgrade/provision_nodes", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Queues a task to provision universe nodes with YBA node agent and YNP stack. Supports rolling upgrade." }, { "info": { "name": "YugabyteDB Anywhere Update Proxy Config", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/upgrade/proxy_config", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "WARNING: This is a preview API that could change. Queues a task to perform Proxy config update in the Universe details." }, { "info": { "name": "YugabyteDB Anywhere Reboot Universe", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/upgrade/reboot", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Queues a task to perform a rolling reboot in a universe." }, { "info": { "name": "YugabyteDB Anywhere Resize Node", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/upgrade/resize_node", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Queues a task to perform node resize and rolling restart in a universe.
This API can be used to change the deviceInfo.volumeSize, masterDeviceInfo.volumeSize,instanceType, masterInstanceType of all the nodes of a Universe simultaneously without moving data from old nodes to new nodes. Refer: https://docs.yugabyte.com/preview/yugabyte-platform/manage-deployments/edit-universe/#smart-resize" }, { "info": { "name": "YugabyteDB Anywhere Restart Universe", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/upgrade/restart", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Queues a task to perform a rolling restart in a universe." }, { "info": { "name": "YugabyteDB Anywhere Rollback Upgrade", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/upgrade/rollback", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "WARNING: This is a preview API that could change. Queues a task to rollback upgrade in a universe." }, { "info": { "name": "YugabyteDB Anywhere Upgrade Software", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/upgrade/software", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Queues a task to perform software upgrade and rolling restart in a universe." }, { "info": { "name": "YugabyteDB Anywhere Software Upgrade Universe Pre-check", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/upgrade/software/precheck", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "WARNING: This is a preview API that could change. Performs pre-checks and provides pre-upgrade info." }, { "info": { "name": "YugabyteDB Anywhere Upgrade Systemd", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/upgrade/systemd", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Queues a task to perform systemd upgrade and rolling restart in a universe." }, { "info": { "name": "YugabyteDB Anywhere Upgrade Third-party Software", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/upgrade/thirdparty_software", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Queues a task to perform upgrade third-party software in a universe." }, { "info": { "name": "YugabyteDB Anywhere Upgrade TLS", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/upgrade/tls", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Queues a task to perform TLS ugprade and rolling restart in a universe." }, { "info": { "name": "YugabyteDB Anywhere Upgrade VM Image", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/upgrade/vm", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Queues a task to perform VM Image upgrade and rolling restart in a universe." } ] } ], "bundled": true }