Skip to content
Press.js Press.js Press.js Docs

Commit an upload session

POST
/v1/upload-sessions/{uploadSessionId}/commit
 
curl --request POST \
  --url https://api.presscloud.example/v1/upload-sessions/example/commit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Upload-Token: example' \
  --data '{ "entries": [ { "path": "example", "blobHash": "example", "size": 1, "mime": "example" } ], "render": { "route": "example", "title": "example", "renderTimeoutMs": 1, "metadata": {} } }'

Finalizes an upload session into an immutable deploy version and its derived render package.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
uploadSessionId
required
string
>= 1 characters

Header Parameters

Section titled “Header Parameters ”
X-Upload-Token
required
string
>= 1 characters

Opaque session token returned when the upload session is created.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
entries
required
Array<object>
>= 1 items
object
path
required
string
>= 1 characters
blobHash
required
string
>= 1 characters
size
required
integer
mime
string
render
required
object
route
required
string
>= 1 characters
title
required
string
>= 1 characters
renderTimeoutMs
integer
metadata
object
key
additional properties
any
Example generated
{
  "entries": [
    {
      "path": "example",
      "blobHash": "example",
      "size": 1,
      "mime": "example"
    }
  ],
  "render": {
    "route": "example",
    "title": "example",
    "renderTimeoutMs": 1,
    "metadata": {}
  }
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Upload session committed.

Media type application/json
object
deployVersion
required
object
id
required
string
displayId
required
string
>= 1 characters
deployId
required
string
versionNo
required
integer
>= 1
treeHash
required
string
renderIndexKey
required
string
renderPackKey
required
string
route
required
string
>= 1 characters
title
required
string
>= 1 characters
renderTimeoutMs
integer
metadataJson
string
status
required
string
createdAt
required
integer
Example generated
{
  "deployVersion": {
    "id": "example",
    "displayId": "example",
    "deployId": "example",
    "versionNo": 1,
    "treeHash": "example",
    "renderIndexKey": "example",
    "renderPackKey": "example",
    "route": "example",
    "title": "example",
    "renderTimeoutMs": 1,
    "metadataJson": "example",
    "status": "example",
    "createdAt": 1
  }
}

400

Section titled “400 ”

Invalid request payload or parameters.

Media type application/json
object
error
required
string
message
required
string
Example generated
{
  "error": "example",
  "message": "example"
}

401

Section titled “401 ”

Authentication material for the operation is missing.

Media type application/json
object
error
required
string
message
required
string
Example generated
{
  "error": "example",
  "message": "example"
}

403

Section titled “403 ”

The caller is not permitted to perform the operation.

Media type application/json
object
error
required
string
message
required
string
Example generated
{
  "error": "example",
  "message": "example"
}

404

Section titled “404 ”

Requested resource was not found.

Media type application/json
object
error
required
string
message
required
string
Example generated
{
  "error": "example",
  "message": "example"
}

409

Section titled “409 ”

Requested operation conflicts with the current resource state.

Media type application/json
object
error
required
string
message
required
string
Example generated
{
  "error": "example",
  "message": "example"
}

410

Section titled “410 ”

The requested resource is no longer available.

Media type application/json
object
error
required
string
message
required
string
Example generated
{
  "error": "example",
  "message": "example"
}

501

Section titled “501 ”

Route is defined but not implemented yet.

Media type application/json
object
error
required
string
message
required
string
Example generated
{
  "error": "example",
  "message": "example"
}