Add defaultRestApiVersion context variable (#60508)

jencarlucci · web-flow · commit d9ee464ee2de · 2026-04-06T16:36:05.000Z
diff --git a/content/billing/tutorials/automate-usage-reporting.md b/content/billing/tutorials/automate-usage-reporting.md
@@ -72,7 +72,7 @@ You must authenticate your request to this endpoint.
 ```bash
 curl -L \
   -H "Authorization: Bearer $GITHUB_TOKEN" \
-  -H "X-GitHub-Api-Version: 2022-11-28" \
+  -H "X-GitHub-Api-Version: {{ defaultRestApiVersion }}" \
   https://api.github.com/enterprises/ENTERPRISE/settings/billing/usage/summary
 ```
 
@@ -82,7 +82,7 @@ Replace `ENTERPRISE` with the enterprise slug and set the `GITHUB_TOKEN` environ
 
 ```bash
 gh api \
-  -H "X-GitHub-Api-Version: 2022-11-28" \
+  -H "X-GitHub-Api-Version: {{ defaultRestApiVersion }}" \
   /enterprises/ENTERPRISE/settings/billing/usage/summary
 ```
 
diff --git a/content/billing/tutorials/control-costs-at-scale.md b/content/billing/tutorials/control-costs-at-scale.md
@@ -132,7 +132,7 @@ In your terminal, run the following command, replacing `ENTERPRISE` with the slu
 ```shell copy
 gh api \
   -H "Accept: application/vnd.github+json" \
-  -H "X-GitHub-Api-Version: 2022-11-28" \
+  -H "X-GitHub-Api-Version: {{ defaultRestApiVersion }}" \
   /enterprises/ENTERPRISE/settings/billing/cost-centers
 ```
 
@@ -174,7 +174,7 @@ In your terminal, run the following command, replacing `ENTERPRISE` and `NAME` w
 gh api \
   --method POST \
   -H "Accept: application/vnd.github+json" \
-  -H "X-GitHub-Api-Version: 2022-11-28" \
+  -H "X-GitHub-Api-Version: {{ defaultRestApiVersion }}" \
   /enterprises/ENTERPRISE/settings/billing/cost-centers \
    -f 'name=NAME'
 ```
@@ -200,7 +200,7 @@ In your terminal, run the following command, replacing `COST_CENTER_ID` with the
 gh api \
   --method POST \
   -H "Accept: application/vnd.github+json" \
-  -H "X-GitHub-Api-Version: 2022-11-28" \
+  -H "X-GitHub-Api-Version: {{ defaultRestApiVersion }}" \
   /enterprises/ENTERPRISE/settings/billing/cost-centers/COST_CENTER_ID/resource \
   --input - <<< '{
   "users": [
@@ -244,7 +244,7 @@ In your terminal, run the following command, replacing `ENTERPRISE`, `COST_CENTE
 gh api \
   --method POST \
   -H "Accept: application/vnd.github+json" \
-  -H "X-GitHub-Api-Version: 2022-11-28" \
+  -H "X-GitHub-Api-Version: {{ defaultRestApiVersion }}" \
   /enterprises/ENTERPRISE/settings/billing/budgets \
   -f budget_type='SkuPricing' \
   -f budget_product_sku='copilot_premium_request' \
diff --git a/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/setting-dependabot-to-run-on-github-hosted-runners-using-vnet.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/setting-dependabot-to-run-on-github-hosted-runners-using-vnet.md
@@ -93,7 +93,7 @@ If your Azure VNET environment is configured with a firewall with an IP allowlis
         curl -L \
         -H "Accept: application/vnd.github+json" \
         -H "Authorization: Bearer YOUR-TOKEN" \
-        -H "X-GitHub-Api-Version: 2022-11-28" \
+        -H "X-GitHub-Api-Version: {{ defaultRestApiVersion }}" \
         https://api.github.com/meta
   ```
 
diff --git a/content/github-models/quickstart.md b/content/github-models/quickstart.md
@@ -45,7 +45,7 @@ To call models programmatically, you’ll need:
       -X POST \
       -H "Accept: application/vnd.github+json" \
       -H "Authorization: Bearer YOUR_GITHUB_PAT" \
-      -H "X-GitHub-Api-Version: 2022-11-28" \
+      -H "X-GitHub-Api-Version: {{ defaultRestApiVersion }}" \
       -H "Content-Type: application/json" \
       https://models.github.ai/inference/chat/completions \
       -d '{"model":"openai/gpt-4.1","messages":[{"role":"user","content":"What is the capital of France?"}]}'
diff --git a/content/rest/about-the-rest-api/api-versions.md b/content/rest/about-the-rest-api/api-versions.md
@@ -34,7 +34,7 @@ You should use the `X-GitHub-Api-Version` header to specify an API version. For
 curl {% data reusables.rest-api.version-header %} https://api.github.com/zen
 ```
 
-Requests without the `X-GitHub-Api-Version` header will default to use the `2022-11-28` version.
+Requests without the `X-GitHub-Api-Version` header will default to use the `{{ defaultRestApiVersion }}` version.
 
 If you specify an API version that is no longer supported, you will receive a `400` error.
 
diff --git a/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md b/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md
@@ -256,7 +256,7 @@ The following example request uses the ["Get Octocat" endpoint](/rest/meta/meta#
 ```shell copy
 gh api --method GET /octocat \
 --header 'Accept: application/vnd.github+json' \
---header "X-GitHub-Api-Version: 2022-11-28"
+--header "X-GitHub-Api-Version: {{ defaultRestApiVersion }}"
 ```
 
 #### Example request using query parameters
@@ -275,7 +275,7 @@ The following example uses the ["Create an issue" endpoint](/rest/issues/issues#
 ```shell copy
 gh api --method POST /repos/{% ifversion ghes %}REPO-OWNER/REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}/issues \
 --header "Accept: application/vnd.github+json" \
---header "X-GitHub-Api-Version: 2022-11-28" \
+--header "X-GitHub-Api-Version: {{ defaultRestApiVersion }}" \
 -f title='Created with the REST API' \
 -f body='This is a test issue created by the REST API' \
 ```
@@ -332,7 +332,7 @@ The following example request uses the ["Get Octocat" endpoint](/rest/meta/meta#
 curl --request GET \
 --url "https://api.github.com/octocat" \
 --header "Accept: application/vnd.github+json" \
---header "X-GitHub-Api-Version: 2022-11-28"
+--header "X-GitHub-Api-Version: {{ defaultRestApiVersion }}"
 ```
 
 #### Example request using query parameters
@@ -343,7 +343,7 @@ The ["List public events" endpoint](/rest/activity/events#list-public-events) re
 curl --request GET \
 --url "{% data variables.product.rest_url %}/events?per_page=2&page=1" \
 --header "Accept: application/vnd.github+json" \
---header "X-GitHub-Api-Version: 2022-11-28" \
+--header "X-GitHub-Api-Version: {{ defaultRestApiVersion }}" \
   https://api.github.com/events
 ```
 
@@ -359,7 +359,7 @@ curl \
 --request POST \
 --url "{% data variables.product.rest_url %}/repos/{% ifversion ghes %}REPO-OWNER/REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}/issues" \
 --header "Accept: application/vnd.github+json" \
---header "X-GitHub-Api-Version: 2022-11-28" \
+--header "X-GitHub-Api-Version: {{ defaultRestApiVersion }}" \
 --header "Authorization: Bearer YOUR-TOKEN" \
 --data '{
   "title": "Created with the REST API",
diff --git a/src/frame/middleware/context/context.ts b/src/frame/middleware/context/context.ts
@@ -83,6 +83,10 @@ export default async function contextualize(
   req.context.nonEnterpriseDefaultVersion = nonEnterpriseDefaultVersion
   req.context.initialRestVersioningReleaseDate =
     allVersions[nonEnterpriseDefaultVersion].apiVersions[0]
+  // The default REST API version that requests use when no X-GitHub-Api-Version header is specified
+  // This is the oldest supported version (last in the sorted descending array)
+  const apiVersions = allVersions[nonEnterpriseDefaultVersion].apiVersions
+  req.context.defaultRestApiVersion = apiVersions[apiVersions.length - 1]
 
   const restDate = new Date(req.context.initialRestVersioningReleaseDate)
   req.context.initialRestVersioningReleaseDateLong = restDate.toUTCString().split(' 00:')[0]
diff --git a/src/types/types.ts b/src/types/types.ts
@@ -156,6 +156,7 @@ export type Context = {
   getDottedData?: (dottedPath: string) => unknown
   initialRestVersioningReleaseDate?: string
   initialRestVersioningReleaseDateLong?: string
+  defaultRestApiVersion?: string
   nonEnterpriseDefaultVersion?: string
   enterpriseServerVersions?: string[]
   enterpriseServerReleases?: typeof enterpriseServerReleases
