Domains

Download schema

Assign a custom domain to function.

List all domain name bindings

GET

https://api.scaleway.com

/functions/v1beta1/regions/{region}/domains

List all domain name bindings in a specified region.

List all domain name bindings › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

List all domain name bindings › query Parameters

function_id

string · required

UUID of the function the domain is associated with.

page

integer · int32

Page number.

page_size

integer · uint32

Number of domains per page.

order_by

scaleway.functions.v1beta1.ListDomainsRequest.OrderBy · enum

Order of the domains.

Enum values:

created_at_asc

created_at_desc

hostname_asc

hostname_desc

Default: created_at_asc

List all domain name bindings › Responses

200

scaleway.functions.v1beta1.ListDomainsResponse

scaleway.functions.v1beta1.Domain[]

Array of domains.

total_count

integer · uint32

Total number of domains.

Create a domain name binding

POST

https://api.scaleway.com

/functions/v1beta1/regions/{region}/domains

Create a domain name binding for the function with the specified ID.

Create a domain name binding › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

Create a domain name binding › Request Body

hostname

string

Hostname to create.

function_id

string

UUID of the function to associate the domain with.

Create a domain name binding › Responses

200

scaleway.functions.v1beta1.Domain

id

string

UUID of the domain.

srn

string · pattern: ^srn://functions\.[^…

SRN of the domain.

hostname

string

Hostname associated with the function.

function_id

string

UUID of the function the domain is associated with.

url

string

URL of the function.

status

scaleway.functions.v1beta1.Domain.Status · enum

State of the domain.

Enum values:

unknown

ready

deleting

error

creating

pending

Default: unknown

error_message

string | null

Error message if the domain is in "error" state.

region

string

Region in which the domain is located.

Get a domain name binding

GET

https://api.scaleway.com

/functions/v1beta1/regions/{region}/domains/{domain_id}

Get a domain name binding for the function with the specified ID.

Get a domain name binding › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

domain_id

string · required

UUID of the domain to get.

Get a domain name binding › Responses

200

scaleway.functions.v1beta1.Domain

id

string

UUID of the domain.

srn

string · pattern: ^srn://functions\.[^…

SRN of the domain.

hostname

string

Hostname associated with the function.

function_id

string

UUID of the function the domain is associated with.

url

string

URL of the function.

status

scaleway.functions.v1beta1.Domain.Status · enum

State of the domain.

Enum values:

unknown

ready

deleting

error

creating

pending

Default: unknown

error_message

string | null

Error message if the domain is in "error" state.

region

string

Region in which the domain is located.

Delete a domain name binding

DELETE

https://api.scaleway.com

/functions/v1beta1/regions/{region}/domains/{domain_id}

Delete a domain name binding for the function with the specified ID.

Delete a domain name binding › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

domain_id

string · required

UUID of the domain to delete.

Delete a domain name binding › Responses

200

scaleway.functions.v1beta1.Domain

id

string

UUID of the domain.

srn

string · pattern: ^srn://functions\.[^…

SRN of the domain.

hostname

string

Hostname associated with the function.

function_id

string

UUID of the function the domain is associated with.

url

string

URL of the function.

status

scaleway.functions.v1beta1.Domain.Status · enum

State of the domain.

Enum values:

unknown

ready

deleting

error

creating

pending

Default: unknown

error_message

string | null

Error message if the domain is in "error" state.

region

string

Region in which the domain is located.

Crons Tokens