List upload download URLs

http
POST /projects/{project_reference}/uploads/download-urls

Sign download URLs for up to 20 uploads at once and report a status for each upload that is missing or denied. Requires project.uploads.read.

Servers

json
[
  {
    "url": "https://api.veryfront.com"
  }
]

Authentication

json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyAuth": []
  }
]
json
{
  "bearerAuth": {
    "type": "http",
    "scheme": "bearer",
    "bearerFormat": "JWT or API Key",
    "description": "Use a JWT bearer token or a Veryfront API key in the `Authorization` header."
  },
  "apiKeyAuth": {
    "type": "apiKey",
    "in": "header",
    "name": "X-API-Key",
    "description": "Alternative API key header for `vf_<prefix>_<secret>` tokens."
  }
}

Parameters

NameLocationRequiredDescription
project_referencepathYesProject slug, UUID, or domain that identifies the project.

Parameter contracts

json
[
  {
    "schema": {
      "$ref": "#/components/schemas/ProjectReference"
    },
    "required": true,
    "description": "Project slug, UUID, or domain that identifies the project.",
    "name": "project_reference",
    "in": "path"
  }
]

Request body

json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "upload_references": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1
            },
            "minItems": 1,
            "maxItems": 20,
            "description": "Up to 20 upload UUIDs or project-relative file paths, signed in input order. Each upload retains its read-access check."
          },
          "ttl_seconds": {
            "type": "number",
            "minimum": 60,
            "maximum": 86400,
            "description": "Requested lifetime in seconds. Private uploads are capped at 1800 seconds; public uploads at 86400 seconds."
          },
          "ttl": {
            "type": "number",
            "minimum": 60,
            "maximum": 86400,
            "description": "Another spelling of ttl_seconds. Send one of the two."
          }
        },
        "required": [
          "upload_references"
        ]
      }
    }
  }
}

Responses

200

Per-upload signing results.

json
{
  "description": "Per-upload signing results.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "signed_url": {
                      "type": "string",
                      "description": "Temporary cloud-storage download URL."
                    },
                    "expires_at": {
                      "type": "string",
                      "description": "URL expiration timestamp. Private files expire after 30 minutes; public files after 24 hours."
                    },
                    "upload_reference": {
                      "type": "string"
                    },
                    "status": {
                      "type": "number",
                      "enum": [
                        200
                      ],
                      "description": "Signed successfully. Missing and denied uploads instead return individual 404 or 403 statuses."
                    }
                  },
                  "required": [
                    "signed_url",
                    "expires_at",
                    "upload_reference",
                    "status"
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "upload_reference": {
                      "type": "string"
                    },
                    "status": {
                      "type": "number",
                      "enum": [
                        403
                      ]
                    },
                    "error": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "upload_reference",
                    "status",
                    "error"
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "upload_reference": {
                      "type": "string"
                    },
                    "status": {
                      "type": "number",
                      "enum": [
                        404
                      ]
                    },
                    "error": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "upload_reference",
                    "status",
                    "error"
                  ]
                }
              ]
            }
          }
        },
        "required": [
          "data"
        ]
      }
    }
  }
}

400

Invalid batch

json
{
  "description": "Invalid batch",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

401

Unauthorized

json
{
  "description": "Unauthorized",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

403

Project read access denied

json
{
  "description": "Project read access denied",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

404

Project not found

json
{
  "description": "Project not found",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

500

Unexpected storage failure; the request fails

json
{
  "description": "Unexpected storage failure; the request fails",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

Referenced contracts

components/parameters/ProjectReference

json
{
  "schema": {
    "$ref": "#/components/schemas/ProjectReference"
  },
  "required": true,
  "description": "Project slug, UUID, or domain that identifies the project.",
  "name": "project_reference",
  "in": "path"
}

components/schemas/ProjectReference

json
{
  "type": "string"
}

components/schemas/Problem

json
{
  "type": "object",
  "properties": {
    "cause": {
      "type": "string",
      "enum": [
        "schedule_concurrency_forbidden",
        "schedule_fire_in_progress",
        "schedule_run_limit_reached"
      ],
      "description": "Schedule admission refusal."
    },
    "idempotency": {
      "type": "object",
      "properties": {
        "state": {
          "type": "string",
          "enum": [
            "in_progress",
            "payload_mismatch",
            "outcome_unknown"
          ]
        },
        "operation": {
          "type": "string",
          "minLength": 1
        },
        "retryable": {
          "type": "boolean"
        },
        "retry_after_seconds": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0
        },
        "expires_at": {
          "type": [
            "string",
            "null"
          ]
        },
        "recovery": {
          "type": "object",
          "properties": {
            "available": {
              "type": "boolean"
            },
            "description": {
              "type": "string"
            },
            "resource_url": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "description"
          ]
        }
      },
      "required": [
        "state",
        "operation",
        "retryable",
        "retry_after_seconds",
        "expires_at"
      ],
      "description": "Replay status, retry timing, and recovery lookup."
    },
    "type": {
      "type": "string",
      "description": "URI reference identifying the problem type",
      "example": "https://api.veryfront.com/errors/validation-failed"
    },
    "title": {
      "type": "string",
      "description": "Short human-readable summary of the problem",
      "example": "Validation Failed"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599,
      "description": "HTTP status code",
      "example": 400
    },
    "code": {
      "type": "string",
      "description": "Stable machine-readable error code",
      "example": "RUN_INVALID_INPUT"
    },
    "detail": {
      "type": "string",
      "description": "Human-readable explanation specific to this occurrence",
      "example": "The 'email' field must be a valid email address"
    },
    "instance": {
      "type": "string",
      "description": "URI reference identifying the specific occurrence",
      "example": "/projects/my-project/members"
    },
    "slug": {
      "type": "string",
      "description": "Stable identifier for the problem type",
      "example": "validation-failed"
    },
    "category": {
      "type": "string",
      "enum": [
        "AUTH",
        "RESOURCE",
        "VALIDATION",
        "DATABASE",
        "SUBSCRIPTION",
        "INTEGRATION",
        "INTERNAL"
      ],
      "description": "API error category",
      "example": "VALIDATION"
    },
    "suggestion": {
      "type": "string",
      "description": "Suggested action to resolve the problem",
      "example": "Check the request body and query parameters against the API documentation."
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "description": "Field path that caused the error",
            "example": "email"
          },
          "message": {
            "type": "string",
            "description": "Error message for this field",
            "example": "Invalid email format"
          },
          "code": {
            "type": "string",
            "description": "Error code for this field",
            "example": "INVALID_FORMAT"
          }
        },
        "required": [
          "field",
          "message"
        ]
      },
      "description": "Detailed field-level errors for validation failures"
    }
  },
  "required": [
    "type",
    "title",
    "status"
  ]
}

Operation contract

json
{
  "operationId": "listUploadDownloadUrls",
  "tags": [
    "projects/Uploads/Project Uploads"
  ],
  "summary": "List upload download URLs",
  "description": "Sign download URLs for up to 20 uploads at once and report a status for each upload that is missing or denied. Requires project.uploads.read.",
  "parameters": [
    {
      "$ref": "#/components/parameters/ProjectReference"
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "upload_references": {
              "type": "array",
              "items": {
                "type": "string",
                "minLength": 1
              },
              "minItems": 1,
              "maxItems": 20,
              "description": "Up to 20 upload UUIDs or project-relative file paths, signed in input order. Each upload retains its read-access check."
            },
            "ttl_seconds": {
              "type": "number",
              "minimum": 60,
              "maximum": 86400,
              "description": "Requested lifetime in seconds. Private uploads are capped at 1800 seconds; public uploads at 86400 seconds."
            },
            "ttl": {
              "type": "number",
              "minimum": 60,
              "maximum": 86400,
              "description": "Another spelling of ttl_seconds. Send one of the two."
            }
          },
          "required": [
            "upload_references"
          ]
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Per-upload signing results.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "oneOf": [
                    {
                      "type": "object",
                      "properties": {
                        "signed_url": {
                          "type": "string",
                          "description": "Temporary cloud-storage download URL."
                        },
                        "expires_at": {
                          "type": "string",
                          "description": "URL expiration timestamp. Private files expire after 30 minutes; public files after 24 hours."
                        },
                        "upload_reference": {
                          "type": "string"
                        },
                        "status": {
                          "type": "number",
                          "enum": [
                            200
                          ],
                          "description": "Signed successfully. Missing and denied uploads instead return individual 404 or 403 statuses."
                        }
                      },
                      "required": [
                        "signed_url",
                        "expires_at",
                        "upload_reference",
                        "status"
                      ]
                    },
                    {
                      "type": "object",
                      "properties": {
                        "upload_reference": {
                          "type": "string"
                        },
                        "status": {
                          "type": "number",
                          "enum": [
                            403
                          ]
                        },
                        "error": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "upload_reference",
                        "status",
                        "error"
                      ]
                    },
                    {
                      "type": "object",
                      "properties": {
                        "upload_reference": {
                          "type": "string"
                        },
                        "status": {
                          "type": "number",
                          "enum": [
                            404
                          ]
                        },
                        "error": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "upload_reference",
                        "status",
                        "error"
                      ]
                    }
                  ]
                }
              }
            },
            "required": [
              "data"
            ]
          }
        }
      }
    },
    "400": {
      "description": "Invalid batch",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "403": {
      "description": "Project read access denied",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "404": {
      "description": "Project not found",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "500": {
      "description": "Unexpected storage failure; the request fails",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    }
  },
  "x-documentation-source-tag": "Project Uploads",
  "x-canonical-documentation": {
    "domain": "projects",
    "resource": "Uploads",
    "subgroup": "Project Uploads",
    "name": "List upload download URLs",
    "description": "Sign download URLs for up to 20 uploads at once and report a status for each upload that is missing or denied. Requires project.uploads.read.",
    "operationId": "listUploadDownloadUrls"
  },
  "x-mint": {
    "href": "/cloud/rest/api-reference/projects-uploads-project-uploads/list-upload-download-urls"
  }
}