Export a version as ZIP
POST/v1/versions/{versionId}/export
Queues a ZIP of every file in the version, up to 8 GB in total. Get the export until its status is ready for the download URL. A renderable version's text fitting is baked into the exported data.json and text_fitting.json is left out, so the ZIP renders like the version but no longer carries the fitting rules. A request while an export of the same version is queued, building, or ready with more than an hour left before it expires returns that export. Exports are kept for 24 hours. At most 10 exports per workspace wait or build at once (409 export_limit). The ZIP can be imported again into a new project with zipUploadId, or into an existing one.
Request
curl -s -X POST $BLITFRAME/versions/772c657e-ac9c-4550-8ecf-9f77201cbb95/export \
-H "Authorization: Bearer $BLITFRAME_API_KEY"
import os, requests
response = requests.post(
f"{os.environ['BLITFRAME']}/versions/772c657e-ac9c-4550-8ecf-9f77201cbb95/export",
headers={"Authorization": f"Bearer {os.environ['BLITFRAME_API_KEY']}"},
)
print(response.json())
const response = await fetch(`${process.env.BLITFRAME}/versions/772c657e-ac9c-4550-8ecf-9f77201cbb95/export`, {
method: "POST",
headers: { Authorization: `Bearer ${process.env.BLITFRAME_API_KEY}` },
});
console.log(await response.json());
<?php
$request = curl_init(getenv("BLITFRAME") . "/versions/772c657e-ac9c-4550-8ecf-9f77201cbb95/export");
curl_setopt_array($request, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("BLITFRAME_API_KEY"),
],
]);
$response = curl_exec($request);
echo $response;
require "net/http"
uri = URI(ENV["BLITFRAME"] + '/versions/772c657e-ac9c-4550-8ecf-9f77201cbb95/export')
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer " + ENV["BLITFRAME_API_KEY"]
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(request) }
puts response.body
package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
request, err := http.NewRequest("POST", os.Getenv("BLITFRAME")+"/versions/772c657e-ac9c-4550-8ecf-9f77201cbb95/export", nil)
if err != nil {
panic(err)
}
request.Header.Set("Authorization", "Bearer "+os.Getenv("BLITFRAME_API_KEY"))
response, err := http.DefaultClient.Do(request)
if err != nil {
panic(err)
}
defer response.Body.Close()
text, _ := io.ReadAll(response.Body)
fmt.Println(string(text))
}
using System.Net.Http.Headers;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post,
Environment.GetEnvironmentVariable("BLITFRAME") + "/versions/772c657e-ac9c-4550-8ecf-9f77201cbb95/export");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("BLITFRAME_API_KEY"));
using var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
var request = HttpRequest.newBuilder(URI.create(System.getenv("BLITFRAME") + "/versions/772c657e-ac9c-4550-8ecf-9f77201cbb95/export"))
.header("Authorization", "Bearer " + System.getenv("BLITFRAME_API_KEY"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
Path parameters
versionIdstring (uuid)required
Headers
AuthorizationBearer Blitframe API keyrequiredAPI key from the developer console.
Responses
- 202 Accepted
application/json · VersionExportDto
idstring (uuid)versionIdstring (uuid)statusVersionExportStatusOne of
queuedbuildingreadyfailedfileNamestringurlstring or nullsizeBytesinteger (int64) or nullerrorApiError or nullApiError fields
codestringmessagestring
createdAtstring (date-time)finishedAtstring (date-time) or nullexpiresAtstring (date-time)
Errors
- 400 Bad Request
- 401 Unauthorized
- 404 Not Found
- 409 Conflict
- 429 Too Many Requests
application/json · ErrorResponse
errorApiErrorApiError fields
codestringmessagestring
Errors lists the error codes and says when to retry.