Repoint a namespace alias
Update the namespace an alias resolves to. The change is atomic: the target
is validated in the same transaction that rewrites the alias, and on failure the alias keeps its current target.
The call returns once the new target is live on every reader, which takes
about a second; size client timeouts accordingly. Reads through the alias
that start after the response are served from the new namespace, so no
polling is needed. Repointing is safe to retry; updated_at advances on
every attempt.
For guidance and examples, see Manage namespace aliases.
# 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 -X PATCH "https://$INDEX_HOST/namespace-aliases/$ALIAS_NAME" \
-H "Api-Key: $PINECONE_API_KEY" \
-H "Content-Type: application/json" \
-H "X-Pinecone-Api-Version: 2026-07" \
-d '{
"target_namespace": "dataset_v2"
}'PATCH /namespace-aliases/{alias_name}
{
"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": "<string>"
}
]
}{
"code": 123,
"message": "<string>",
"details": [
{
"typeUrl": "<string>",
"value": "<string>"
}
]
}{
"code": 123,
"message": "<string>",
"details": [
{
"typeUrl": "<string>",
"value": "<string>"
}
]
}{
"code": 123,
"message": "<string>",
"details": [
{
"typeUrl": "<string>",
"value": "<string>"
}
]
}Authorizations
Section titled “Authorizations”Api-KeystringrequiredAn API Key is required to call Pinecone APIs. Get yours from the console.
Headers
Section titled “Headers”X-Pinecone-Api-VersionstringrequiredRequired date-based version header
Path Parameters
Section titled “Path Parameters”alias_namestringrequiredThe name of the alias. Must be 1-512 characters of printable ASCII, excluding space and / ? # % & = \ ; +.
Required string length: 1 - 512
target_namespacestringrequiredThe namespace the alias resolves to after the repoint. Must be an existing, active namespace in the index; an alias cannot point to another alias. To point the alias at the default namespace, use __default__.
Required string length: 1 - 512. Example: dataset_v2
Response
Section titled “Response”200 — A successful response.
A description of a namespace alias and the namespace it resolves to.
namestringrequiredThe name of the alias. Immutable after creation.
Example: dataset
target_namespacestringrequiredThe namespace the alias resolves to. Changed only by repointing the alias. The default namespace is represented as __default__.
Example: dataset_v1
created_atstringrequiredThe time the alias was created.
Example: 2026-09-01T12:00:00.000Z
updated_atstringrequiredThe 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