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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
DataStax

DataStax Private Link API

Use the DevOps Private Link APIs to manage private link endpoints for your Astra databases.

Documentation Provider Profile APIs.io OpenAPI GitHub

DataStax Private Link API is one of 17 APIs that DataStax publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Private Link. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 12 operations across 7 paths, and defines 13 schemas. It is described by OpenAPI 3.0.0, at version 2.3.0.

Requests are made against a single base URL, https://api.astra.datastax.com/.

12 operations 7 paths 13 schemas 2 DELETE5 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.3.0
Base URL
https://api.astra.datastax.com
Authentication
HTTP Bearer
Contact
ad-astra@datastax.com
Resource Areas
1

Authentication & Security 1

DataStax Private Link API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — An application token must be passed in header in order to access the API. https://docs.datastax.com/en/astra-db-serverless/administration/manage-application-to…

Paths & Operations 12

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

Private Link 12

Use the DevOps Private Link APIs to manage private link endpoints for your Astra databases.

GET
/v2/organizations/private-link
Gets info about all private link connections for a specific org
ListPrivateLinksForOrg → 200400401404409500
GET
/v2/organizations/clusters/{clusterID}/private-link
Gets info about all private link connections for a specific cluster
ListPrivateLinksForCluster 1 param → 200400401404409500
GET
/v2/organizations/clusters/{clusterID}/datacenters/{datacenterID}/private-link
Gets info about private link in a datacenter
GetPrivateLinksForDatacenter 2 params → 200400401404409500
POST
/v2/organizations/clusters/{clusterID}/datacenters/{datacenterID}/private-link
Add an allowed principal to the private link service
AddAllowedPrincipalToService 2 params body → 200400401404409500
POST
/v2/organizations/clusters/{clusterID}/datacenters/{datacenterID}/allowed-principals
Add an allowed principal to the private link service
AddAllowedPrincipal 2 params body → 200400401404409500
DELETE
/v2/organizations/clusters/{clusterID}/datacenters/{datacenterID}/allowed-principals
Remove an allowed principal from the private link service
RemoveAllowedPrincipalFromService 2 params body → 204400401404500
POST
/v2/organizations/clusters/{clusterID}/datacenters/{datacenterID}/endpoints
Accept an endpoint to the private link service
AcceptEndpointToService 2 params body → 200400401404409500
GET
/v2/organizations/clusters/{clusterID}/datacenters/{datacenterID}/endpoints/{endpointID}
Gets info about a private link endpoint
GetPrivateLinkEndpoint 3 params → 200400401404409500
PUT
/v2/organizations/clusters/{clusterID}/datacenters/{datacenterID}/endpoints/{endpointID}
Update the description for a private link endpoint
UpdateEndpointDescription 3 params body → 200400401404409500
DELETE
/v2/organizations/clusters/{clusterID}/datacenters/{datacenterID}/endpoints/{endpointID}
Reject an endpoint from the private link service
RejectEndpoint 3 params → 204400401404500
GET
/v2/organizations/customDomains
Return the list of custom domains used by an organization for access via one or more private links.
getCustomDomains → 2004004014045XX
POST
/v2/organizations/customDomains
Define a new set of custom domains for usage with private links.
setCustomDomains body → 2024004014045XX

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are PrivateLinkEndpoint (5 properties), PrivateLinkDatacenterOutput (4 properties), PrivateLinkClusterOutput (2 properties), PrivateLinkCreateEndpointInput (2 properties). Each schema is shown below with its type and property counts.

PrivateLinkUpdateEndpointInput
object
1 property
PrivateLinkDatacenterOutput
object
4 properties
PrivateLinkClusterOutput
object
2 properties
PrivateLinkOrgOutput
object
1 property
AllowedPrincipals
array
List of principals to do action for private link
ServiceName
string
The given endpoint service for the user to connect to
PrivateLinkCreateConfigInput
object
1 property
Error
object
ModelError information that is returned to users
2 properties 2 required
PrivateLinkCreateConfigOutput
object
2 properties
PrivateLinkDeleteConfigInput
object
1 property
PrivateLinkEndpoint
object
5 properties
PrivateLinkCreateEndpointInput
object
2 properties
Errors
object
Errors is a collection of individual Error objects
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

datastax-private-link-api-openapi.yml Raw ↑

Other APIs DataStax publishes across the network.

DataStax Access List API
AE Profile APIs.io
DataStax Authentication API
AE Profile APIs.io
DataStax Clone API
AE Profile APIs.io
DataStax Customer Keys API
AE Profile APIs.io
DataStax Database Operations API
AE Profile APIs.io
DataStax DevOps Access List API
AE Profile APIs.io
DataStax Enterprise Operations API
AE Profile APIs.io
DataStax Migrations API
AE Profile APIs.io
DataStax Organization Operations API
AE Profile APIs.io
DataStax PCU API
AE Profile APIs.io
DataStax Regions API
AE Profile APIs.io
DataStax Roles API
AE Profile APIs.io
#Private Link
← Back to D APIs
API Details
ID
datastax:datastax-private-link-api
Base URL
https://api.astra.datastax.com
Docs
https://docs.datastax.com/en/astra-db-serverless/api-reference/devops-api.html
Provider
DataStax
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=datastax-private-link-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/datastax-private-link-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of DataStax Private Link 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.