Skip to main content
GET
List one directory of a release, by the release's id

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

release_id
string
required

The release id

Required string length: 1 - 255

Query Parameters

package_id
string
required

The package the release must be in

Required string length: 1 - 255
path
string
default:""

Directory to list, relative to the package root; empty is the root

Maximum string length: 4096

Response

Successful Response

kind
enum<string>
required
Available options:
directory,
file
path
string
required

Empty for the root

package_id
string
required
release_id
string
required
version
string | null
required
index_status
enum<string> | null
required

A root with no entries usually means indexing hasn't finished

Available options:
processing,
completed,
failed
entries
ReleaseFileEntry · object[]

Directories first, then files

file
ReleaseFileEntry · object | null
url
string | null

Time-limited link to a file's content

expires_at
string<date-time> | null