Developer
News and Updates
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Last updated Sep 7, 2026

Binary Specification

This is an early access feature. It is stabilising, and is not suitable for use in production at this time.

Overview

Binary data (such as attachments and other uploaded files) is packaged by Atlassian and made available to your cloud app during a Simplified App Migration. Unlike tabular exports (AO tables and mappings), binary files are transferred as their original file content rather than as JSONL records.

Onboarding

Please reach out to Atlassian to test the early access feature.

After reaching out to Atlassian, to receive binary data, declare the binary key under the migration:managedExports module in your cloud app's manifest.yml:

1
2
3
4
5
modules:
  migration:managedExports:
    - key: binary
      directoryPrefix: [ "assets", "uploads/app" ]

The directoryPrefix property lists the directory prefixes containing binary data that Atlassian should package for export. Only files under the listed prefixes are included, relative to the app's home directory. For example, assets and uploads/app would include /jira/home/assets/upload.jpeg and /jira/home/uploads/app/my_doc.pdf.

Example

Metadata Header (First Row)

Example metadata line (formatted for readability)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "exportTime":"2026-08-18T00:16:51.915527507Z",
  "rowCount":0,
  "type":"objects",
  "columns":[
    {"name":"fileId","type":"String","size":-1,"nullable":true},
    {"name":"filepath","type":"String","size":-1,"nullable":false},
    {"name":"objectType","type":"String","size":-1,"nullable":false},
    {"name":"DELETED","type":"boolean","size":1,"nullable":false},
    {"name":"TXN_SEQUENCE","type":"integer","size":19,"nullable":false}
  ],
  "primaryKeys":["filepath"]
}

Data Record Lines

The data records lines contain the data from the file system.

Example data record line (formatted for readability)

1
2
3
4
5
6
7
8
{
  "fileId": "binary_file/a5719733-df98-491d-ae34-8dc3da59530c",
  "filepath": "assets/upload.jpeg",
  "objectType": "FILE",
  "DELETED": false, 
  "TXN_SEQUENCE": 1
}

Rate this page: