QuantCDN Purge API

Cache purging and invalidation

OpenAPI Specification

quantcdn-purge-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  description: Unified API for QuantCDN Admin and QuantCloud Platform services
  title: QuantCDN AI Agents Purge API
  version: 4.15.8
servers:
- description: QuantCDN Public Cloud
  url: https://dashboard.quantcdn.io
- description: QuantGov Cloud
  url: https://dash.quantgov.cloud
security:
- BearerAuth: []
tags:
- description: Cache purging and invalidation
  name: Purge
paths:
  /api/v2/organizations/{organization}/projects/{project}/purge:
    post:
      operationId: Purge_create
      parameters:
      - description: Organization identifier
        example: test-org
        explode: false
        in: path
        name: organization
        required: true
        schema:
          type: string
        style: simple
      - description: Project identifier
        example: test-project
        explode: false
        in: path
        name: project
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Purge_create_request'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The request has succeeded.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2Error'
          description: The server could not understand the request due to invalid syntax.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2Error'
          description: Access is forbidden.
      summary: Purge cache via URL or cache keys
      tags:
      - Purge
components:
  schemas:
    V2Error:
      example:
        message: The requested resource was not found
        error: true
      properties:
        message:
          description: Error message
          example: The requested resource was not found
          type: string
        error:
          description: Error flag
          example: true
          type: boolean
      required:
      - error
      - message
      type: object
    Purge_create_request:
      properties:
        cache_keys:
          description: Cache keys to purge
          items:
            type: string
          type: array
        urls:
          description: URLs to purge
          items:
            type: string
          type: array
        scope:
          default: project
          description: Purge scope (org or project)
          type: string
        soft:
          default: true
          description: Soft purge
          type: boolean
      required:
      - cache_keys
      - scope
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: 'Enter your Bearer token in the format: `Bearer <your-token-here>`. Obtain your API token from the QuantCDN dashboard under Profile > API Tokens.'
      scheme: bearer
      type: http