> ## Documentation Index
> Fetch the complete documentation index at: https://www.cockroachlabs.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Creates all PrivateEndpointServices for a given cluster
This endpoint is in **Preview** and subject to change. Refer to the [API support policy](https://www.cockroachlabs.com/docs/stable/api-support-policy) for more details.
## OpenAPI
````yaml /openapi/cloud/2022-09-20.json post /api/v1/clusters/{cluster_id}/networking/private-endpoint-services
openapi: 3.0.0
info:
contact:
email: support@cockroachlabs.com
name: Cockroach Labs Support
url: https://support.cockroachlabs.com
description: >-
This is a preview version of the Cloud API. The interface and output is
subject to change, and there may be bugs.
title: CockroachDB Cloud API
version: '2022-09-20'
servers:
- url: https://cockroachlabs.cloud
security:
- Bearer: []
tags:
- name: CockroachCloud
externalDocs:
description: Use the CockroachDB Cloud API
url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
paths:
/api/v1/clusters/{cluster_id}/networking/private-endpoint-services:
post:
tags:
- CockroachCloud
summary: Creates all PrivateEndpointServices for a given cluster
operationId: CockroachCloud_CreatePrivateEndpointServices
parameters:
- name: cluster_id
in: path
description: cluster_id is the ID for the cluster.
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/PrivateEndpointServices'
'400':
description: Returned when a request field is invalid.
content:
application/json:
schema: {}
'401':
description: Returned when the token bearer cannot be authenticated.
content:
application/json:
schema: {}
'403':
description: >-
Returned when the user does not have permission to access the
resource.
content:
application/json:
schema: {}
'404':
description: Returned when the resource does not exist.
content:
application/json:
schema: {}
'500':
description: Server error
content:
application/json:
schema: {}
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
x-codeSamples:
- lang: curl
source: |-
curl --request POST \
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/networking/private-endpoint-services \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--header 'content-type: application/json' \
--data '{}'
components:
schemas:
PrivateEndpointServices:
type: object
properties:
services:
description: services contains a list of all cluster related services.
type: array
items:
$ref: '#/components/schemas/PrivateEndpointService'
required:
- services
Status:
type: object
properties:
code:
type: integer
format: int32
details:
type: array
items:
$ref: '#/components/schemas/Any'
message:
type: string
PrivateEndpointService:
type: object
properties:
aws:
$ref: '#/components/schemas/AWSPrivateLinkServiceDetail'
cloud_provider:
$ref: '#/components/schemas/api.CloudProvider'
region_name:
description: region_name is the cloud provider region name (i.e. us-east-1).
type: string
status:
$ref: '#/components/schemas/PrivateEndpointServiceStatus'
required:
- region_name
- cloud_provider
- status
- aws
Any:
description: >-
`Any` contains an arbitrary serialized protocol buffer message along
with a
URL that describes the type of the serialized message.
Protobuf library provides support to pack/unpack Any values in the form
of utility functions or additional generated methods of the Any type.
Example 1: Pack and unpack a message in C++.
Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}
Example 2: Pack and unpack a message in Java.
Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
foo = any.unpack(Foo.class);
}
Example 3: Pack and unpack a message in Python.
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
any.Unpack(foo)
...
Example 4: Pack and unpack a message in Go
foo := &pb.Foo{...}
any, err := ptypes.MarshalAny(foo)
...
foo := &pb.Foo{}
if err := ptypes.UnmarshalAny(any, foo); err != nil {
...
}
The pack methods provided by protobuf library will by default use
'type.googleapis.com/full.type.name' as the type URL and the unpack
methods only use the fully qualified type name after the last '/'
in the type URL, for example "foo.bar.com/x/y.z" will yield type
name "y.z".
JSON
====
The JSON representation of an `Any` value uses the regular
representation of the deserialized, embedded message, with an
additional field `@type` which contains the type URL. Example:
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": ,
"lastName":
}
If the embedded message type is well-known and has a custom JSON
representation, that representation will be embedded adding a field
`value` which holds the custom JSON in addition to the `@type`
field. Example (for message [google.protobuf.Duration][]):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
type: object
properties:
'@type':
description: >-
A URL/resource name that uniquely identifies the type of the
serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
`path/google.protobuf.Duration`). The name should be in a canonical
form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that
they
expect it to use in the context of Any. However, for URLs which use
the
scheme `http`, `https`, or no scheme, one can optionally set up a
type
server that maps type URLs to message definitions as follows:
* If no scheme is provided, `https` is assumed.
* An HTTP GET on the URL must yield a [google.protobuf.Type][]
value in binary format, or produce an error.
* Applications are allowed to cache lookup results based on the
URL, or have them precompiled into a binary to avoid any
lookup. Therefore, binary compatibility needs to be preserved
on changes to types. (Use versioned type names to manage
breaking changes.)
Note: this functionality is not currently available in the official
protobuf release, and it is not used for type URLs beginning with
type.googleapis.com.
Schemes other than `http`, `https` (or the empty scheme) might be
used with implementation specific semantics.
type: string
additionalProperties: {}
AWSPrivateLinkServiceDetail:
type: object
properties:
availability_zone_ids:
description: |-
availability_zone_ids are the identifiers for the availability zones
that the service is available in.
type: array
items:
type: string
service_id:
description: |-
service_id is the server side of the PrivateLink
connection. This is the same as AWSPrivateLinkEndpoint.service_id.
type: string
service_name:
description: >-
service_name is the AWS service name customers use to create
endpoints
on their end.
type: string
required:
- service_name
- service_id
- availability_zone_ids
api.CloudProvider:
description: |2-
- GCP: The Google Cloud Platform cloud provider.
- AWS: The Amazon Web Services cloud provider.
type: string
enum:
- GCP
- AWS
PrivateEndpointServiceStatus:
description: >-
- ENDPOINT_SERVICE_STATUS_DELETE_FAILED: One note is that if the service
is deleted, there is no longer
a record, hence there is no "DELETED" status.
type: string
enum:
- ENDPOINT_SERVICE_STATUS_CREATING
- ENDPOINT_SERVICE_STATUS_AVAILABLE
- ENDPOINT_SERVICE_STATUS_CREATE_FAILED
- ENDPOINT_SERVICE_STATUS_DELETING
- ENDPOINT_SERVICE_STATUS_DELETE_FAILED
title: Private Endpoints
securitySchemes:
Bearer:
type: http
scheme: bearer
````