List release files

releaseFiles(projectReference: String!, releaseReference: String!, pattern: String, limit: Int, cursor: String, sortBy: ReleaseFileSortBy, sortOrder: ReleaseFileSortOrder, includeServerFunctions: Boolean, fields: String): ReleaseFilePage!

Requires project.read.

Arguments

ArgumentTypeRequiredDescription
projectReferenceString!YesProject UUID, slug or configured domain.
releaseReferenceString!YesRelease ID, latest or a version specifier.
patternStringNoFile glob, for example pages/**.
limitIntNoFiles per page, between 1 and 100. Defaults to 100.
cursorStringNopageInfo.endCursor of the previous page.
sortByReleaseFileSortByNoSort field. Defaults to updated_at. Default: "updated_at".
sortOrderReleaseFileSortOrderNoSort direction. Defaults to desc. Default: "desc".
includeServerFunctionsBooleanNoSet to false to read server-function source only as an editor. Omit to use the rule every GraphQL file read uses.
fieldsStringNoAccepted as on REST, for example (id,path,size); the selection set chooses the fields GraphQL serves.

Response

Returns ReleaseFilePage!. Open the type for its fields and nested types.

FieldTypeDescription
data[ReleaseFile!]!Files of this page.
pageInfoPageInfo!Continue from endCursor while hasNextPage is true.
releaseIdID!ID of the release.
releaseVersionStringVersion of the release, or null for a release created before versioning.
linksJSONLinks to this release file list.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
query ReleaseFiles($projectReference: String!, $releaseReference: String!, $pattern: String, $limit: Int, $cursor: String, $sortBy: ReleaseFileSortBy, $sortOrder: ReleaseFileSortOrder, $includeServerFunctions: Boolean, $fields: String) {
  releaseFiles(projectReference: $projectReference, releaseReference: $releaseReference, pattern: $pattern, limit: $limit, cursor: $cursor, sortBy: $sortBy, sortOrder: $sortOrder, includeServerFunctions: $includeServerFunctions, fields: $fields) {
    links
    releaseId
    releaseVersion
    data {
      id
      updatedAt
      content
      links
      path
    }
    pageInfo {
      hasNextPage
      endCursor
      hasPreviousPage
      startCursor
    }
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "releaseReference": "example"
}