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 Deployments API

Manage and monitor service deployments (Portal API).

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

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

This API exposes 5 operations across 4 paths, and defines 3 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.

5 operations 4 paths 3 schemas 2 GET1 POST2 PUT

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 Deployments 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 5

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

Deployments 5

Manage and monitor service deployments (Portal API).

GET
/deployments
List deployments
getDeployments 1 param → 200401
POST
/deployments
Create a deployment
createDeployment body → 200401
GET
/deployments/{deploymentId}
Get a deployment
getDeployment 1 param → 200401
PUT
/deployments/{deploymentId}/start
Start a deployment
startDeployment 1 param → 200401
PUT
/deployments/{deploymentId}/stop
Stop a deployment
stopDeployment 1 param → 200401

Schemas 3

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

Deployment
object
8 properties
Error
object
3 properties
CreateDeploymentRequest
object
7 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quix-deployments-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 Event Data API
Quix Parameter Data API
Quix Streams API
Quix Topics API
Quix Workspaces API