Skip to main content
HEAD
/
api
/
repos
/
{repo_name}
/
file
Get File Headers
curl --request HEAD \
  --url https://api.{cluster}.code.storage/api/repos/{repo_name}/file \
  --header 'Authorization: Bearer <token>'
{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Range
string

Standard HTTP byte-range header (bytes=<start>-<end>). Triggers a 206 Partial Content response.

​
If-Range
string

Conditional range request: when the supplied validator matches ETag or Last-Modified, the server returns 206 Partial Content; otherwise the full body is returned with 200 OK.

​
If-Match
string

Returns 412 Precondition Failed when the current ETag does not match.

​
If-None-Match
string

Returns 304 Not Modified when the current ETag matches.

​
If-Modified-Since
string

Returns 304 Not Modified when Last-Modified is on or before this date.

​
If-Unmodified-Since
string

Returns 412 Precondition Failed when Last-Modified is after this date.

Path Parameters

​
repo_name
string
required

Repository name. Names that contain / or any other character that is not safe in a URL path segment must be URL encoded so the value occupies a single path segment. For example pierre/example is sent as pierre%2Fexample. Plain names such as example can be sent as-is. The server URL-decodes the value before resolving the repository.

Query Parameters

​
path
string
required

Repository-relative file path to fetch.

​
ref
string

Optional branch, tag, or commit SHA to read from. When omitted, the repository default branch is used.

​
ephemeral
boolean

Whether ref should be resolved from the ephemeral namespace.

Response

File metadata headers returned. Body is empty.