Skip to content

Docs: Add "/v1" where missing so endpoint docs are consistent #25798

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+20 −28
Open

Docs: Add "/v1" where missing so endpoint docs are consistent #25798

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c5d6103
add /v1 where missing
aimeeu Apr 25, 2025
e60ef51
finish adding /v1 where missing
aimeeu May 1, 2025
db9a585
remove v1 from ui.mdx
aimeeu May 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion website/content/api-docs/acl/roles.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ has been replicated to the region, and may lag behind the authoritative region.

| Method | Path | Produces |
| ------ | -------------------- | ------------------ |
| `GET` | `/acl/role/:role_id` | `application/json` |
| `GET` | `/v1/acl/role/:role_id` | `application/json` |

The table below shows this endpoint's support for
[blocking queries](/nomad/api-docs#blocking-queries),
Expand Down
4 changes: 2 additions & 2 deletions website/content/api-docs/allocations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -864,7 +864,7 @@ allocation ID.

| Method | Path | Produces |
| ------ | -------------------------------- | ------------------ |
| `GET` | `/allocation/:alloc_id/services` | `application/json` |
| `GET` | `/v1/allocation/:alloc_id/services` | `application/json` |

The table below shows this endpoint's support for
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
Expand Down Expand Up @@ -919,7 +919,7 @@ to the passed allocation ID.

| Method | Path | Produces |
| ------ | ------------------------------ | ------------------ |
| `GET` | `/allocation/:alloc_id/checks` | `application/json` |
| `GET` | `/v1/allocation/:alloc_id/checks` | `application/json` |

The table below shows this endpoint's support for
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
Expand Down
2 changes: 1 addition & 1 deletion website/content/api-docs/jobs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2520,7 +2520,7 @@ The endpoint is used to read all services registered within Nomad belonging to t

| Method | Path | Produces |
| ------ | ----------------------- | ------------------ |
| `GET` | `/job/:job_id/services` | `application/json` |
| `GET` | `/v1/job/:job_id/services` | `application/json` |

The table below shows this endpoint's support for
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
Expand Down
5 changes: 1 addition & 4 deletions website/content/api-docs/quotas.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@ description: The /quota endpoints are used to query for and interact with quotas

The `/quota` endpoints are used to query for and interact with quotas.

<EnterpriseAlert>
This API endpoint and functionality only exists in Nomad Enterprise. This is
not present in the open source version of Nomad.
</EnterpriseAlert>
<EnterpriseAlert product="nomad"/>

## List Quota Specifications

Expand Down
5 changes: 1 addition & 4 deletions website/content/api-docs/recommendations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,7 @@ description: >-
The `/recommendation` endpoints are used to query and interact with Dynamic
Application Sizing recommendations.

<EnterpriseAlert>
This API endpoint and functionality only exists in Nomad Enterprise. This is
not present in the open source version of Nomad.
</EnterpriseAlert>
<EnterpriseAlert product="nomad"/>

## List Recommendations

Expand Down
4 changes: 2 additions & 2 deletions website/content/api-docs/scaling-policies.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This endpoint returns the scaling policies from all jobs.

| Method | Path | Produces |
| ------ | ------------------- | ------------------ |
| `GET` | `/scaling/policies` | `application/json` |
| `GET` | `/v1/scaling/policies` | `application/json` |

The table below shows this endpoint's support for
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
Expand Down Expand Up @@ -102,7 +102,7 @@ This endpoint reads a specific scaling policy.

| Method | Path | Produces |
| ------ | ---------------------------- | ------------------ |
| `GET` | `/scaling/policy/:policy_id` | `application/json` |
| `GET` | `/v1/scaling/policy/:policy_id` | `application/json` |

The table below shows this endpoint's support for
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
Expand Down
13 changes: 5 additions & 8 deletions website/content/api-docs/sentinel-policies.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,7 @@ For more details about Sentinel policies, please see the [Sentinel Policy Guide]

Sentinel endpoints are only available when ACLs are enabled. For more details about ACLs, please see the [ACL Guide](/nomad/tutorials/access-control).

<EnterpriseAlert>
This API endpoint and functionality only exists in Nomad Enterprise. This is
not present in the open source version of Nomad.
</EnterpriseAlert>
<EnterpriseAlert product="nomad"/>

## List Policies

Expand All @@ -25,7 +22,7 @@ to the region, and may lag behind the authoritative region.

| Method | Path | Produces |
| ------ | -------------------- | ------------------ |
| `GET` | `/sentinel/policies` | `application/json` |
| `GET` | `/v1/sentinel/policies` | `application/json` |

The table below shows this endpoint's support for
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
Expand Down Expand Up @@ -65,7 +62,7 @@ authoritative region.

| Method | Path | Produces |
| ------ | ------------------------------- | -------------- |
| `POST` | `/sentinel/policy/:policy_name` | `(empty body)` |
| `POST` | `/v1/sentinel/policy/:policy_name` | `(empty body)` |

The table below shows this endpoint's support for
[blocking queries](/nomad/api-docs#blocking-queries) and
Expand Down Expand Up @@ -117,7 +114,7 @@ replicated to the region, and may lag behind the authoritative region.

| Method | Path | Produces |
| ------ | ------------------------------- | ------------------ |
| `GET` | `/sentinel/policy/:policy_name` | `application/json` |
| `GET` | `/v1/sentinel/policy/:policy_name` | `application/json` |

The table below shows this endpoint's support for
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
Expand Down Expand Up @@ -156,7 +153,7 @@ authoritative region.

| Method | Path | Produces |
| -------- | ------------------------------- | -------------- |
| `DELETE` | `/sentinel/policy/:policy_name` | `(empty body)` |
| `DELETE` | `/v1/sentinel/policy/:policy_name` | `(empty body)` |

The table below shows this endpoint's support for
[blocking queries](/nomad/api-docs#blocking-queries) and
Expand Down
4 changes: 2 additions & 2 deletions website/content/api-docs/services.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ This endpoint reads a specific service.

| Method | Path | Produces |
| ------ | ------------------------ | ------------------ |
| `GET` | `/service/:service_name` | `application/json` |
| `GET` | `/v1/service/:service_name` | `application/json` |

The table below shows this endpoint's support for
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
Expand Down Expand Up @@ -179,4 +179,4 @@ $ curl \
https://localhost:4646/v1/service/example-cache-redis/_nomad-task-ba731da0-6df9-9858-ef23-806e9758a899-redis-example-cache-redis-db
```

[hash]: https://en.wikipedia.org/wiki/Rendezvous_hashing
[hash]: https://en.wikipedia.org/wiki/Rendezvous_hashing
4 changes: 2 additions & 2 deletions website/content/api-docs/status.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This endpoint returns the address of the current leader in the region.

| Method | Path | Produces |
| ------ | ---------------- | ------------------ |
| `GET` | `/status/leader` | `application/json` |
| `GET` | `/v1/status/leader` | `application/json` |

The table below shows this endpoint's support for
[blocking queries](/nomad/api-docs#blocking-queries) and
Expand Down Expand Up @@ -43,7 +43,7 @@ This endpoint returns the set of raft peers in the region.

| Method | Path | Produces |
| ------ | --------------- | ------------------ |
| `GET` | `/status/peers` | `application/json` |
| `GET` | `/v1/status/peers` | `application/json` |

The table below shows this endpoint's support for
[blocking queries](/nomad/api-docs#blocking-queries) and
Expand Down
5 changes: 3 additions & 2 deletions website/content/api-docs/ui.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ description: The /ui namespace is used to access the Nomad web user interface.

# Nomad Web UI

The Nomad UI is accessible at `/ui`. It is not namespaced by version. A request to `/` will also redirect to `/ui`.
The Nomad UI is accessible at `/ui`. It is not namespaced by version, so do not
prepend `/vi` to this endpoint. A request to `/` redirects to `/ui`.

## List Jobs

Expand Down Expand Up @@ -559,7 +560,7 @@ authenticate all future requests to allow read access to additional resources.

The Nomad UI supports several keyboard shortcuts in order to help users navigate and operate Nomad. You can use common key commands to dig into jobs, view logs, monitor evaluations, and more.

Type `?` from anywhere in the UI to launch the Keyboard Shortcuts panel.
Type `?` from anywhere in the UI to launch the Keyboard Shortcuts panel.

### Default key commands:

Expand Down