Skip to content

ZenHub Enterprise 3 api documentation updates #120

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

Merged
merged 3 commits into from
Apr 13, 2021
Merged

ZenHub Enterprise 3 api documentation updates #120

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
58cc065
Adding instructions for ZHE3
Apr 12, 2021
e5cabdb
Removing reference to deprecated instruction page
Apr 12, 2021
50f290b
Update README.md
cwarje Apr 12, 2021
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
19 changes: 15 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,24 @@ You can also submit a feature request [here](https://portal.productboard.com/zen

## Root Endpoint

On Cloud, the root endpoint for the public API is `https://api.zenhub.com/`.
For ZenHub Enterprise, the root endpoint is `https://<zenhub_enterprise_host>/`.
The ZenHub API root endpoint for Cloud is different than that of ZenHub On-Premise Enterprise instances and has also changed across Enterprise versions. Please refer to the table below for the appropriate endpoint.

ZenHub Version | API Root Endpoint
--- | ---
Cloud | `https://api.zenhub.com/`
Enterprise 2 | `https://<zenhub_enterprise_host>/`
Enterprise 3 | `https://<zenhub_enterprise_host>/api/`

## Authentication

All requests to the API need an API token. Generate a token in the **API Tokens** section of your ZenHub [Dashboard](https://app.zenhub.com/dashboard/tokens) (or `https://<zenhub_enterprise_host>/app/dashboard/tokens` for ZenHub Enterprise). The token is sent in the `X-Authentication-Token` header. For example, using `curl` it’d be:
All requests to the API need an API token. Generate a token in the **API Tokens** section of your ZenHub [Dashboard](https://app.zenhub.com/dashboard/tokens) (for ZenHub Enterprise, refer to the table below for the proper link).

ZenHub Enterprise Version | Auth Token Generation Page
--- | ---
Enterprise 2 | `https://<zenhub_enterprise_host>/app/dashboard/tokens`
Enterprise 3 | `https://<zenhub_enterprise_host>/dashboard/tokens`

The token is sent in the `X-Authentication-Token` header. For example, using `curl` it would be:

```sh
curl -H 'X-Authentication-Token: TOKEN' URL
Expand All @@ -74,7 +86,6 @@ Alternatively, you can choose to send the token in the URL using the `access_tok
#### Notes

- Each user may only have one token, so generating a new token will invalidate previously created tokens.
- For ZenHub Enterprise users, please follow the instructions in `https://<zenhub_enterprise_host>/setup/howto/api`

## Content-Type: JSON

Expand Down