DNS stages

Download schema

A DNS stage is part of a pipeline. It allows you to customize your Edge Services endpoint with a domain you own. This is useful if you do not want to use the default domain endpoint provided by Scaleway. Edge Services will then serve content from your customized domain. A TLS stage is also necessary to provide an SSL/TLS certificate so that Edge Services can serve traffic for your customized domain over HTTPS.

Get DNS stage

GET

https://api.scaleway.com

/edge-services/v1beta1/dns-stages/{dns_stage_id}

Retrieve information about an existing DNS stage, specified by its dns_stage_id. Its full details, including FQDNs, are returned in the response object.

Get DNS stage › path Parameters

dns_stage_id

string · required

ID of the requested DNS stage.

Get DNS stage › Responses

200

scaleway.edge_services.v1beta1.DNSStage

id

string

ID of the DNS stage.

default_fqdn

string

Default Fully Qualified Domain Name provided for the Pipeline.

fqdns

string[]

Custom Fully Qualified Domain Names configured (only the first one is valid).

type

scaleway.edge_services.v1beta1.DNSStage.Type · enum

Type of the stage.

Enum values:

unknown_type

auto

managed

custom

Default: unknown_type

pipeline_id

string

Pipeline ID the DNS stage belongs to.

status

scaleway.edge_services.v1beta1.StageStatus · enum

Current status of the stage.

Enum values:

unknown_status

inactive

active

Default: unknown_status

created_at

string | null · date-time

Date the DNS stage was created. (RFC 3339 format)

updated_at

string | null · date-time

Date the DNS stage was last updated. (RFC 3339 format)

tls_stage_id

string | null

TLS stage ID the DNS stage is linked to. (UUID format)

cache_stage_id

string | null

Cache stage ID the DNS stage is linked to. (UUID format)

backend_stage_id

string | null

Backend stage ID the DNS stage is linked to. (UUID format)

wildcard_domain

boolean

Support of wildcard (subdomains) for the given domain (a wildcard certificate is required to make it work).

Update DNS stage

PATCH

https://api.scaleway.com

/edge-services/v1beta1/dns-stages/{dns_stage_id}

Update the parameters of an existing DNS stage, specified by its dns_stage_id.

Update DNS stage › path Parameters

dns_stage_id

string · required

ID of the DNS stage to update.

Update DNS stage › Request Body

fqdns

array | null

Custom Fully Qualified Domain Name to be configured (only 1 FQDN can be setup for now).

tls_stage_id

string | null

TLS stage ID the DNS stage will be linked to. (UUID format)

cache_stage_id

string | null

Cache stage ID the DNS stage will be linked to. (UUID format)

backend_stage_id

string | null

Backend stage ID the DNS stage will be linked to. (UUID format)

wildcard_domain

boolean | null

Support of wildcard (subdomains) for the given domain (a wildcard certificate is required to make it work).

Update DNS stage › Responses

200

scaleway.edge_services.v1beta1.DNSStage

id

string

ID of the DNS stage.

default_fqdn

string

Default Fully Qualified Domain Name provided for the Pipeline.

fqdns

string[]

Custom Fully Qualified Domain Names configured (only the first one is valid).

type

scaleway.edge_services.v1beta1.DNSStage.Type · enum

Type of the stage.

Enum values:

unknown_type

auto

managed

custom

Default: unknown_type

pipeline_id

string

Pipeline ID the DNS stage belongs to.

status

scaleway.edge_services.v1beta1.StageStatus · enum

Current status of the stage.

Enum values:

unknown_status

inactive

active

Default: unknown_status

created_at

string | null · date-time

Date the DNS stage was created. (RFC 3339 format)

updated_at

string | null · date-time

Date the DNS stage was last updated. (RFC 3339 format)

tls_stage_id

string | null

TLS stage ID the DNS stage is linked to. (UUID format)

cache_stage_id

string | null

Cache stage ID the DNS stage is linked to. (UUID format)

backend_stage_id

string | null

Backend stage ID the DNS stage is linked to. (UUID format)

wildcard_domain

boolean

Support of wildcard (subdomains) for the given domain (a wildcard certificate is required to make it work).

PATCH/edge-services/v1beta1/dns-stages/{dns_stage_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/edge-services/v1beta1/dns-stages/{dns_stage_id}"

Example Request Body

{
  "fqdns": [],
  "tls_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
  "cache_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
  "backend_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
  "wildcard_domain": true
}

json

Example Responses

{
  "id": "id",
  "default_fqdn": "default_fqdn",
  "fqdns": [
    "string"
  ],
  "type": "unknown_type",
  "pipeline_id": "pipeline_id",
  "status": "unknown_status",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "tls_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
  "cache_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
  "backend_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
  "wildcard_domain": true
}

json

application/json

Delete DNS stage

DELETE

https://api.scaleway.com

/edge-services/v1beta1/dns-stages/{dns_stage_id}

Delete an existing DNS stage, specified by its dns_stage_id. Deleting a DNS stage is permanent, and cannot be undone.

Delete DNS stage › path Parameters

dns_stage_id

string · required

ID of the DNS stage to delete.

Delete DNS stage › Responses

No data returned

List DNS stages

GET

https://api.scaleway.com

/edge-services/v1beta1/pipelines/{pipeline_id}/dns-stages

List all DNS stages, for a Scaleway Organization or Scaleway Project. By default, the DNS stages returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

List DNS stages › path Parameters

pipeline_id

string · required

Pipeline ID to filter for. Only DNS stages from this pipeline will be returned.

List DNS stages › query Parameters

order_by

scaleway.edge_services.v1beta1.ListDNSStagesRequest.OrderBy · enum

Sort order of DNS stages in the response.

Enum values:

created_at_asc

created_at_desc

Default: created_at_asc

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Number of DNS stages to return per page.

fqdn

string

Fully Qualified Domain Name to filter for (in the format subdomain.example.com). Only DNS stages with this FQDN will be returned.

List DNS stages › Responses

200

scaleway.edge_services.v1beta1.ListDNSStagesResponse

scaleway.edge_services.v1beta1.DNSStage[]

Paginated list of DNS stages.

total_count

integer · uint64

Count of all DNS stages matching the requested criteria.

GET/edge-services/v1beta1/pipelines/{pipeline_id}/dns-stages

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/edge-services/v1beta1/pipelines/{pipeline_id}/dns-stages"

Example Responses

{
  "stages": [
    {
      "id": "id",
      "default_fqdn": "default_fqdn",
      "fqdns": [
        "string"
      ],
      "type": "unknown_type",
      "pipeline_id": "pipeline_id",
      "status": "unknown_status",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "tls_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
      "cache_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
      "backend_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
      "wildcard_domain": true
    }
  ],
  "total_count": 0
}

json

application/json

Create DNS stage

POST

https://api.scaleway.com

/edge-services/v1beta1/pipelines/{pipeline_id}/dns-stages

Create a new DNS stage. You must specify the fqdns field to customize the domain endpoint, using a domain you already own.

Create DNS stage › path Parameters

pipeline_id

string · required

Pipeline ID the DNS stage belongs to. (UUID format)

Create DNS stage › Request Body

fqdns

array | null

Custom Fully Qualified Domain Name to be configured (only 1 FQDN can be setup for now).

tls_stage_id

string | null

TLS stage ID the DNS stage will be linked to. (UUID format)

cache_stage_id

string | null

Cache stage ID the DNS stage will be linked to. (UUID format)

backend_stage_id

string | null

Backend stage ID the DNS stage will be linked to. (UUID format)

wildcard_domain

boolean | null

Support of wildcard (subdomains) for the given domain (a wildcard certificate is required to make it work).

Create DNS stage › Responses

200

scaleway.edge_services.v1beta1.DNSStage

id

string

ID of the DNS stage.

default_fqdn

string

Default Fully Qualified Domain Name provided for the Pipeline.

fqdns

string[]

Custom Fully Qualified Domain Names configured (only the first one is valid).

type

scaleway.edge_services.v1beta1.DNSStage.Type · enum

Type of the stage.

Enum values:

unknown_type

auto

managed

custom

Default: unknown_type

pipeline_id

string

Pipeline ID the DNS stage belongs to.

status

scaleway.edge_services.v1beta1.StageStatus · enum

Current status of the stage.

Enum values:

unknown_status

inactive

active

Default: unknown_status

created_at

string | null · date-time

Date the DNS stage was created. (RFC 3339 format)

updated_at

string | null · date-time

Date the DNS stage was last updated. (RFC 3339 format)

tls_stage_id

string | null

TLS stage ID the DNS stage is linked to. (UUID format)

cache_stage_id

string | null

Cache stage ID the DNS stage is linked to. (UUID format)

backend_stage_id

string | null

Backend stage ID the DNS stage is linked to. (UUID format)

wildcard_domain

boolean

Support of wildcard (subdomains) for the given domain (a wildcard certificate is required to make it work).

POST/edge-services/v1beta1/pipelines/{pipeline_id}/dns-stages

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/edge-services/v1beta1/pipelines/{pipeline_id}/dns-stages"

Example Request Body

{
  "fqdns": [],
  "tls_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
  "cache_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
  "backend_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
  "wildcard_domain": true
}

json

Example Responses

{
  "id": "id",
  "default_fqdn": "default_fqdn",
  "fqdns": [
    "string"
  ],
  "type": "unknown_type",
  "pipeline_id": "pipeline_id",
  "status": "unknown_status",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "tls_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
  "cache_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
  "backend_stage_id": "6170692e-7363-616c-6577-61792e636f6d",
  "wildcard_domain": true
}

json

application/json

Pipelines TLS stages