Describe a namespace alias - Pinecone Docs

# To get the unique host for an index,
# see https://docs.pinecone.io/guides/manage-data/target-an-index
PINECONE_API_KEY="YOUR_API_KEY"
INDEX_HOST="INDEX_HOST"
ALIAS_NAME="dataset"

curl "https://$INDEX_HOST/namespace-aliases/$ALIAS_NAME" \
    -H "Api-Key: $PINECONE_API_KEY" \
    -H "X-Pinecone-Api-Version: 2026-07"

{
  "name": "dataset",
  "target_namespace": "dataset_v1",
  "created_at": "2026-09-01T12:00:00.000Z",
  "updated_at": "2026-09-01T12:00:00.000Z"
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

"Unauthorized"

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

GET

/

namespace-aliases

/

{alias_name}

# To get the unique host for an index,
# see https://docs.pinecone.io/guides/manage-data/target-an-index
PINECONE_API_KEY="YOUR_API_KEY"
INDEX_HOST="INDEX_HOST"
ALIAS_NAME="dataset"

curl "https://$INDEX_HOST/namespace-aliases/$ALIAS_NAME" \
    -H "Api-Key: $PINECONE_API_KEY" \
    -H "X-Pinecone-Api-Version: 2026-07"

{
  "name": "dataset",
  "target_namespace": "dataset_v1",
  "created_at": "2026-09-01T12:00:00.000Z",
  "updated_at": "2026-09-01T12:00:00.000Z"
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

"Unauthorized"

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

# To get the unique host for an index,
# see https://docs.pinecone.io/guides/manage-data/target-an-index
PINECONE_API_KEY="YOUR_API_KEY"
INDEX_HOST="INDEX_HOST"
ALIAS_NAME="dataset"

curl "https://$INDEX_HOST/namespace-aliases/$ALIAS_NAME" \
    -H "Api-Key: $PINECONE_API_KEY" \
    -H "X-Pinecone-Api-Version: 2026-07"

Authorizations

Api-Key

string

header

required

An API Key is required to call Pinecone APIs. Get yours from the console.

Headers

X-Pinecone-Api-Version

string

default:2026-07

required

Required date-based version header

Path Parameters

alias_name

string

required

The name of the alias. Must be 1-512 characters of printable ASCII, excluding space and / ? # % & = \ ; +.

Required string length: 1 - 512

Pattern: ^[\x21\x22\x24\x27-\x2A\x2C-\x2E\x30-\x3A\x3C\x3E\x40-\x5B\x5D-\x7E]+$

Response

A successful response.

A description of a namespace alias and the namespace it resolves to.

name

string

required

The name of the alias. Immutable after creation.

Example:

"dataset"

target_namespace

string

required

The namespace the alias resolves to. Changed only by repointing the alias. The default namespace is represented as __default__.

Example:

"dataset_v1"

created_at

string<date-time>

required

The time the alias was created.

Example:

"2026-09-01T12:00:00.000Z"

updated_at

string<date-time>

required

The time the alias was last repointed. Advances on every repoint, including a repoint to the alias's current target; equals created_at until the first repoint.

Example:

"2026-09-01T12:00:00.000Z"