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 Session management API

The Session management API from YugabyteDB — 9 operation(s) for session management.

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

Tagged areas include Session Management. 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 9 operations across 9 paths, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

9 operations 9 paths 23 schemas 6 GET2 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

YugabyteDB Session management 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 9

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

Session management 9
POST
/api/v1/api_login
Authenticate user using email and password
apiLogin 1 param body → 200
GET
/api/v1/app_version
appVersion
appVersion → 200
GET
/api/v1/customer_count
customerCount
customerCount → 200
GET
/api/v1/customers/{cUUID}/admin_notifications
Current list of notifications for admin
getAdminNotifications 1 param → 200
PUT
/api/v1/customers/{cUUID}/api_token
Regenerate and fetch API token
api_token 3 params → 200
GET
/api/v1/logs
getFilteredLogs
getFilteredLogs 5 params → 200
GET
/api/v1/logs/{maxLines}
getLogs
getLogs 1 param → 200
POST
/api/v1/register
Register a customer
registerCustomer 2 params body → 200
GET
/api/v1/session_info
Get current user and customer uuid. This will not generate or return the API token, use /apitoken API for that.
getSessionInfo 1 param → 200

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are SessionInfo (5 properties), SessionInfo_4 (5 properties), SessionInfo_3 (5 properties), CustomerRegisterFormData_3 (4 properties). Each schema is shown below with its type and property counts.

Admin_notification
object
2 properties
CustomerLoginFormData
object
2 properties 2 required
LogData
object
1 property 1 required
CustomerCountResp
object
1 property 1 required
Current_admin_notification_messages
object
1 property
SessionInfo
object
Session information
5 properties
CustomerRegisterFormData
object
4 properties 4 required
CustomerCountResp_2
object
1 property 1 required
SessionInfo_2
object
Session information
4 properties
CustomerRegisterFormData_2
object
4 properties 4 required
LogData_2
object
1 property 1 required
Admin_notification_2
object
2 properties
CustomerLoginFormData_2
object
2 properties 2 required
LogData_3
object
1 property 1 required
CustomerCountResp_3
object
1 property 1 required
Current_admin_notification_messages_2
object
1 property
SessionInfo_3
object
Session information
5 properties
CustomerRegisterFormData_3
object
4 properties 4 required
CustomerLoginFormData_3
object
2 properties 2 required
CustomerCountResp_4
object
1 property 1 required
LogData_4
object
1 property 1 required
SessionInfo_4
object
Session information
5 properties
CustomerRegisterFormData_4
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-session-management-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 Session management 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.