Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Quix Workspaces API

Manage Quix Cloud workspaces / environments (Portal API).

Quix Workspaces API is one of 9 APIs that Quix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workspaces. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 2 base URLs: https://writer-{environmentId}.cloud.quix.io, https://portal-api.platform.quix.io.

2 operations 2 paths 2 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://writer-{environmentId}.cloud.quix.io
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Quix Workspaces API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (PAT) (bearerAuth).

  • bearerAuth — Quix Personal Access Token (PAT) presented as Authorization: Bearer . Generate from the Quix portal under your profile Personal Access Tokens, or Settings APIs…

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Workspaces 2

Manage Quix Cloud workspaces / environments (Portal API).

GET
/workspaces
List workspaces
getWorkspaces → 200401
GET
/workspaces/{workspaceId}
Get a workspace
getWorkspace 1 param → 200401

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Workspace (4 properties), Error (3 properties). Each schema is shown below with its type and property counts.

Workspace
object
4 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quix-workspaces-api-openapi.yml Raw ↑

Other APIs Quix publishes across the network.

Quix Streaming Reader API (Real-time)
Quix Streams (Open Source)
Quix Definitions API
Quix Deployments API
Quix Event Data API
Quix Parameter Data API
Quix Streams API
Quix Topics API