API docs by Redocly

Quant API (1.9.1)

Download OpenAPI specification:Download

E-mail: api@quantcdn.io Terms of Service

The Quant Content API allows you to manage your published assets programmatically

Find out more about Quant

meta

Metadata that describes your content, files, and revisions

Returns a list of published assets

Returns a list of published assets

Authorizations:
quant_token
query Parameters
quant_type
string
Enum: "content" "redirect" "file"

Filter by asset type

published
boolean

Filter by published state

deleted
boolean

Filter by deleted state

header Parameters
Quant-Customer
required
string

The customer account name

Quant-Project
required
string

The project machine name

Quant-Url
string

Optionally limit to a single URL

Responses

Response samples

Content type
application/json
{
  • "global_meta": {
    },
  • "total_records": 1000,
  • "total_pages": 1,
  • "page": 1,
  • "page_size": 10,
  • "refine_search": false
}

Returns a list of assets by query

Returns a list of assets by query

Authorizations:
quant_token
header Parameters
Quant-Customer
required
string

The customer account name

Quant-Project
required
string

The project machine name

Request Body schema: application/json
required
Quant-Url
required
Array of any

List of URLs to retrieve meta for.

Responses

Request samples

Content type
application/json
{
  • "Quant-Url": [
    ]
}

Response samples

Content type
application/json
{
  • "global_meta": {
    }
}

Returns a list of revisions for a given asset

Returns a list of revisions for a given asset

Authorizations:
quant_token
header Parameters
Quant-Customer
required
string

The customer account name

Quant-Project
required
string

The project machine name

Responses

Response samples

Content type
application/json
{
  • "revisions": { },
  • "url": "string",
  • "published": true,
  • "published_revision": 0,
  • "transitions": [
    ],
  • "highest_revision_number": 0,
  • "transition_revision": 0
}

Returns metadata for a given revision

Returns metadata for a given revision

Authorizations:
quant_token
path Parameters
revision
required
integer
Enum: "first" "last" "published" "revision_id"

May be special key (first|last|published) or the specific revision id

include_content
required
query
Default: true

Control whether content is returned in the response

header Parameters
Quant-Customer
required
string

The customer account name

Quant-Project
required
string

The project machine name

Responses

Response samples

Content type
application/json
{
  • "md5": "string",
  • "type": "string",
  • "byte_length": 0,
  • "revision_number": 0,
  • "date_timestamp": 0,
  • "deleted": true,
  • "deleted_timestamp": 0,
  • "transitions": [
    ],
  • "info": {
    }
}

content

Perform operations on content

Create content or file revision

Create content or file revision

Authorizations:
quant_token
header Parameters
Quant-Customer
required
string

The customer account name

Quant-Project
required
string

The project machine name

Quant-File-Url
string

Required for binary file uploads only

Request Body schema: application/json
required
url
required
string <= 4096 characters

The content URL. Must be relative and start with a leading '/'

content
required
string

The content (e.g. html)

published
required
boolean

If the asset should be published

content_timestamp
integer

User defined timestamp for this content item

object (Info)

Metadata stored with this revision

Array of objects (Transition)

List of transitions

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "content": "string",
  • "published": true,
  • "content_timestamp": 0,
  • "info": {
    },
  • "transitions": [
    ]
}

Create a redirect

Create a redirect

Authorizations:
quant_token
header Parameters
Quant-Customer
required
string

The customer account name

Quant-Project
required
string

The project machine name

Request Body schema: application/json
required
url
required
string

The redirect from URL

redirect_url
required
string

The destination URL

redirect_http_code
required
integer

The HTTP code to send with the redirect

published
required
boolean

If the redirect is published

content_timestamp
integer

User defined timestamp for this content item

object (Info)

Metadata stored with this revision

Array of objects (Transition)

List of transitions

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "redirect_url": "string",
  • "redirect_http_code": 301,
  • "published": true,
  • "content_timestamp": 0,
  • "info": {
    },
  • "transitions": [
    ]
}

Unpublish an asset

Unpublish an asset

Authorizations:
quant_token
header Parameters
Quant-Customer
required
string

The customer account name

Quant-Project
required
string

The project machine name

Quant-Url
required
string

Responses

Publish an asset revision

Publish an asset revision

Authorizations:
quant_token
path Parameters
revision
required
integer
header Parameters
Quant-Customer
required
string

The customer account name

Quant-Project
required
string

The project machine name

Quant-Url
required
string

Responses

Delete an asset revision

Delete an asset revision

Authorizations:
quant_token
path Parameters
revision
required
integer

The revision to delete

header Parameters
Quant-Customer
required
string

The customer account name

Quant-Project
required
string

The project machine name

Quant-Url
required
string

The url to the asset

Responses

search

Perform operations on search index

Returns search configuration and index status

Returns search configuration and index status

Authorizations:
quant_token
header Parameters
Quant-Customer
required
string

The customer account name

Quant-Project
required
string

The project machine name

Responses

Create or update items in search index

Create or update items in search index

Authorizations:
quant_token
header Parameters
Quant-Customer
required
string

The customer account name

Quant-Project
required
string

The project machine name

Quant-Project
required
string

The project machine name

Request Body schema: application/json
required
Array
title
string

The title of a search record

content
string

The full body of content related to a search record

url
string

The URL of a search record

summary
string

The optional summary of a search record

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Delete a single record in search index

Delete a single record in search index

Authorizations:
quant_token
header Parameters
Quant-Customer
required
string

The customer account name

Quant-Project
required
string

The project machine name

Quant-Url
required
string

Responses

Clears a search index

Clears a search index

Authorizations:
quant_token
header Parameters
Quant-Customer
required
string

The customer account name

Quant-Project
required
string

The project machine name

Responses

misc

Project validate

Ping the server. This endpoint can be used to verify credentials for a given project. Returns basic project detail and configuration

Authorizations:
quant_token
header Parameters
Quant-Customer
required
string

The customer account name

Quant-Project
required
string

The project machine name

Responses

Purge CDN cache

Purge CDN cache. Supports purging via individual content paths or cache-keys.

Authorizations:
quant_token
header Parameters
Quant-Customer
required
string

The customer account name

Quant-Project
required
string

The project machine name

Quant-Url
string
Example: /content

The URL path to purge

Cache-Keys
string
Example: azbe5 gormb1

The cache keys to purge separated by a space

Soft-Purge
string
Example: true

Set to issue a soft-purge of the content, which will make it as stale rather than immediately delete from edge caches

Responses