Skip to content
Docs
Select language:English

/api/v1/imports/{id}/archive

PUT
/api/v1/imports/{id}/archive
curl --request PUT \
  --url https://example.com/api/v1/imports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/archive

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
locationId
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
source
required
string
Allowed values: homebox_zip kept_zip
sourceVersion
required
string | null
status
required
string
Allowed values: draft checked running done failed cancelled
bytes
required
integer
>= -9007199254740991 <= 9007199254740991
sha256
required
string
archiveReadyAt
required
string | null
inspect
required
Any of:
object
key
additional properties
choices
required
Any of:
object
archived
required
string
Allowed values: skip tag
currency
required
string
/^[A-Z]{3}$/
quantityRounding
required
string
Allowed values: keep_note
fields
required
object
key
additional properties
string
Allowed values: add_to_type notes
types
required
object
key
additional properties
Any of:
object
typeId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
insured
required
string
Allowed values: field skip
seeded
required
string
Allowed values: skip_unused all
secrets
required
Any of:
object
present
required
boolean
unlocked
required
boolean
progress
required
integer
>= -9007199254740991 <= 9007199254740991
total
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
createdAt
required
string
startedAt
required
string | null
finishedAt
required
string | null
error
required
string | null
reason
string
Allowed values: too_many_entries too_large ratio symlink bad_name duplicate_name truncated unsupported_version encrypted entry_too_large
updatedAt
required
string
report
object
key
additional properties
rowVersion
required
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "source": "homebox_zip",
  "status": "draft",
  "choices": {
    "archived": "skip",
    "quantityRounding": "keep_note",
    "fields": {
      "additionalProperty": "add_to_type"
    },
    "insured": "field",
    "seeded": "skip_unused"
  },
  "reason": "too_many_entries"
}