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

Yugabyte Access Keys API

The Access Keys API from Yugabyte — 3 operation(s) for access keys.

Yugabyte Access Keys API is one of 82 APIs that Yugabyte publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

Requests are made against a single base URL, /.

6 operations 3 paths 5 schemas 1 DELETE3 GET1 POST1 PUT

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

Yugabyte Access Keys 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 6

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

Access Keys 6
GET
/api/v1/customers/{cUUID}/access_keys
List access keys for all providers of a customer
listAllForCustomer 1 param → 200
GET
/api/v1/customers/{cUUID}/providers/{pUUID}/access_keys
List access keys for a specific provider
list 2 params → 200
POST
/api/v1/customers/{cUUID}/providers/{pUUID}/access_keysdeprecated
Create/Upload Access Key for onprem provider region - deprecated
createAccesskey 3 params body → 200
DELETE
/api/v1/customers/{cUUID}/providers/{pUUID}/access_keys/{keyCode}
Delete an access key
delete_accesskey 4 params → 200
GET
/api/v1/customers/{cUUID}/providers/{pUUID}/access_keys/{keyCode}
Get an access key
index 3 params → 200
PUT
/api/v1/customers/{cUUID}/providers/{pUUID}/access_keys/{keyCode}
Modify the existing access Key
editAccesskey 4 params body → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are KeyInfo (21 properties), AccessKey (4 properties), AccessKeyFormData (4 properties), AccessKeyId (2 properties). Each schema is shown below with its type and property counts.

KeyInfo
object
21 properties
AccessKeyFormData
object
4 properties 3 required
AccessKey
object
Access key for the cloud provider. This helps to authenticate the user and get access to the provider.
4 properties 2 required
YBPSuccess
object
2 properties
AccessKeyId
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabyte-access-keys-api-openapi.yml Raw ↑

Other APIs Yugabyte publishes across the network.

YugabyteDB Aeon REST API
Yugabyte Backup Info API
Yugabyte Cluster API
Yugabyte Cluster Info API
Yugabyte Pitr Info API
Yugabyte Restore Info API
Yugabyte Voyager Info API
Yugabyte Voyager Metrics API
Yugabyte Xcluster Metrics API
Yugabyte Xcluster Namespace Details API
Yugabyte Accounts API
Yugabyte Alerts API
Where this information came from

This is an independent, third-party profile of Yugabyte Access Keys 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.