API docs by Redocly

SaveSyncd (1.0.0)

Download OpenAPI specification:

v1

First version of the API

Server Status

Check if the server is online

Responses

All Titles

Get a list of all titles stored on the server, including save and extdata

Responses

Response samples

Content type
application/json
{
  • "1125899907186432": {
    }
}

Begin Upload

Uploads and downloads are kept in a staging folder, this prevents conflicts of data changing during an upload, and also allows multiple uploads. The last closed upload will be kept.

Request Body schema: application/json
required
id
integer <uint64> (TitleID)
container
string (Container)
Enum: "SAVE" "EXTDATA"

The container the files are from, either SAVE or EXTDATA

Array of objects (ClientFileInfo)

Responses

Request samples

Content type
application/json
{
  • "id": 1125899907186432,
  • "container": "SAVE",
  • "files": [
    ]
}

Response samples

Content type
application/json
{
  • "ticket": "c6b59193-94d9-40e3-828a-f28b3b45ccd4",
  • "files": [
    ]
}

Upload File

Uploads a file to the tickets staging path

path Parameters
ticket
required
string <UUID4> (Ticket)
Example: c6b59193-94d9-40e3-828a-f28b3b45ccd4
query Parameters
path
required
string
Example: path=/GameData.bin
Request Body schema: application/octet-stream
required
Schema not provided

Responses

End Upload

Completes the staging upload, updates the servers files

path Parameters
ticket
required
string <UUID4> (Ticket)
Example: c6b59193-94d9-40e3-828a-f28b3b45ccd4

Responses

Cancel Upload

Deletes the staging path, no server files have been changed

path Parameters
ticket
required
string <UUID4> (Ticket)
Example: c6b59193-94d9-40e3-828a-f28b3b45ccd4

Responses

Begin Download

See /v1/upload/begin for details.

Request Body schema: application/json
required
id
integer <uint64> (TitleID)
container
string (Container)
Enum: "SAVE" "EXTDATA"

The container the files are from, either SAVE or EXTDATA

Array of objects (ClientFileInfo)

Responses

Request samples

Content type
application/json
{
  • "id": 1125899907186432,
  • "container": "SAVE",
  • "existingFiles": [
    ]
}

Response samples

Content type
application/json
{
  • "ticket": "c6b59193-94d9-40e3-828a-f28b3b45ccd4",
  • "files": [
    ]
}

Download File

Downloads a file from the tickets staging path

path Parameters
ticket
required
string <UUID4> (Ticket)
Example: c6b59193-94d9-40e3-828a-f28b3b45ccd4
query Parameters
path
required
string
Example: path=/GameData.bin

Responses

End Download

Completes the staging download, deletes the cloned data

path Parameters
ticket
required
string <UUID4> (Ticket)
Example: c6b59193-94d9-40e3-828a-f28b3b45ccd4

Responses