https://github.com/blueconic/openapi
BlueConic REST API v2
https://github.com/blueconic/openapi
blueconic openapi openapi3 rest
Last synced: 10 days ago
JSON representation
BlueConic REST API v2
- Host: GitHub
- URL: https://github.com/blueconic/openapi
- Owner: blueconic
- License: other
- Created: 2023-01-30T08:01:31.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-11-04T10:36:56.000Z (3 months ago)
- Last Synced: 2025-11-04T12:18:41.027Z (3 months ago)
- Topics: blueconic, openapi, openapi3, rest
- Language: JavaScript
- Homepage: https://rest.apidoc.blueconic.com/
- Size: 84.4 MB
- Stars: 1
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.MD
Awesome Lists containing this project
README
# BlueConic OpenAPI Specification
This repository contains the OpenAPI specification for the BlueConic REST API v2.
# Using the latest published OpenAPI specification
* Open https://rest.apidoc.blueconic.com
# Using the OpenAPI specification of a given BlueConic tenant
* Open https://rest.apidoc.blueconic.com/?hostname=mytenantname.blueconic.net
* Or open https://mytenantname.blueconic.net/openapi
# Running the OpenAPI specification on a local machine
* Clone the repository and `cd` to the repository location
* Run `npx http-server`
* Open `http://localhost:8080?hostname=localhost`
* CORS configuration of BlueConic needs to be adjusted to the the localhost origin (`http://localhost:8080` by default)
# Specifying BC version
The `version` querystring parameter can be used to specify a specific BlueConic version. Note that parameter is exclusive with the `hostname` parameter, which will always load the version specified by the tenant being connected to.
* https://rest.apidoc.blueconic.com/?version=89 or https://rest.apidoc.blueconic.com/?version=r89 will load version 89
* https://rest.apidoc.blueconic.com/?version=91 or https://rest.apidoc.blueconic.com/?version=r91 will load version 91
* https://rest.apidoc.blueconic.com/?version=current will load latest version published. Behaves the same as not specifying a version at all.