domains

Choose the main address

Visitors of the other addresses are redirected here. Starts a rebuild so canonical links and the sitemap use it; publish that build to finish.

POST/v1/sites/{site_id}/domains/{domain_id}/canonical

Request

curl --request POST \
  --url 'https://api.atelier201.com/v1/sites/<site_id>/domains/<domain_id>/canonical' \
  --header 'Authorization: <api-key>'

import json
import requests

url = "https://api.atelier201.com/v1/sites/<site_id>/domains/<domain_id>/canonical"
headers = {
  "Authorization": "<api-key>"
}

response = requests.request("POST", url, headers=headers)
print(response.json())

const response = await fetch("https://api.atelier201.com/v1/sites/<site_id>/domains/<domain_id>/canonical", {
  method: "POST",
  headers: {
    "Authorization": "<api-key>"
  },
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.atelier201.com/v1/sites/<site_id>/domains/<domain_id>/canonical");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
]);
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://api.atelier201.com/v1/sites/<site_id>/domains/<domain_id>/canonical", nil)
  req.Header.Set("Authorization", "<api-key>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://api.atelier201.com/v1/sites/<site_id>/domains/<domain_id>/canonical"))
    .header("Authorization", "<api-key>")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://api.atelier201.com/v1/sites/<site_id>/domains/<domain_id>/canonical")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "<api-key>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "hostname": "<string>",
    "rebuild": {
      "id": "<string>",
      "site_id": "<string>",
      "revision": "<string>",
      "state": "queued",
      "target_origin": "<string>",
      "profile": "standard",
      "file_count": 123,
      "total_bytes": 123,
      "duration_ms": 123,
      "error": {
        "code": "<string>",
        "message": null
      },
      "warnings": [
        "<string>"
      ],
      "created_at": "<string>",
      "started_at": "<string>",
      "finished_at": "<string>"
    },
    "next_action": null
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

Requires domains:write and a workspace admin.

Canonical links and the sitemap are written at build time, so this starts a rebuild. Publish that build to finish. The response says so in next_action.

Authorizations

Authorizationbearerin headerrequired

Path parameters

site_idstringrequired

The site's id, or its slug (the address before .atelier201.page).

domain_idstringrequired

Response

application/json

Choose the main address

dataobjectrequired

Show child attributes

data.hostnamestringrequired

data.rebuildobject | nullrequired

Show child attributes

data.rebuild.idstringrequired

data.rebuild.site_idstringrequired

data.rebuild.revisionstringrequiredlength: 40–40 chars

A Git commit id (40 hex characters) of the site's repository.

data.rebuild.stateenum<string>requiredone of: queued, building, collecting, ready, failed, cancelled

data.rebuild.target_originstringrequired

data.rebuild.profileenum<string>requiredone of: standard, guest-demo

data.rebuild.file_countinteger | nullrequired

data.rebuild.total_bytesinteger | nullrequired

data.rebuild.duration_msinteger | nullrequired

data.rebuild.errorobject | nullrequired

Show child attributes

data.rebuild.error.codestringrequired

data.rebuild.error.messagestringnullrequired

data.rebuild.warningsstring[]required

data.rebuild.created_atstringrequired

ISO 8601, UTC.

data.rebuild.started_atstring | nullrequired

data.rebuild.finished_atstring | nullrequired

data.next_actionstringnullrequired

request_idstringrequired

{ "data": { "hostname": "<string>", "rebuild": { "id": "<string>", "site_id": "<string>", "revision": "<string>", "state": "queued", "target_origin": "<string>", "profile": "standard", "file_count": 123, "total_bytes": 123, "duration_ms": 123, "error": { "code": "<string>", "message": null }, "warnings": [ "<string>" ], "created_at": "<string>", "started_at": "<string>", "finished_at": "<string>" }, "next_action": null }, "request_id": "<string>" }

{ "error": { "type": "<string>", "code": "<string>", "message": "<string>", "param": "<string>", "docs_url": "<string>", "action_url": "<string>", "details": {} }, "request_id": "<string>" }

Choose the main address

Authorizations

Path parameters

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies