API docs by Redocly

ApexWise (1.1.0)

Download OpenAPI specification:Download

A simple API to manage apex and vanity domain redirections via ApexWise.

Organisations

Organisation management endpoints

Get organisations

List all organisations accessible to your API token

Authorizations:
ApiTokenAuth

Responses

Request samples 

curl "https://dash.apexwise.io/api/v1/organisations" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response samples

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

Domains

Domain redirect management endpoints

Get domains

List of Apex domain redirects. Requires a token with access to the specified organisation.

Authorizations:
ApiTokenAuth
header Parameters
Quant-Organisation
required
string
Example: quant

Responses

Request samples 

curl -X GET "https://dash.apexwise.io/api/v1/domains" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Quant-Organisation: quantcdn"

Response samples

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

Get domain

Get details for a specific Apex domain redirect

Authorizations:
ApiTokenAuth
path Parameters
domain
required
string
Example: example.quantcdn.io

The apex domain to manage

header Parameters
Quant-Organisation
required
string
Example: quant

Responses

Request samples 

curl -X GET "https://dash.apexwise.io/api/v1/domain/example.quantcdn.io" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Quant-Organisation: quantcdn"

Response samples

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

Create domain

Create Apex domain redirect with optional SSL certificate

Authorizations:
ApiTokenAuth
header Parameters
Quant-Organisation
required
string
Example: quant
Request Body schema: application/json
required

Domain creation details

domain
required
string

The apex domain to redirect

redirect
required
string

The destination domain (without protocol)

include_path
boolean

Whether to include the request path in the redirect

public_cert
string

Optional SSL certificate in PEM format

private_cert
string

Optional SSL private key in PEM format

Responses

Request samples

Content type
application/json
{
  • "domain": "example.com",
  • "redirect": "www.example.com",
  • "include_path": true,
  • "public_cert": "-----BEGIN CERTIFICATE-----...",
  • "private_cert": "-----BEGIN PRIVATE KEY-----..."
}

Response samples

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

Update domain

Update an existing domain's configuration. You can update the redirect target, path behavior, or SSL certificates independently.

Authorizations:
ApiTokenAuth
path Parameters
domain
required
string
Example: example.quantcdn.io

The apex domain to manage

header Parameters
Quant-Organisation
required
string
Example: quant
Request Body schema: application/json
redirect
string

The destination domain (without protocol)

include_path
boolean

Whether to include the request path in the redirect

public_cert
string

Optional SSL certificate in PEM format

private_cert
string

Optional SSL private key in PEM format

Responses

Request samples

Content type
application/json
Example
{
  • "include_path": false
}

Response samples

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

Delete domain

Remove a domain redirect configuration

Authorizations:
ApiTokenAuth
path Parameters
domain
required
string
Example: example.quantcdn.io

The apex domain to manage

header Parameters
Quant-Organisation
required
string
Example: quant

Responses

Request samples 

curl -X DELETE "https://dash.apexwise.io/api/v1/domain/example.quantcdn.io/delete" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Quant-Organisation: quantcdn"

Response samples

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

Renew SSL certificate

Attempt to renew the SSL certificate for a specific domain

Authorizations:
ApiTokenAuth
path Parameters
domain
required
string
Example: example.quantcdn.io

The apex domain to manage

header Parameters
Quant-Organisation
required
string
Example: quant

Responses

Request samples 

curl -X POST "https://dash.apexwise.io/api/v1/domain/testing.firecannon.com/ssl-renew" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Quant-Organisation: quantcdn" \
  -H "Content-Type: application/json"

Response samples

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