builds

Build abrufen

Status eines Builds. error erläutert einen Fehler, und getSiteBuildLog zeigt die Ausgabe des Compilers. wait (bis zu 50 Sekunden) antwortet, sobald der Build abgeschlossen ist, statt wiederholt den Status abzufragen. preview=true fügt einem fertigen Build preview_url hinzu, einen privaten Link, den du im Browser öffnen und zum Prüfen der Seiten verwenden kannst.

GET/v1/sites/{site_id}/builds/{build_id}

Request

curl --request GET \
  --url 'https://api.atelier201.com/v1/sites/<site_id>/builds/<build_id>' \
  --header 'Authorization: <api-key>'

import json
import requests

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

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

const response = await fetch("https://api.atelier201.com/v1/sites/<site_id>/builds/<build_id>", {
  method: "GET",
  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>/builds/<build_id>");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "GET");
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("GET", "https://api.atelier201.com/v1/sites/<site_id>/builds/<build_id>", 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>/builds/<build_id>"))
    .header("Authorization", "<api-key>")
    .method("GET", 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>/builds/<build_id>")
request = Net::HTTP::Get.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": {
    "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>",
    "preview_url": "<string>"
  },
  "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>"
}

Erfordert sites:read.

ready, failed und cancelled sind endgültige Status. Statt den Status wiederholt abzufragen, übergeben Sie wait (bis zu 50 Sekunden). Die Antwort erfolgt, sobald der Build abgeschlossen ist. preview=true fügt einem fertigen Build preview_url hinzu: einen privaten Link, der einen Tag lang gültig ist und sich in einem Browser öffnen lässt. Dafür ist sites:write erforderlich, da der Link erstellt wird. warnings listet die nicht kritischen Meldungen des Builds auf.

Autorisierung

Authorizationbearerin headerrequired

Pfadparameter

site_idstringrequired

ID der Website oder ihr Slug (die Adresse vor .atelier201.page).

build_idstringrequired

Query-Parameter

waitintegerrange: 0–50

Anzahl der Sekunden, die auf den Abschluss des Builds gewartet wird (fertig, fehlgeschlagen oder abgebrochen), bevor die Antwort erfolgt. 0 oder nicht angegeben: sofort antworten.

previewboolean

Wenn der Build fertig ist, zusätzlich preview_url zurückgeben: einen privaten Link zum Build (einen Tag gültig und während dieser Zeit wiederverwendet), den du im Browser öffnen und zum Prüfen der Seiten verwenden kannst.

Antwort

application/json

Einen Build abrufen

dataobjectrequired

Show child attributes

data.idstringrequired

data.site_idstringrequired

data.revisionstringrequiredlength: 40–40 chars

Eine Git-Commit-ID (40 hexadezimale Zeichen) des Repositorys der Website.

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

data.target_originstringrequired

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

data.file_countinteger | nullrequired

data.total_bytesinteger | nullrequired

data.duration_msinteger | nullrequired

data.errorobject | nullrequired

Show child attributes

data.error.codestringrequired

data.error.messagestringnullrequired

data.warningsstring[]required

data.created_atstringrequired

ISO 8601, UTC.

data.started_atstring | nullrequired

data.finished_atstring | nullrequired

data.preview_urlstring

Bei einem fertigen Build mit preview=true: ein privater Link zum Öffnen im Browser.

request_idstringrequired

{ "data": { "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>", "preview_url": "<string>" }, "request_id": "<string>" }

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

Build abrufen

Autorisierung

Pfadparameter

Query-Parameter

Antwort

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies