Start a ZIP export of every card and original file

One export can run at a time, and one can be started every 7 days. Poll GET /v1/exports/latest for progress and the download URL.

POST/v1/exports

Authorization

AuthorizationBearer token (OAuth access token or teakapi_ API key) · headerrequired

Bearer token. Accepts either an OAuth 2.0 access token (obtained via browser sign-in; expires after 1 hour and is refreshable) or a teakapi_ API key.

Responses

202

Export started

jobExportJobrequired

Show properties

idstringrequired

statusstringrequired

Allowed:pendingrunningreadyfailedcanceledexpired

stagestring | null

Allowed:snapshottingarchivingnull

processedCountnumber | null

cardCountnumber | null

filesIncludednumber | null

filesOmittednumber | null

sizeBytesnumber | null

failureClassstring | null

createdAtnumberrequired

updatedAtnumberrequired

completedAtnumber | null

expiresAtnumber | null

downloadUrlstring | nullrequired

Short-lived signed URL for the ZIP, present while the export is ready and not expired.

409

An export is already running; body includes job

429

An export already ran in the last 7 days; retryAt and Retry-After say when the next can start

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (OAuth access token or teakapi_ API key)Remember on this deviceInclude my values in samples

Request

curl -X POST 'https://teakvault.com/api/v1/exports' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://teakvault.com/api/v1/exports", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

const response: Response = await fetch("https://teakvault.com/api/v1/exports", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.post(
    "https://teakvault.com/api/v1/exports",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

package main

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

func main() {
	req, err := http.NewRequest("POST", "https://teakvault.com/api/v1/exports", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")
	req.Header.Set("Accept", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

require "net/http"

uri = URI("https://teakvault.com/api/v1/exports")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer YOUR_TOKEN"
request["Accept"] = "application/json"

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://teakvault.com/api/v1/exports',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json',
  ],
]);

$response = curl_exec($curl);

Response

{
  "job": {
    "id": "string",
    "status": "pending",
    "stage": "snapshotting",
    "processedCount": 0,
    "cardCount": 0,
    "filesIncluded": 0,
    "filesOmitted": 0,
    "sizeBytes": 0,
    "failureClass": "string",
    "createdAt": 0,
    "updatedAt": 0,
    "completedAt": 0,
    "expiresAt": 0,
    "downloadUrl": "string"
  }
}