This page describes the format for the current Hangar REST API as well as general usage guidelines.<br> Note that all routes **not** listed here should be considered **internal**, and can change at a moment's notice. **Do not use them**. ## Authentication and Authorization There are two ways to consume the API: Authenticated or anonymous. ### Anonymous When using anonymous authentication, you only have access to public information, but you don't need to worry about creating and storing an API key or handing JWTs. ### Authenticated If you need access to non-public content or actions, you need to create and use API keys. These can be created by going to the API keys page via the profile dropdown or by going to your user page and clicking on the key icon. API keys allow you to impersonate yourself, so they should be handled like passwords. **Do not share them with anyone else!** #### Getting and Using a JWT Once you have an API key, you need to authenticate yourself: Send a `POST` request with your API key identifier to `/api/v1/authenticate?apiKey=yourKey`. The response will contain your JWT as well as an expiration time. Put this JWT into the `Authorization` header of every request and make sure to request a new JWT after the expiration time has passed. Please also set a meaningful `User-Agent` header. This allows us to better identify loads and needs for potentially new endpoints. ## Misc ### Date Formats Standard ISO types. Where possible, we use the [OpenAPI format modifier](https://swagger.io/docs/specification/data-models/data-types/#format). ### Rate Limits and Caching The default rate limit is set at 20 requests every 5 seconds with an initial overdraft for extra leniency. Individual endpoints, such as version creation, may have stricter rate limiting. If applicable, always cache responses. The Hangar API itself is cached by CloudFlare and internally.
Raw data
{
"_id": null,
"home_page": "",
"name": "hangar-api",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "OpenAPI,OpenAPI-Generator,Hangar API",
"author": "OpenAPI Generator community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/1e/89/5d697d5e684244cd6e55811242f82c5716bb28c07d62ddde3e6f1ce81b67/hangar-api-2023.12.tar.gz",
"platform": null,
"description": " This page describes the format for the current Hangar REST API as well as general usage guidelines.<br> Note that all routes **not** listed here should be considered **internal**, and can change at a moment's notice. **Do not use them**. ## Authentication and Authorization There are two ways to consume the API: Authenticated or anonymous. ### Anonymous When using anonymous authentication, you only have access to public information, but you don't need to worry about creating and storing an API key or handing JWTs. ### Authenticated If you need access to non-public content or actions, you need to create and use API keys. These can be created by going to the API keys page via the profile dropdown or by going to your user page and clicking on the key icon. API keys allow you to impersonate yourself, so they should be handled like passwords. **Do not share them with anyone else!** #### Getting and Using a JWT Once you have an API key, you need to authenticate yourself: Send a `POST` request with your API key identifier to `/api/v1/authenticate?apiKey=yourKey`. The response will contain your JWT as well as an expiration time. Put this JWT into the `Authorization` header of every request and make sure to request a new JWT after the expiration time has passed. Please also set a meaningful `User-Agent` header. This allows us to better identify loads and needs for potentially new endpoints. ## Misc ### Date Formats Standard ISO types. Where possible, we use the [OpenAPI format modifier](https://swagger.io/docs/specification/data-models/data-types/#format). ### Rate Limits and Caching The default rate limit is set at 20 requests every 5 seconds with an initial overdraft for extra leniency. Individual endpoints, such as version creation, may have stricter rate limiting. If applicable, always cache responses. The Hangar API itself is cached by CloudFlare and internally.\n \n",
"bugtrack_url": null,
"license": "",
"summary": "Hangar API",
"version": "2023.12",
"project_urls": null,
"split_keywords": [
"openapi",
"openapi-generator",
"hangar api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bfb6000e7339101e9883a3fb44736113bac8b6a859507bcf2633f605470ac297",
"md5": "80dfddf715b34eff874cd249b6ebcc5d",
"sha256": "5cda73b0e87e4dcb208620c4bc117c0b5a2ab9a6a08895fb4c504a0129a513eb"
},
"downloads": -1,
"filename": "hangar_api-2023.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "80dfddf715b34eff874cd249b6ebcc5d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 155346,
"upload_time": "2023-12-01T00:51:48",
"upload_time_iso_8601": "2023-12-01T00:51:48.064668Z",
"url": "https://files.pythonhosted.org/packages/bf/b6/000e7339101e9883a3fb44736113bac8b6a859507bcf2633f605470ac297/hangar_api-2023.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1e895d697d5e684244cd6e55811242f82c5716bb28c07d62ddde3e6f1ce81b67",
"md5": "e522dcbd8600b3b123c8d8bdefc114ec",
"sha256": "15b3e1dc3ec3133ebeabfd9bd90245a9ebff9eb016397b4ef02c9570d5d8173a"
},
"downloads": -1,
"filename": "hangar-api-2023.12.tar.gz",
"has_sig": false,
"md5_digest": "e522dcbd8600b3b123c8d8bdefc114ec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 63483,
"upload_time": "2023-12-01T00:51:49",
"upload_time_iso_8601": "2023-12-01T00:51:49.855376Z",
"url": "https://files.pythonhosted.org/packages/1e/89/5d697d5e684244cd6e55811242f82c5716bb28c07d62ddde3e6f1ce81b67/hangar-api-2023.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-01 00:51:49",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "hangar-api"
}
JSON