## Borneo_python_client Client
borneo_python_client client
### Documentation
# Overview
The Borneo API v3 provides a set of RESTful APIs to query and manage the
Borneo Inventory and Catalog, and to schedule data scans and retrieve scan
results. Request and response payloads are JSON documents.
## API Endpoint
The API endpoint for the Borneo API is hosted on the same domain as the Borneo Dashboard, under the `/api/` path.
```
https://demo.app.borneodata.com/api/
```
## Authentication
Requests to the Borneo API must be authenticated using an authentication token. The token is passed in the `Authorization` header of the request.
```
Authorization: Bearer <token>
```
This authorization Bearer token can generated using service accounts and Borneo SDK or directly download Borneo token from dashboard for testing.
## Pagination
All list operations support pagination. The `pageSize` parameter can be
used to control the number of results returned per API request. If there
are more results available, the API response will contain a `nextToken`
value that can be used to retrieve the next page of results by passing it
as the `nextToken` parameter in a subsequent API request.
Raw data
{
"_id": null,
"home_page": null,
"name": "borneo-python-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "smithy, borneo_python_client",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/e8/87/a3a08f02e76258c9f56075acfb60156d3f6162a6676e393f3d8015602466/borneo_python_client-3.10.3.tar.gz",
"platform": null,
"description": "## Borneo_python_client Client\n\nborneo_python_client client\n\n### Documentation\n\n# Overview\n\nThe Borneo API v3 provides a set of RESTful APIs to query and manage the\nBorneo Inventory and Catalog, and to schedule data scans and retrieve scan\nresults. Request and response payloads are JSON documents.\n\n## API Endpoint\n\nThe API endpoint for the Borneo API is hosted on the same domain as the Borneo Dashboard, under the `/api/` path.\n\n```\nhttps://demo.app.borneodata.com/api/\n```\n\n## Authentication\n\nRequests to the Borneo API must be authenticated using an authentication token. The token is passed in the `Authorization` header of the request.\n\n```\nAuthorization: Bearer <token>\n```\n\nThis authorization Bearer token can generated using service accounts and Borneo SDK or directly download Borneo token from dashboard for testing.\n\n## Pagination\n\nAll list operations support pagination. The `pageSize` parameter can be\nused to control the number of results returned per API request. If there\nare more results available, the API response will contain a `nextToken`\nvalue that can be used to retrieve the next page of results by passing it\nas the `nextToken` parameter in a subsequent API request.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "borneo_python_client client",
"version": "3.10.3",
"project_urls": null,
"split_keywords": [
"smithy",
" borneo_python_client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3b8bf98e3e408fb0b803e80efc32b5b22245b0f291bdb09444649ec65de8769d",
"md5": "3ad639c36ab87a9d7363b590a5e30beb",
"sha256": "e55f5f2e2af63e97bcf53577a04229852f664e3c91482b03ebd26e7ceb98191a"
},
"downloads": -1,
"filename": "borneo_python_client-3.10.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3ad639c36ab87a9d7363b590a5e30beb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 136027,
"upload_time": "2024-05-13T03:53:04",
"upload_time_iso_8601": "2024-05-13T03:53:04.126970Z",
"url": "https://files.pythonhosted.org/packages/3b/8b/f98e3e408fb0b803e80efc32b5b22245b0f291bdb09444649ec65de8769d/borneo_python_client-3.10.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e887a3a08f02e76258c9f56075acfb60156d3f6162a6676e393f3d8015602466",
"md5": "64b4647faf20ca884a24721a35b25ca0",
"sha256": "ebfa61ac6fb0fa8e7e1b29c113992c36958600a7be94ff06b091d6b488f07a2c"
},
"downloads": -1,
"filename": "borneo_python_client-3.10.3.tar.gz",
"has_sig": false,
"md5_digest": "64b4647faf20ca884a24721a35b25ca0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 118701,
"upload_time": "2024-05-13T03:53:05",
"upload_time_iso_8601": "2024-05-13T03:53:05.932547Z",
"url": "https://files.pythonhosted.org/packages/e8/87/a3a08f02e76258c9f56075acfb60156d3f6162a6676e393f3d8015602466/borneo_python_client-3.10.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-13 03:53:05",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "borneo-python-client"
}
JSON