Build the one-click apply URL for a domain

Build the one-click apply URL for a domain: CustomDomain™ API reference in the templates group. Covers parameters, request body, responses and error codes.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

domain*string

host?string

provider_base*string

vars?

The template's caller-supplied variables, the same set POST /connections/{id}/domainconnect:start takes. edgeIp and edgeIp6 are set by the server; naming one, or a variable the template does not take, answers 400 invalid_request. An unknown template answers 404.

Response Body

`application/json`

curl -X POST "https://example.com/templates/string/apply-url" \  -H "Content-Type: application/json" \  -d '{    "domain": "string",    "provider_base": "string"  }'

{  "apply_url": "http://example.com"}

{  "code": "string",  "title": "string",  "details": "string"}

{  "code": "string",  "title": "string",  "details": "string"}

{  "code": "string",  "title": "string",  "details": "string"}

Build the one-click apply URL for a domain

Path Parameters

Request Body

Response Body

200application/json

400application/json

404application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`