Manage Endpoint Aliases

Create or choose the Endpoint AliasCopy Anchor Link

Choose a short name that represents the application contract, such as uniswap-v3, positions, or production. Use separate Endpoint Aliases, such as positions and positions-dev, when environments should move at different times.

You can also create one while getting a query endpoint: in Get query endpoint, choose Subgraphs, then Endpoint Alias, and choose Create Endpoint Alias. It asks the same questions as creating the Endpoint Alias from the Endpoint Aliases page, described in the next step. After it's created, choose Get query endpoint to return with the new Endpoint Alias selected, ready to choose an API key. If you close it instead, you return to where you left off.

Endpoint Alias query URL:

https://subgraphs.graphops.xyz/v1/alias/<ALIAS>

Point the Endpoint Alias to a targetCopy Anchor Link

Creating an Endpoint Alias asks two questions, one at a time, before you name it:

1. What it follows: choose its Target type, then enter the Deployment CID or Graph Network Subgraph ID, or select the Managed Subgraph.
2. How it moves to new versions: choose its Target behavior from the ones that target type offers. A Deployment CID target has none to choose; it stays on that deployment.

Then name it and check the query URL the name gives. Review shows the target, its target behavior and the Deployment CID the Endpoint Alias will serve, and nothing is created until you confirm there. A Managed Subgraph target needs an active Managed Subgraph in your organization; until you have one, choose Set up a Subgraph from that option's explanation to create one.

While you explore a Subgraph, you can instead choose Create Endpoint Alias to start with its identifier. On a Managed Subgraph's page, it starts with that Managed Subgraph as the target.

To change an existing Endpoint Alias, choose Change target from its row actions. It asks the same two questions. Before you save, it shows what the Endpoint Alias serves now and after saving. A Deployment CID, Latest published version or Current version target switches queries as soon as you save, so confirm the new deployment answers first. A Latest available version or Next version target switches once that version can serve queries. After you save, it shows the Deployment CID the Endpoint Alias serves and, for a Latest available version alias that is waiting, the latest version and why it isn't serving yet.

Every target must resolve to a valid single-network deployment. If a Graph Network Subgraph ID target can't be resolved later, the Endpoint Alias keeps its last mapping and shows a tracking error.

Verify the targetCopy Anchor Link

The Target type column shows each Endpoint Alias's target type and target behavior; their info icons explain them. The Target column shows the Graph Network Subgraph ID or Managed Subgraph the Endpoint Alias follows and its Serving CID, the Deployment CID that answers its queries. When that isn't the version its target behavior names, a note says which version it is, such as Previous version. When a Latest available version alias is waiting for indexers, the column also shows the Latest CID and why it isn't serving yet. Use the row's actions to explore the target's schema or get its query endpoint.

Then query _meta through the Endpoint Alias:

query AliasTarget {
  _meta {
    deployment
    block {
      number
      hash
    }
    hasIndexingErrors
  }
}

{  "data": {    "_meta": {      "deployment": "QmTZ8ejXJxRo7vDBS4uwqBeGoxLSWbhaA7oXa1RvxunLy7",Should match the Serving Deployment CID      "block": {        "number": 26285621,Should keep rising on the new target        "hash": "0x40c3154aaa484a99057c58a6c72c27171ed861d260179db387850027655d0881"      },      "hasIndexingErrors": falseRoll back if this turns true    }  }}

Roll back if neededCopy Anchor Link

For an Endpoint Alias with a Deployment CID target, change its target to the previous Deployment CID after confirming that deployment is queryable. Keep previous CIDs in your release records.

For an Endpoint Alias with a Managed Subgraph target, prepare and promote the previous deployment as another Managed Subgraph upgrade, or explicitly convert the Endpoint Alias to a Deployment CID target. A Managed Subgraph upgrade must meet the readiness checks before promotion. To stop an Endpoint Alias from following Graph Network publications, convert it to a Deployment CID target. A Latest available version alias doesn't move back to an earlier version on its own; to return to one, change it to a Deployment CID target.