List release files

http
GET /projects/{project_reference}/releases/{release_reference}/files

List release files. Requires project.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.
release_referencepathYes
patternqueryNo
cursorqueryNoOpaque cursor pointing at the next page. Omit it to read the first page.
limitqueryNo
sort_byqueryNoSort by path or last update time (default path).
sort_orderqueryNo
include_server_functionsqueryNo
fieldsqueryNoResponse projection, for example (id,path,size). Omit to return all file fields, including content.

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"
  },
  {
    "schema": {
      "type": "string",
      "description": "Release ID, version (for example, \"1.2.3\" or \"1.2\") or \"latest\"."
    },
    "required": true,
    "name": "release_reference",
    "in": "path"
  },
  {
    "schema": {
      "type": "string",
      "maxLength": 1024
    },
    "required": false,
    "name": "pattern",
    "in": "query"
  },
  {
    "schema": {
      "$ref": "#/components/schemas/PaginationCursor"
    },
    "required": false,
    "description": "Opaque cursor pointing at the next page. Omit it to read the first page.",
    "name": "cursor",
    "in": "query"
  },
  {
    "schema": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 100
    },
    "required": false,
    "name": "limit",
    "in": "query"
  },
  {
    "schema": {
      "type": "string",
      "enum": [
        "path",
        "updated_at"
      ],
      "default": "path",
      "description": "Sort by path or last update time (default path)."
    },
    "required": false,
    "description": "Sort by path or last update time (default path).",
    "name": "sort_by",
    "in": "query"
  },
  {
    "schema": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ],
      "default": "desc"
    },
    "required": false,
    "name": "sort_order",
    "in": "query"
  },
  {
    "schema": {
      "type": "string",
      "enum": [
        "true",
        "false"
      ]
    },
    "required": false,
    "name": "include_server_functions",
    "in": "query"
  },
  {
    "schema": {
      "type": "string",
      "pattern": "^!?\\([^)]*\\)$",
      "description": "Response fields to include or exclude. Examples: `(id,name)`, `(id,files(path))`, and `!(content)`.",
      "example": "(id,path,type,size)"
    },
    "required": false,
    "description": "Response projection, for example (id,path,size). Omit to return all file fields, including content.",
    "name": "fields",
    "in": "query"
  }
]

Responses

200

Files from the release with selectable response fields.

json
{
  "description": "Files from the release with selectable response fields.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "version_id": {
                  "type": "string"
                },
                "path": {
                  "type": "string"
                },
                "content": {
                  "type": "string"
                },
                "binary": {
                  "type": "object",
                  "properties": {
                    "content_hash": {
                      "type": "string",
                      "pattern": "^[a-f0-9]{64}$"
                    },
                    "byte_size": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 8388608
                    },
                    "content_type": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 200,
                      "pattern": "^[\\x20-\\x7e]+$"
                    }
                  },
                  "required": [
                    "content_hash",
                    "byte_size",
                    "content_type"
                  ],
                  "additionalProperties": false
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "page",
                    "function",
                    "component",
                    "file"
                  ]
                },
                "size": {
                  "type": "number"
                },
                "updated_at": {
                  "type": "string"
                },
                "_links": {
                  "type": "object",
                  "additionalProperties": {}
                }
              },
              "required": [
                "id",
                "version_id",
                "path",
                "content",
                "type",
                "size",
                "updated_at"
              ]
            }
          },
          "page_info": {
            "$ref": "#/components/schemas/PageInfo"
          },
          "release_id": {
            "type": "string"
          },
          "release_version": {
            "type": [
              "string",
              "null"
            ]
          },
          "_links": {
            "type": "object",
            "additionalProperties": {}
          }
        },
        "required": [
          "data",
          "page_info",
          "release_id",
          "release_version"
        ]
      }
    }
  }
}

400

Invalid fields, filter, sort, cursor, or page size; limit must be an integer from 1 to 100.

json
{
  "description": "Invalid fields, filter, sort, cursor, or page size; limit must be an integer from 1 to 100.",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

401

Unauthorized

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

403

Forbidden - insufficient project permissions

json
{
  "description": "Forbidden - insufficient project permissions",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

404

Not found

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

500

Server error

json
{
  "description": "Server error",
  "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/parameters/PaginationCursor

json
{
  "schema": {
    "$ref": "#/components/schemas/PaginationCursor"
  },
  "required": false,
  "description": "Opaque cursor pointing at the next page. Omit it to read the first page.",
  "name": "cursor",
  "in": "query"
}

components/schemas/PaginationCursor

json
{
  "type": "string",
  "description": "Opaque cursor pointing at the next page. Omit it to read the first page."
}

components/schemas/PageInfo

json
{
  "type": "object",
  "properties": {
    "self": {
      "type": [
        "string",
        "null"
      ],
      "description": "Cursor pointing to the current page"
    },
    "first": {
      "type": "null",
      "description": "First page cursor (always null for cursor-based pagination)"
    },
    "next": {
      "type": [
        "string",
        "null"
      ],
      "description": "Cursor for the next page (null if no more pages)"
    },
    "prev": {
      "type": [
        "string",
        "null"
      ],
      "description": "Cursor for the previous page (null if on first page)"
    }
  },
  "required": [
    "self",
    "first",
    "next",
    "prev"
  ]
}

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": "listReleaseFiles",
  "tags": [
    "projects/Files/Release Files"
  ],
  "summary": "List release files",
  "description": "List release files. Requires project.read.",
  "parameters": [
    {
      "$ref": "#/components/parameters/ProjectReference"
    },
    {
      "schema": {
        "type": "string",
        "description": "Release ID, version (for example, \"1.2.3\" or \"1.2\") or \"latest\"."
      },
      "required": true,
      "name": "release_reference",
      "in": "path"
    },
    {
      "schema": {
        "type": "string",
        "maxLength": 1024
      },
      "required": false,
      "name": "pattern",
      "in": "query"
    },
    {
      "$ref": "#/components/parameters/PaginationCursor"
    },
    {
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 100
      },
      "required": false,
      "name": "limit",
      "in": "query"
    },
    {
      "schema": {
        "type": "string",
        "enum": [
          "path",
          "updated_at"
        ],
        "default": "path",
        "description": "Sort by path or last update time (default path)."
      },
      "required": false,
      "description": "Sort by path or last update time (default path).",
      "name": "sort_by",
      "in": "query"
    },
    {
      "schema": {
        "type": "string",
        "enum": [
          "asc",
          "desc"
        ],
        "default": "desc"
      },
      "required": false,
      "name": "sort_order",
      "in": "query"
    },
    {
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      },
      "required": false,
      "name": "include_server_functions",
      "in": "query"
    },
    {
      "schema": {
        "type": "string",
        "pattern": "^!?\\([^)]*\\)$",
        "description": "Response fields to include or exclude. Examples: `(id,name)`, `(id,files(path))`, and `!(content)`.",
        "example": "(id,path,type,size)"
      },
      "required": false,
      "description": "Response projection, for example (id,path,size). Omit to return all file fields, including content.",
      "name": "fields",
      "in": "query"
    }
  ],
  "responses": {
    "200": {
      "description": "Files from the release with selectable response fields.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "version_id": {
                      "type": "string"
                    },
                    "path": {
                      "type": "string"
                    },
                    "content": {
                      "type": "string"
                    },
                    "binary": {
                      "type": "object",
                      "properties": {
                        "content_hash": {
                          "type": "string",
                          "pattern": "^[a-f0-9]{64}$"
                        },
                        "byte_size": {
                          "type": "integer",
                          "minimum": 0,
                          "maximum": 8388608
                        },
                        "content_type": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 200,
                          "pattern": "^[\\x20-\\x7e]+$"
                        }
                      },
                      "required": [
                        "content_hash",
                        "byte_size",
                        "content_type"
                      ],
                      "additionalProperties": false
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "page",
                        "function",
                        "component",
                        "file"
                      ]
                    },
                    "size": {
                      "type": "number"
                    },
                    "updated_at": {
                      "type": "string"
                    },
                    "_links": {
                      "type": "object",
                      "additionalProperties": {}
                    }
                  },
                  "required": [
                    "id",
                    "version_id",
                    "path",
                    "content",
                    "type",
                    "size",
                    "updated_at"
                  ]
                }
              },
              "page_info": {
                "$ref": "#/components/schemas/PageInfo"
              },
              "release_id": {
                "type": "string"
              },
              "release_version": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "_links": {
                "type": "object",
                "additionalProperties": {}
              }
            },
            "required": [
              "data",
              "page_info",
              "release_id",
              "release_version"
            ]
          }
        }
      }
    },
    "400": {
      "description": "Invalid fields, filter, sort, cursor, or page size; limit must be an integer from 1 to 100.",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "403": {
      "description": "Forbidden - insufficient project permissions",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "404": {
      "description": "Not found",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "500": {
      "description": "Server error",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    }
  },
  "x-documentation-source-tag": "Release Files",
  "x-canonical-documentation": {
    "domain": "projects",
    "resource": "Files",
    "subgroup": "Release Files",
    "name": "List release files",
    "description": "List release files. Requires project.read.",
    "operationId": "listReleaseFiles"
  },
  "x-mint": {
    "href": "/cloud/rest/api-reference/projects-files-release-files/list-release-files"
  }
}