Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

YugabyteDB Extract metadata from remote tarball API

The Extract metadata from remote tarball API from YugabyteDB — 2 operation(s) for extract metadata from remote tarball.

YugabyteDB Extract metadata from remote tarball API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Extract metadata from remote tarball. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 2 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://cloud.yugabyte.com/api/public/v1.

2 operations 2 paths 6 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

YugabyteDB Extract metadata from remote tarball API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — API key obtained from the YugabyteDB Aeon UI under User Profile API Keys. Pass the key as a Bearer token in the Authorization header.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Extract metadata from remote tarball 2
POST
/api/v1/customers/{cUUID}/ybdb_release/extract_metadata
YugabyteDB Anywhere Helper to Extract Release Metadata from a Remote Tarball
extractMetadata 2 params body → 200
GET
/api/v1/customers/{cUUID}/ybdb_release/extract_metadata/{rUUID}
YugabyteDB Anywhere Get the Extract Release Metadata from a Remote Tarball
extractMetadata 3 params → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ResponseExtractMetadata_2 (10 properties), ResponseExtractMetadata (10 properties), ExtractMetadata_2 (2 properties), ExtractMetadata (2 properties). Each schema is shown below with its type and property counts.

YBPCreateSuccess
object
1 property
ResponseExtractMetadata
object
10 properties 10 required
ExtractMetadata
object
url to release TGZ to extract metadata from
2 properties 2 required
YBPCreateSuccess_2
object
1 property
ResponseExtractMetadata_2
object
10 properties 10 required
ExtractMetadata_2
object
url to release TGZ to extract metadata from
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-extract-metadata-from-remote-tarball-api-openapi.yml Raw ↑

Other APIs YugabyteDB publishes across the network.

YugabyteDB Access Keys API
YugabyteDB Accounts API
YugabyteDB Alerts API
YugabyteDB AllowLists API
YugabyteDB Asynchronous Replication API
YugabyteDB Audit API
YugabyteDB Authentication API
YugabyteDB Availability Zones API
YugabyteDB Backup and Restore API
YugabyteDB Backups API
YugabyteDB Certificate Info API
YugabyteDB Cloud providers API