How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

YugabyteDB Instance types API

The Instance types API from YugabyteDB — 5 operation(s) for instance types.

YugabyteDB Instance types API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Instance Types. 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 7 operations across 5 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

7 operations 5 paths 28 schemas 1 DELETE5 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
API Key
Contact
https://docs.yugabyte.com
Terms of Service
Resource Areas
1

Authentication & Security 1

YugabyteDB Instance types API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-AUTH-YW-API-TOKEN (apiKeyAuth).

  • apiKeyAuth — API token passed as header

Paths & Operations 7

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

Instance types 7
GET
/api/v1/customers/{cUUID}/providers/{pUUID}/instance_types
List a provider's instance types
listOfInstanceType 4 params → 200500
POST
/api/v1/customers/{cUUID}/providers/{pUUID}/instance_types
Create an instance type
createInstanceType 3 params body → 200
DELETE
/api/v1/customers/{cUUID}/providers/{pUUID}/instance_types/{code}
Delete an instance type
deleteInstanceType 4 params → 200
GET
/api/v1/customers/{cUUID}/providers/{pUUID}/instance_types/{code}
Get details of an instance type
instanceTypeDetail 3 params → 200
GET
/api/v1/metadata/azu_types
List supported Azure disk types
getAZUTypes → 200
GET
/api/v1/metadata/ebs_types
List supported EBS volume types
getEBSTypes → 200
GET
/api/v1/metadata/gcp_types
List supported GCP disk types
getGCPTypes → 200

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Provider (22 properties), Region (12 properties), InstanceType_2 (9 properties), AvailabilityZone (8 properties). Each schema is shown below with its type and property counts.

InstanceTypeKey
object
2 properties 2 required
InstanceTypeDetails
object
3 properties
InstanceTypeResp
object
Details of a cloud instance type
8 properties 1 required
InstanceType
object
Information about an instance
6 properties 1 required
YBPError
object
Generic error response from the YugabyteDB Anywhere API
6 properties
YBPSuccess
object
2 properties
VolumeDetails
object
3 properties 3 required
AvailabilityZone
object
Availability zone (AZ) for a region
8 properties 1 required
InstanceTypeKey_2
object
2 properties 2 required
InstanceTypeDetails_2
object
2 properties 2 required
InstanceType_2
object
Information about an instance
9 properties 6 required
Region
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties 1 required
YBPError_2
object
Generic error response from the YugabyteDB Anywhere API
3 properties
YBPSuccess_2
object
2 properties
VolumeDetails_2
object
3 properties 3 required
Provider
object
22 properties 1 required
InstanceTypeKey_3
object
2 properties 2 required
InstanceTypeDetails_3
object
3 properties
InstanceTypeResp_2
object
Details of a cloud instance type
8 properties 1 required
InstanceType_3
object
Information about an instance
6 properties 1 required
YBPSuccess_3
object
2 properties
VolumeDetails_3
object
3 properties 3 required
InstanceTypeKey_4
object
2 properties 2 required
InstanceTypeDetails_4
object
3 properties
InstanceTypeResp_3
object
Details of a cloud instance type
8 properties 1 required
InstanceType_4
object
Information about an instance
6 properties 1 required
YBPSuccess_4
object
2 properties
VolumeDetails_4
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-instance-types-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
Where this information came from

This is an independent, third-party profile of YugabyteDB Instance types API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.