---
title: read-a-privatelink-endpoint
product: vercel
url: /docs/rest-api/networking/read-a-privatelink-endpoint
canonical_url: "https://vercel.com/docs/rest-api/networking/read-a-privatelink-endpoint"
last_updated: 2026-09-02
type: reference
prerequisites:
  []
related:
  - /docs/rest-api
summary: Learn about read-a-privatelink-endpoint on Vercel.
install_vercel_plugin: npx plugins add vercel/vercel-plugin
---

# Read a PrivateLink endpoint

```http
GET /v1/networking/privatelink/endpoints/{endpointId}
```

Reads a single PrivateLink endpoint.

## Authentication

**bearerToken**: HTTP bearer

## Path parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `endpointId` | string | Yes | The unique identifier of the PrivateLink endpoint. |


## Query parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `projectId` | string | Yes | The project ID the PrivateLink endpoint belongs to. |
| `teamId` | string | No | The Team identifier to perform the request on behalf of. |
| `slug` | string | No | The Team slug to perform the request on behalf of. |


## Example request

### TypeScript

```typescript
const response = await fetch('https://api.vercel.com/v1/networking/privatelink/endpoints/endpointId?projectId=string&teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
```

### Next.js

```typescript
'use server';

export async function callEndpoint() {
  const response = await fetch('https://api.vercel.com/v1/networking/privatelink/endpoints/endpointId?projectId=string&teamId=string&slug=string', {
    method: 'GET',
    headers: {
      'Authorization': `Bearer ${process.env.VERCEL_ACCESS_TOKEN}`,
      'Content-Type': 'application/json',
    },
    next: { revalidate: 3600 }
  });

  if (!response.ok) {
    throw new Error('Request failed');
  }

  return response.json();
}
```

### cURL

```bash
curl -X GET 'https://api.vercel.com/v1/networking/privatelink/endpoints/endpointId?projectId=string&teamId=string&slug=string' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
```

## Example response

```json
{
  "endpointId": "ple_a1b2c3d4e5f6g7h8",
  "name": "payments-db",
  "teamId": "team_a1b2c3d4e5f6g7h8",
  "projectId": "prj_a1b2c3d4e5f6g7h8",
  "vercelRegion": "iad1",
  "awsServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-0123456789abcdef0",
  "vpcEndpointId": "vpce-0123456789abcdef0",
  "awsDnsEntries": [],
  "privateDnsNames": [],
  "status": "available",
  "statusMessage": "Endpoint did not become available in time. Try deleting and recreating, or visit https://vercel.com/help if the issue persists.",
  "createdAt": "1610963878358",
  "updatedAt": "1610963878358"
}
```

## Responses

### 200: The requested PrivateLink endpoint.

Content-Type: `application/json`

```json
{
  "type": "object",
  "description": "A PrivateLink endpoint, which connects a project to an AWS VPC endpoint service in a single region so that traffic reaches the service over AWS PrivateLink rather than the public internet.",
  "required": [
    "awsServiceName",
    "createdAt",
    "endpointId",
    "name",
    "projectId",
    "status",
    "teamId",
    "updatedAt",
    "vercelRegion"
  ],
  "properties": {
    "endpointId": {
      "type": "string",
      "description": "The unique identifier of the PrivateLink endpoint."
    },
    "name": {
      "type": "string",
      "description": "The name of the PrivateLink endpoint, shown in the Vercel dashboard."
    },
    "teamId": {
      "type": "string",
      "description": "The identifier of the team that owns the PrivateLink endpoint."
    },
    "projectId": {
      "type": "string",
      "description": "The identifier of the project the PrivateLink endpoint belongs to."
    },
    "vercelRegion": {
      "type": "string",
      "description": "The Vercel region the endpoint is provisioned in."
    },
    "awsServiceName": {
      "type": "string",
      "description": "The AWS VPC endpoint service the endpoint connects to."
    },
    "vpcEndpointId": {
      "type": "string",
      "description": "The identifier of the underlying AWS VPC endpoint. Absent until AWS has created the endpoint."
    },
    "awsDnsEntries": {
      "type": "array",
      "description": "The regional DNS names assigned to the endpoint by AWS. Use these to reach the service when private DNS is not enabled.",
      "items": {
        "type": "string"
      }
    },
    "privateDnsNames": {
      "type": "array",
      "description": "The private DNS names of the endpoint service, populated when private DNS is enabled for the endpoint.",
      "items": {
        "type": "string"
      }
    },
    "status": {
      "type": "string",
      "description": "The current state of the endpoint. - `creating`: the endpoint is being created. - `pending-acceptance`: waiting for the endpoint service owner to accept the connection. Only occurs for services that require manual acceptance. - `provisioning`: the connection was accepted and AWS is finishing setup. - `available`: the endpoint is fully provisioned and ready to use. - `rejected`: the endpoint service owner rejected the connection. - `failed`: the endpoint could not be provisioned. - `deleting`: the endpoint is being deleted.",
      "enum": [
        "available",
        "creating",
        "deleting",
        "failed",
        "pending-acceptance",
        "provisioning",
        "rejected"
      ]
    },
    "statusMessage": {
      "type": "string",
      "description": "A human-readable explanation of why the endpoint could not be provisioned. Only set when `status` is `failed`, and absent for every other status including `rejected`, since AWS does not report a rejection reason."
    },
    "createdAt": {
      "type": "number",
      "description": "Timestamp in milliseconds since the UNIX epoch for when the endpoint was created."
    },
    "updatedAt": {
      "type": "number",
      "description": "Timestamp in milliseconds since the UNIX epoch for when the endpoint was last updated."
    }
  }
}
```

### 400: One of the provided values in the request query is invalid.

### 401: The request is not authorized.

### 403: You do not have permission to access this resource.

### 404: No description

### 410: No description

---

## Related

- [networking endpoints](/docs/rest-api#networking)

- [REST API overview](/docs/rest-api)

- [OpenAPI spec](https://openapi.vercel.sh/) (machine-readable, all endpoints)

---

[View full sitemap](/docs/sitemap)