{ "opencollection": "1.0.0", "info": { "name": "YugabyteDB Aeon REST Access Keys Universe information API", "version": "v1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Universe information", "type": "folder" }, "items": [ { "info": { "name": "YugabyteDB Anywhere Get a Cost Estimate for All Universes", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/cost", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "YbaApi Internal. (Will be removed in next iteration)" }, { "info": { "name": "YugabyteDB Anywhere Get a Cost Estimate for a Universe - Deprecated", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/cost", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "Deprecated since YBA version 2.20.0.0.

Use /universe_resources" }, { "info": { "name": "YugabyteDB Anywhere Return Results for the Last Health Check", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/health_check", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "Available since YBA version 2.2.0.0. Checks the health of all tablet servers and masters in the universe, as well as certain conditions on the machines themselves, including disk utilization, presence of FATAL or core files, and more." }, { "info": { "name": "YugabyteDB Anywhere Get IP Address of a Universe's Master Leader", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/leader", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "Available since YBA version 2.2.0.0." }, { "info": { "name": "YugabyteDB Anywhere Get Live Queries for a Universe", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/live_queries", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "Available since YBA version 2.4.0.0." }, { "info": { "name": "YugabyteDB Anywhere Get Master Information List", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/master_infos", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "YbaApi Internal." }, { "info": { "name": "YugabyteDB Anywhere Get Slow Queries for a Universe", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/slow_queries", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "Available since YBA version 2.6.0.0." }, { "info": { "name": "YugabyteDB Anywhere Reset Slow Queries for a Universe", "type": "http" }, "http": { "method": "DELETE", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/slow_queries", "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" } ] }, "docs": "Available since YBA version 2.6.0.0." }, { "info": { "name": "YugabyteDB Anywhere Get a Universe's Status", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/status", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "Available since YBA version 2.2.0.0. This will return a Map of node name to its status in json format." }, { "info": { "name": "YugabyteDB Anywhere Trigger a Universe Health Check", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/trigger_health_check", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "YbaApi Internal. Trigger a universe health check and return the trigger time." }, { "info": { "name": "YugabyteDB Anywhere Get a Resource Usage Estimate for a Universe", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/universe_resources", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "Available since YBA version 2.20.0.0. Expects UniverseDefinitionTaskParams in request body and calculates the resource estimate for NodeDetailsSet in that." }, { "info": { "name": "YugabyteDB Anywhere Download a Node's Logs - Deprecated", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/universes/:uniUUID/:nodeName/download_logs", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "uniUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "nodeName", "value": "example-nodeName", "type": "path" } ] }, "docs": "Deprecated since YBA version 2.20.0.0.

User Support bundle. Downloads the log files from a given node." } ] } ], "bundled": true }