QuantCDN Dashboard API (1.3.0)

Download OpenAPI specification:Download

Provides programmatic interface for projects within QuantCDN

Purge CDN cache

Purges edge caches for a specified path

Authorizations:

ApiTokenAuth

header Parameters

Quant-Organisation required	string Example: quant
Quant-Project required	string Example: quantcdn

Request Body schema: application/json

Purge path

path	string Provide a URL path to purge caches for. The wildcard character (*) is accepted.

Responses

Request samples

Payload

Content type

application/json

{"path": "{'path': '/blog/*'}"
}

Response samples

200
400
403

Content type

application/json

{"project": "quant-project-name",
"message": "Purge request accepted."
}

Get organisations

List of organisations for your QuantCDN account

Authorizations:

ApiTokenAuth

Responses

Response samples

200
403

Content type

application/json

{"data": {"organisations": [{"name": "quant",
"machine_name": "quant"
}
]
}
}

Get projects

List of QuantCDN projects

Authorizations:

ApiTokenAuth

header Parameters

Quant-Organisation

required

string

Example: quant

Responses

Response samples

200
403

Content type

application/json

{"data": {"projects": [{"name": "quant",
"machine_name": "quant"
}
]
}
}

Get project

Get QuantCDN project

Authorizations:

ApiTokenAuth

header Parameters

Quant-Organisation required	string Example: quant
Quant-Project required	string Example: quantcdn

Responses

Response samples

200
403

Content type

application/json

{"data": {"project": {"name": "quant",
"machine_name": "quant",
"token": "aabbcc",
"config": {"query_params_enabled": true,
"search_enabled": false
},
"domains": [{"domain": "example.quantcdn.io",
"dns_engaged": 0
}
]
}
}
}

Create project

Create QuantCDN project

Authorizations:

ApiTokenAuth

header Parameters

Quant-Organisation

required

string

Example: quant

Request Body schema: application/json

Project schema

name required	string
region required	string
allow_query_params	boolean
basic_auth_username	string
basic_auth_password	string
basic_auth_preview_only	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "quantcdn-project",
"region": "au",
"allow_query_params": true,
"basic_auth_username": "user",
"basic_auth_password": "pass",
"basic_auth_preview_only": false
}

Response samples

200
400
403

Content type

application/json

{"name": "quant",
"machine_name": "quant",
"token": "aabbcc",
"config": {"query_params_enabled": true,
"search_enabled": false
},
"domains": [{"domain": "example.quantcdn.io",
"dns_engaged": 0
}
]
}

Edit project

Edit QuantCDN project

Authorizations:

ApiTokenAuth

header Parameters

Quant-Organisation required	string Example: quant
Quant-Project required	string Example: quantcdn

Request Body schema: application/json

Project schema

name	string
region	string
allow_query_params	boolean
basic_auth_username	string
basic_auth_password	string
basic_auth_preview_only	boolean
custom_s3_sync_bucket	string Optional bucket name for S3 sync function
custom_s3_sync_region	string Bucket region for S3 sync. Required if s3 sync bucket is provided
custom_s3_sync_access_key	string Access key for S3 sync. Required if s3 sync bucket is provided
custom_s3_sync_secret_key	string Secret key for S3 sync. Required if s3 sync bucket is provided

Responses

Request samples

Payload

Content type

application/json

{"name": "quantcdn-project",
"region": "au",
"allow_query_params": true,
"basic_auth_username": "user",
"basic_auth_password": "pass",
"basic_auth_preview_only": false,
"custom_s3_sync_bucket": "s3-bucket-name",
"custom_s3_sync_region": "us-west-1",
"custom_s3_sync_access_key": "string",
"custom_s3_sync_secret_key": "string"
}

Response samples

200
400
403

Content type

application/json

{"name": "quant",
"machine_name": "quant",
"token": "aabbcc",
"config": {"query_params_enabled": true,
"search_enabled": false
},
"domains": [{"domain": "example.quantcdn.io",
"dns_engaged": 0
}
]
}

Delete project

Delete QuantCDN project

Authorizations:

ApiTokenAuth

header Parameters

Quant-Organisation required	string Example: quant
Quant-Project required	string Example: quantcdn

Responses

Response samples

200
400
403

Content type

application/json

{"data": {"message": "Success."
}
}

Create domaim

Create QuantCDN domain

Authorizations:

ApiTokenAuth

header Parameters

Quant-Organisation required	string Example: quant
Quant-Project required	string Example: quantcdn

Request Body schema: application/json

Domain schema

domain

required

string

Responses

Request samples

Payload

Content type

application/json

{"domain": "example.quantcdn.io"
}

Response samples

200
400
403

Content type

application/json

{"data": {"message": "Domain added successfully."
}
}

Delete domain

Delete QuantCDN domain

Authorizations:

ApiTokenAuth

query Parameters

domain

required

string

Example: domain=example.quantcdn.io

header Parameters

Quant-Organisation required	string Example: quant
Quant-Project required	string Example: quantcdn

Responses

Response samples

200
400
403

Content type

application/json

{"data": {"message": "Domain deleted successfully."
}
}

Renew domain SSL certificate

SSL certificates will generate and renew automatically

Authorizations:

ApiTokenAuth

header Parameters

Quant-Organisation required	string Example: quant
Quant-Project required	string Example: quantcdn-project

Request Body schema: application/json

domain

required

string

Responses

Request samples

Payload

Content type

application/json

{"domain": "example.quantcdn.io"
}

Response samples

200
400
403

Content type

application/json

{"data": {"message": "Certificate created/renewed successfully."
}
}

Get crawl configs

List of crawler configurations

Authorizations:

ApiTokenAuth

header Parameters

Quant-Organisation required	string Example: quant
Quant-Project required	string Example: quantcdn

Responses

Response samples

200
403

Content type

application/json

{"name": "Crawler configuration example",
"uuid": "fced63f0-2a61-4a25-bb0c-a40b055d6194",
"domain": "https://www.example.com",
"url_count": 50
}

Run crawl config

Triggers a new run for a specified crawler configuration

Authorizations:

ApiTokenAuth

path Parameters

uuid

required

any

UUID of the crawler to run

header Parameters

Quant-Organisation required	string Example: quant
Quant-Project required	string Example: quantcdn-project

Request Body schema: application/json

urls	Array of strings Optionally provide manual URLs to crawl. Full crawl will run otherwise.

Responses

Request samples

Payload

Content type

application/json

{"urls": "{'urls': ['/example1', '/example2']}"
}

Response samples

200
400
403

Content type

application/json

{"data": {"message": "Crawl request accepted.",
"run_id": 1234
}
}

Get crawl run status

Retrieve the status of a crawl run

Authorizations:

ApiTokenAuth

path Parameters

runId

required

any

Run ID to retrieve status for

header Parameters

Quant-Organisation required	string Example: quant
Quant-Project required	string Example: quantcdn

Responses

Response samples

200
400
403

Content type

application/json

{"status": "running",
"started_at": "1602756600",
"completed_at": null
}