How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Scaleway Domains API

A container is provided with an automatically generated domain through which it is accessible. Alternatively, custom domains can be assigned to containers in order to facilitate their use.

Scaleway Domains API is one of 74 APIs that Scaleway publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Domains. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 16 operations across 9 paths, and defines 9 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://api.scaleway.com.

16 operations 9 paths 9 schemas 2 DELETE7 GET2 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Server
https://api.scaleway.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Scaleway Domains API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Auth-Token (scaleway).

Paths & Operations 16

Across 9 paths, the API surfaces 16 operations — 2 DELETE, 7 GET, 2 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Domains 16

A container is provided with an automatically generated domain through which it is accessible. Alternatively, custom domains can be assigned to containers in order to facilitate t…

GET
/containers/v1/regions/{region}/domains
List all custom domains the caller can access (read permission).
ListDomains 8 params → 200
POST
/containers/v1/regions/{region}/domains
Create a new custom domain for the container with the specified ID.
CreateDomain 1 param body → 200
GET
/containers/v1/regions/{region}/domains/{domain_id}
Get the custom domain associated with the specified ID.
GetDomain 2 params → 200
PATCH
/containers/v1/regions/{region}/domains/{domain_id}
Update the domain associated with the specified ID.
UpdateDomain 2 params body → 200
DELETE
/containers/v1/regions/{region}/domains/{domain_id}
Delete the custom domain associated with the specified ID.
DeleteDomain 2 params → 200
GET
/functions/v1beta1/regions/{region}/domains
List all domain name bindings
ListDomains 5 params → 200
POST
/functions/v1beta1/regions/{region}/domains
Create a domain name binding
CreateDomain 1 param body → 200
GET
/functions/v1beta1/regions/{region}/domains/{domain_id}
Get a domain name binding
GetDomain 2 params → 200
DELETE
/functions/v1beta1/regions/{region}/domains/{domain_id}
Delete a domain name binding
DeleteDomain 2 params → 200
GET
/transactional-email/v1alpha1/regions/{region}/domains
List domains
ListDomains 7 params → 200
POST
/transactional-email/v1alpha1/regions/{region}/domains
Register a domain in a project
CreateDomain 1 param body → 200
GET
/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}
Get information about a domain
GetDomain 2 params → 200
PATCH
/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}
Update a domain
UpdateDomain 2 params body → 200
POST
/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}/check
Domain DNS check
CheckDomain 2 params body → 200
POST
/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}/revoke
Delete a domain
RevokeDomain 2 params body → 200
GET
/transactional-email/v1alpha1/regions/{region}/domains/{domain_id}/verification
Display SPF, DKIM, DMARC and MX records status and potential errors
GetDomainLastStatus 2 params → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are scaleway.transactional_email.v1alpha1.Domain (17 properties), scaleway.containers.v1.Domain (8 properties), scaleway.transactional_email.v1alpha1.DomainLastStatus (7 properties), scaleway.functions.v1beta1.Domain (6 properties). Each schema is shown below with its type and property counts.

scaleway.transactional_email.v1alpha1.Domain
object
17 properties
scaleway.containers.v1.ListDomainsResponse
object
2 properties
scaleway.functions.v1beta1.ListDomainsResponse
object
2 properties
scaleway.transactional_email.v1alpha1.ListDomainsResponse
object
2 properties
scaleway.functions.v1beta1.Domain
object
6 properties
scaleway.transactional_email.v1alpha1.DomainLastStatus
object
7 properties
scaleway.containers.v1.ListDomainsRequest.OrderBy
string
scaleway.containers.v1.Domain
object
8 properties
scaleway.transactional_email.v1alpha1.Domain.Status
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

scaleway-domains-api-openapi.yml Raw ↑

Other APIs Scaleway publishes across the network.

Scaleway Generative APIs
Scaleway Access Control List API
Scaleway ACLs API
Scaleway Alert Subscribers API
Scaleway API Keys API
Scaleway Applications API
Scaleway Backends API
Scaleway Backups API
Scaleway Blocklist API
Scaleway Certificate API
Scaleway Cluster types API
Scaleway Clusters API
Where this information came from

This is an independent, third-party profile of Scaleway Domains API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.