Skip to content

Commit 59a067c

Browse files
authored
Nixhub Links (#2218)
## Summary Add links to typeform and calendly on Nixhub Docs page ## How was it tested? Localhost
1 parent 295b26b commit 59a067c

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

docs/app/docs/nixhub/index.mdx

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,25 @@ import DocCardList from "@theme/DocCardList";
1717
<span
1818
className={"theme-doc-version-badge badge badge--secondary"}
1919
children={"Version: 2.0.0"}
20+
style={{marginBottom:'20px'}}
2021
>
2122
</span>
2223

2324
# Using the Nixhub API
2425

25-
The Nixhub API lets you search over 1 million package versions for over 100,000 Nix packages. You can use the Nixhub API to search for packages, resolve historic versions, and then install them using Devbox or Nix. Nixhub is designed to be simple and easy to use, and is free to use for personal use.
26+
The [**Nixhub**](https://www.nixhub.io) API lets you search over 1 million package versions for over 100,000 Nix packages. You can use the Nixhub API to search for packages, resolve historic versions, and then install them using Devbox or Nix. Nixhub is designed to be simple and easy to use, and is free to use for personal use.
2627

2728
Nixhub is a RESTful API that uses standard HTTP methods and status codes. Parameters are passed to the API as query parameters, and the API returns JSON responses. The current version does not make use of pagination, though this may be added in the future.
2829

29-
Nixhub exposes the following endpoints for searching and resolving packages:
30+
The API is available for free for personal use, subject to rate limiting. If you need a higher rate limit or wish to use Devbox for a commercial project, you can [**request access to our paid tier**](https://form.typeform.com/to/hueeLe9S).
31+
32+
### Endpoints
3033

31-
- `v2/search` - Search for packages by name
32-
- `v2/pkg` - Get details and version history for a specific package
33-
- `v2/resolve` - Resolve a package name and version to a nixpkgs commit and attribute path.
34+
Nixhub exposes the following endpoints for searching and resolving packages:
3435

36+
- [`v2/search`](./search-packages.api.mdx) - Search for packages by name
37+
- [`v2/pkg`](./get-a-package.api.mdx) - Get details and version history for a specific package
38+
- [`v2/resolve`](./resolve-a-package-version.api.mdx) - Resolve a package name and version to a nixpkgs commit and attribute path.
3539

3640
### Rate Limits
3741

@@ -43,7 +47,15 @@ In order to prevent abuse, personal use of the API is subject to rate limits. AP
4347

4448
If the pool is empty, the API will return a `429 Too Many Requests` status code.
4549

46-
If you have a use case that requires a higher rate limit or would like to use the API for commercial purposes, please Contact Us.
50+
:::tip
51+
52+
If you have a use case that requires a higher rate limit or would like to use the API for commercial purposes, please fill out [**this form**](https://form.typeform.com/to/hueeLe9S) to request access.
53+
54+
:::
55+
56+
### Nixhub for Enterprise
57+
58+
Nixhub provides an index of publicly available packages from the [Nixpkgs](https://github.com/nixos/nixpkgs) repository. If you're interested in using Nixhub to index and install private packages or Flakes for your team, we'd love to chat with you. You can request a meeting [**with our team**](https://calendly.com/d/cprm-dq6-y9y/nixhub-enterprise-chat)
4759

4860
### Versioning
4961

@@ -55,5 +67,3 @@ The API is versioned using a `v2` prefix in the URL. All `v2` endpoints are cons
5567
* [Get Package Details](./get-a-package.api.mdx) - Get details and version history for a specific package
5668
* [Resolve Package](./resolve-a-package-version.api.mdx) - Resolve the latest available package for a given name and version string
5769

58-
59-

0 commit comments

Comments
 (0)