Skip to main content
POST
/
knowledge-base
/
resources
/
documents
/
{id}
/
upload
Replace document resource file
curl --request POST \
  --url https://api.vanta.com/v1/knowledge-base/resources/documents/{id}/upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file'
import requests

url = "https://api.vanta.com/v1/knowledge-base/resources/documents/{id}/upload"

files = { "file": ("example-file", open("example-file", "rb")) }
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, files=files, headers=headers)

print(response.text)
const form = new FormData();
form.append('file', '<string>');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.vanta.com/v1/knowledge-base/resources/documents/{id}/upload', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vanta.com/v1/knowledge-base/resources/documents/{id}/upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.vanta.com/v1/knowledge-base/resources/documents/{id}/upload"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.vanta.com/v1/knowledge-base/resources/documents/{id}/upload")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.vanta.com/v1/knowledge-base/resources/documents/{id}/upload")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body
{
  "id": "507f1f77bcf86cd799439021",
  "type": "FILE",
  "title": "SOC 2 Type II Report",
  "description": "Annual SOC 2 Type II report covering 2024.",
  "fileUrl": "https://vanta-uploaded-documents.s3.amazonaws.com/507f1f77bcf86cd799439021?X-Amz-Expires=3600&X-Amz-Signature=...",
  "customerVisibility": "REQUEST_ACCESS",
  "downloadPermission": "VIEW_AND_DOWNLOAD",
  "isUsedInQuestionnaires": true,
  "ownerAssignment": {
    "type": "User",
    "id": "507f1f77bcf86cd799439041",
    "displayName": "Alex Rivera"
  },
  "expirationStatus": "CURRENT",
  "expirationDate": "2025-12-31T00:00:00.000Z",
  "lastUpdated": "2024-12-15T17:42:11.000Z",
  "lastVerified": "2024-12-20T09:00:00.000Z",
  "tags": [
    {
      "categoryId": "507f1f77bcf86cd799439011",
      "tagId": "507f1f77bcf86cd799439013"
    }
  ],
  "categoryId": "507f1f77bcf86cd799439051"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

multipart/form-data
​
file
file
required

New document binary; replaces the existing file in place.

Response

200 - application/json

Ok

​
id
string
required
​
type
enum<string>
required
Available options:
FILE
​
title
string
required
​
description
string | null
required
​
fileUrl
string
required

Presigned S3 URL for the underlying document. Expires after 1 hour due to AWS IAM Role limitations on presigned URL lifetimes. Re-fetch the resource to obtain a fresh URL once this one expires.

​
customerVisibility
enum<string> | null
required
Available options:
PRIVATE,
SHAREABLE,
REQUEST_ACCESS,
PUBLIC,
null
​
downloadPermission
enum<string> | null
required
Available options:
VIEW_ONLY,
VIEW_AND_DOWNLOAD,
null
​
isUsedInQuestionnaires
boolean | null
required
​
ownerAssignment
object | null
required
​
expirationStatus
enum<string>
required

Customer-facing expiration status used by knowledge-base API responses (answer library entries and resources). Derived from the persisted expiresAt field at read time.

Available options:
CURRENT,
EXPIRED
​
expirationDate
string | null
required
​
lastUpdated
string
required
​
lastVerified
string | null
required
​
tags
object[]
required
​
categoryId
string | null
required

Trust Center category id the resource is currently filed under, or null if uncategorized (or not on the Trust Center, which is the case for PRIVATE / SHAREABLE resources).