The Zuplo Developer API, powered by Zuplo

Custom Domains

Endpointhttps://dev.zuplo.com

Manage account custom domains and their deployment mappings

Get Custom Domains

GET

https://dev.zuplo.com

/v1/accounts/{accountName}/custom-domains

Gets the account custom domains

Get Custom Domains › path Parameters

accountName

string · required

The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

Get Custom Domains › Responses

The request has succeeded.

Response containing a paginated list of custom domains.

object[] · required

The custom domains returned for the account.

offset

integer · uint32 · required

The number of records skipped.

Example: 0

limit

integer · uint32 · required

The maximum number of records returned.

Example: 100

GET/v1/accounts/{accountName}/custom-domains

curl --request GET \
  --url https://dev.zuplo.com/v1/accounts/:accountName/custom-domains

shell

Example Responses

{
  "data": [
    {
      "id": "cdm_01HZX8D7A1M9S0K4Y2N6P3Q8R5",
      "accountName": "chocolate_great_buzzard",
      "projectName": "todo-list-api",
      "deployments": [
        {
          "deploymentName": "todo-list-api-main-59eec11",
          "branch": "main",
          "environmentType": "PRODUCTION",
          "isDefault": true,
          "stage": "api",
          "cname": "todo-list-api-main-59eec11.zuplo.app"
        }
      ],
      "hostname": "api.example.com",
      "provider": "cloudflare"
    }
  ],
  "offset": 0,
  "limit": 100
}

json

application/json

Create Custom Domain

POST

https://dev.zuplo.com

/v1/accounts/{accountName}/custom-domains

Creates a custom domain

Create Custom Domain › path Parameters

accountName

string · required

The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

Create Custom Domain › Request Body

Request body for creating a custom domain.

hostname

string · required

The hostname to configure as a custom domain.

Example: api.example.com

deploymentName

string

The deployment to associate with the hostname.

Example: todo-list-api-main-59eec11

stage

string · enum

The stage to expose on the hostname.

Enum values:

api

dev-portal

Example: api

isDefault

boolean

Whether this domain should be the default domain for the deployment.

Example: true

isAlias

boolean

Whether the domain should be configured as an alias.

Example: false

Create Custom Domain › Responses

The request has succeeded.

The result of creating or updating a custom domain.

deploymentName

string | null · required

The deployment associated with the hostname.

Example: todo-list-api-main-59eec11

hostname

string · required

The hostname that was created or updated.

Example: api.example.com

stage

string · enum · required

The stage exposed by the hostname.

Enum values:

api

dev-portal

Example: api

object · required

The DNS record required to verify domain ownership, if any.

Example: {"name":"_zuplo.api.example.com","type":"TXT","value":"zuplo-verification-token"}

cname

string | null · required

The CNAME target for the custom domain, if any.

Example: todo-list-api-main-59eec11.zuplo.app

POST/v1/accounts/{accountName}/custom-domains

curl --request POST \
  --url https://dev.zuplo.com/v1/accounts/:accountName/custom-domains \
  --header 'Content-Type: application/json' \
  --data '
{
  "hostname": "api.example.com",
  "deploymentName": "todo-list-api-main-59eec11",
  "stage": "api",
  "isDefault": true,
  "isAlias": false
}
'

shell

Example Request Body

{
  "hostname": "api.example.com",
  "deploymentName": "todo-list-api-main-59eec11",
  "stage": "api",
  "isDefault": true,
  "isAlias": false
}

json

Example Responses

{
  "deploymentName": "todo-list-api-main-59eec11",
  "hostname": "api.example.com",
  "stage": "api",
  "ownershipVerification": {
    "name": "_zuplo.api.example.com",
    "type": "TXT",
    "value": "zuplo-verification-token"
  },
  "cname": "todo-list-api-main-59eec11.zuplo.app"
}

json

application/json

Delete a Custom Domain

DELETE

https://dev.zuplo.com

/v1/accounts/{accountName}/custom-domains

Delete a custom domain

Delete a Custom Domain › path Parameters

accountName

string · required

The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

Delete a Custom Domain › query Parameters

hostname

string · required

The hostname of the custom domain to delete.

deploymentName

string

The deployment associated with the hostname, when deleting a deployment-specific mapping.

Delete a Custom Domain › Responses

The request has succeeded.

No data returned

Update a Custom Domain

PATCH

https://dev.zuplo.com

/v1/accounts/{accountName}/custom-domains

Updates a custom domain

Update a Custom Domain › path Parameters

accountName

string · required

The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

Update a Custom Domain › Request Body

Request body for updating a custom domain.

hostname

string · required

The hostname to update.

Example: api.example.com

deploymentName

string

The deployment to associate with the hostname.

Example: todo-list-api-main-59eec11

isDefault

boolean

Whether this domain should be the default domain for the deployment.

Example: true

Update a Custom Domain › Responses

The request has succeeded.

The result of creating or updating a custom domain.

deploymentName

string | null · required

The deployment associated with the hostname.

Example: todo-list-api-main-59eec11

hostname

string · required

The hostname that was created or updated.

Example: api.example.com

stage

string · enum · required

The stage exposed by the hostname.

Enum values:

api

dev-portal

Example: api

object · required

The DNS record required to verify domain ownership, if any.

Example: {"name":"_zuplo.api.example.com","type":"TXT","value":"zuplo-verification-token"}

cname

string | null · required

The CNAME target for the custom domain, if any.

Example: todo-list-api-main-59eec11.zuplo.app

PATCH/v1/accounts/{accountName}/custom-domains

curl --request PATCH \
  --url https://dev.zuplo.com/v1/accounts/:accountName/custom-domains \
  --header 'Content-Type: application/json' \
  --data '
{
  "hostname": "api.example.com",
  "deploymentName": "todo-list-api-main-59eec11",
  "isDefault": true
}
'

shell

Example Request Body

{
  "hostname": "api.example.com",
  "deploymentName": "todo-list-api-main-59eec11",
  "isDefault": true
}

json

Example Responses

{
  "deploymentName": "todo-list-api-main-59eec11",
  "hostname": "api.example.com",
  "stage": "api",
  "ownershipVerification": {
    "name": "_zuplo.api.example.com",
    "type": "TXT",
    "value": "zuplo-verification-token"
  },
  "cname": "todo-list-api-main-59eec11.zuplo.app"
}

json

application/json

Audit Logs Deployments

Get Custom Domains

GET

https://dev.zuplo.com

/v1/accounts/{accountName}/custom-domains

Gets the account custom domains

Get Custom Domains › path Parameters

accountName

string · required

The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

Get Custom Domains › Responses

The request has succeeded.

Response containing a paginated list of custom domains.

object[] · required

The custom domains returned for the account.

offset

integer · uint32 · required

The number of records skipped.

Example: 0

limit

integer · uint32 · required

The maximum number of records returned.

Example: 100

Create Custom Domain

POST

https://dev.zuplo.com

/v1/accounts/{accountName}/custom-domains

Creates a custom domain

Create Custom Domain › path Parameters

accountName

string · required

The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

Create Custom Domain › Request Body

Request body for creating a custom domain.

hostname

string · required

The hostname to configure as a custom domain.

Example: api.example.com

deploymentName

string

The deployment to associate with the hostname.

Example: todo-list-api-main-59eec11

stage

string · enum

The stage to expose on the hostname.

Enum values:

api

dev-portal

Example: api

isDefault

boolean

Whether this domain should be the default domain for the deployment.

Example: true

isAlias

boolean

Whether the domain should be configured as an alias.

Example: false

Create Custom Domain › Responses

The request has succeeded.

The result of creating or updating a custom domain.

deploymentName

string | null · required

The deployment associated with the hostname.

Example: todo-list-api-main-59eec11

hostname

string · required

The hostname that was created or updated.

Example: api.example.com

stage

string · enum · required

The stage exposed by the hostname.

Enum values:

api

dev-portal

Example: api

object · required

The DNS record required to verify domain ownership, if any.

Example: {"name":"_zuplo.api.example.com","type":"TXT","value":"zuplo-verification-token"}

cname

string | null · required

The CNAME target for the custom domain, if any.

Example: todo-list-api-main-59eec11.zuplo.app

Delete a Custom Domain

DELETE

https://dev.zuplo.com

/v1/accounts/{accountName}/custom-domains

Delete a custom domain

Delete a Custom Domain › path Parameters

accountName

string · required

The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

Delete a Custom Domain › query Parameters

hostname

string · required

The hostname of the custom domain to delete.

deploymentName

string

The deployment associated with the hostname, when deleting a deployment-specific mapping.

Delete a Custom Domain › Responses

The request has succeeded.

No data returned

Update a Custom Domain

PATCH

https://dev.zuplo.com

/v1/accounts/{accountName}/custom-domains

Updates a custom domain

Update a Custom Domain › path Parameters

accountName

string · required

The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

Update a Custom Domain › Request Body

Request body for updating a custom domain.

hostname

string · required

The hostname to update.

Example: api.example.com

deploymentName

string

The deployment to associate with the hostname.

Example: todo-list-api-main-59eec11

isDefault

boolean

Whether this domain should be the default domain for the deployment.

Example: true

Update a Custom Domain › Responses

The request has succeeded.

The result of creating or updating a custom domain.

deploymentName

string | null · required

The deployment associated with the hostname.

Example: todo-list-api-main-59eec11

hostname

string · required

The hostname that was created or updated.

Example: api.example.com

stage

string · enum · required

The stage exposed by the hostname.

Enum values:

api

dev-portal

Example: api

object · required

The DNS record required to verify domain ownership, if any.

Example: {"name":"_zuplo.api.example.com","type":"TXT","value":"zuplo-verification-token"}

cname

string | null · required

The CNAME target for the custom domain, if any.

Example: todo-list-api-main-59eec11.zuplo.app