Check a file from another app

POST

/api/households/current/import/files

curl --request POST \
  --url http://localhost:3000/api/households/current/import/files \
  --header 'Content-Type: application/zip' \
  --cookie merran.session_token=<merran.session_token> \
  --data binary

• Your Merran

Household admins only. The body is the file: a Mealie backup, or recipes exported from Mealie. It’s kept, and what’s in it is said, so its import can be started at /households/current/import/files/{fileId}/start. A file not started is cleared away after a week.

Authorizations

• session

Request Body^required

string format: binary

string format: binary

Responses

200

What’s in it.

Media typeapplication/json

object

id

required

Start its import at /households/current/import/files/{fileId}/start.

string

app

required

string

Allowed values: mealie paprika

what

required

A whole backup, or recipes exported from the app.

string

Allowed values: backup recipes

recipes

required

integer

alreadyHere

required

Of those, how many an earlier import brought in. They’re skipped.

integer

groups

required

A Mealie backup’s groups, when there’s more than one to choose from.

Array<object>

object

id

required

string

name

required

string

recipes

required

integer

Example

{
  "id": "0199e8b0-5a10-7a01-8b00-000000000018",
  "app": "mealie",
  "what": "backup",
  "recipes": 312,
  "alreadyHere": 0,
  "groups": [
    {
      "id": "0199e8b0-5a10-7a01-8b00-000000000019",
      "name": "Home",
      "recipes": 298
    },
    {
      "id": "0199e8b0-5a10-7a01-8b00-00000000001a",
      "name": "Grandma",
      "recipes": 14
    }
  ]
}

400

Merran can’t read that file.

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

fields

object

key

additional properties

string

Example

{
  "error": {
    "code": "not_found",
    "message": "There's nothing here.",
    "fields": {
      "name": "Give it a name."
    }
  }
}

401

Not signed in.

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

fields

object

key

additional properties

string

Example

{
  "error": {
    "code": "not_found",
    "message": "There's nothing here.",
    "fields": {
      "name": "Give it a name."
    }
  }
}

403

Not allowed.

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

fields

object

key

additional properties

string

Example

{
  "error": {
    "code": "not_found",
    "message": "There's nothing here.",
    "fields": {
      "name": "Give it a name."
    }
  }
}

413

The file is too big.

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

fields

object

key

additional properties

string

Example

{
  "error": {
    "code": "not_found",
    "message": "There's nothing here.",
    "fields": {
      "name": "Give it a name."
    }
  }
}