You can use the Vault APIs to add content to the archive, find and retrieve packages, and manage them from your own systems. Every API uses the same base URL and the same sign-in.
Get started
-
Ask Docbyte for your base URL, your token endpoint, and a client with the roles that your integration needs.
-
Get an access token from the token endpoint, as Authentication shows.
-
Call an endpoint with the token in the
Authorizationheader:
curl "$BASE_URL/v2/archive/tenants" \
-H "Authorization: Bearer $ACCESS_TOKEN"
The response lists the tenants that your client can work in.
Tip: To handle failed calls in one place, read Errors before you write your first integration. Every /v2 error has the same shape.
Getting started with the API
-
General information: versions, the base URL, rate limits, paging, and dates.
-
Authentication: get a token, and see what each role lets your client do.
-
Common headers: the headers that every request can send, such as
tenantandenrichers. -
Errors: the error body, and what each
reasonmeans. -
What's new in the 26.3 API: what changed for integrators in this release.
Content APIs
|
API |
What you use it for |
|---|---|
|
Add packages to the archive, update their metadata, and follow each ingest |
|
|
Search for packages, browse the file plan, and download files |
|
|
Work with one package: trash and restore it, set its permissions, export a DIP, or check its integrity |
|
|
Group packages into package sets, and share them |
Preservation APIs
|
API |
What you use it for |
|---|---|
|
Run preservation actions on packages, schedule them, and read their reports |
|
|
Set up file format transformations |
Records management APIs
|
API |
What you use it for |
|---|---|
|
Manage retention rules, legal holds, and deletion lists |
|
|
Read and export the audit trail of the archive or of one package |
Administration and monitoring APIs
|
API |
What you use it for |
|---|---|
|
Manage users, and list roles and archiving profiles |
|
|
Set up reports, run them, and get the results |
|
|
Set up the notifications that the archive sends when an event happens |
|
|
Get content, storage, and submission statistics for the archive |
Integration APIs
|
API |
What you use it for |
|---|---|
|
Archive signed documents from DocuSign and Adobe Acrobat Sign |
|
|
Preserve and retrieve objects with the ETSI TS 119 512 protocol |