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

QuantCDN Compose API

Docker compose configuration management

QuantCDN Compose API is one of 38 APIs that QuantCDN publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Compose. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 3 operations across 2 paths, and defines 18 schemas. It is described by OpenAPI 3.0.0, at version 4.15.8.

Requests are made against 2 base URLs: https://dashboard.quantcdn.io, https://dash.quantgov.cloud.

3 operations 2 paths 18 schemas 1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
4.15.8
Base URL
https://dashboard.quantcdn.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

QuantCDN Compose API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Enter your Bearer token in the format: Bearer . Obtain your API token from the QuantCDN dashboard under Profile API Tokens.

Paths & Operations 3

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

Compose 3

Docker compose configuration management

GET
/api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/compose
Get the compose file for an environment
getEnvironmentCompose 3 params → 200404
PATCH
/api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/compose
Partially Update Environment Compose Definition
patchEnvironmentCompose 3 params body → 202400404
POST
/api/v3/organizations/{organisation}/compose/validate
Validate a compose file
validateCompose 2 params body → 200422

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are Container (19 properties), patchEnvironmentCompose_202_response (9 properties), patchEnvironmentCompose_request (9 properties), Compose (9 properties). Each schema is shown below with its type and property counts.

validateCompose_422_response
object
1 property
patchEnvironmentCompose_request
object
9 properties
Container_secrets_inner
object
2 properties 2 required
Container_environment_inner
object
2 properties 2 required
Container_healthCheck
object
Container health check configuration
5 properties
patchEnvironmentCompose_400_response
object
2 properties
validateCompose_request
object
3 properties 1 required
Container_imageReference
object
2 properties 2 required
SpotConfiguration
object
Spot instance strategy configuration for controlling cost vs reliability. Spot instances provide significant cost savings (~70%) but may be interrupted by AWS.…
1 property 1 required
Container_originProtectionConfig
object
Extended origin protection configuration with IP allow list support
2 properties
patchEnvironmentCompose_202_response
object
9 properties
patchEnvironmentCompose_202_response_spotConfiguration
object
2 properties
validateCompose_200_response
object
3 properties 2 required
Container_dependsOn_inner
object
2 properties 1 required
Container_mountPoints_inner
object
3 properties 2 required
patchEnvironmentCompose_request_spotConfiguration
object
1 property
Container
object
19 properties 2 required
Compose
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quantcdn-compose-api-openapi.yml Raw ↑

Other APIs QuantCDN publishes across the network.

QuantCDN AI Agents API
QuantCDN AI Custom Tools API
QuantCDN AI File Storage API
QuantCDN AI Filter Policies API
QuantCDN AI Governance API
QuantCDN AI Inference API
QuantCDN AI Models API
QuantCDN AI Monitoring API
QuantCDN AI Orchestrations API
QuantCDN AI Sessions API
QuantCDN AI Skills API
QuantCDN AI Slack Bots API