Git

Read a source file

Read one source file at a branch, tag, or commit SHA. Use head for metadata without file contents.

get/v1/spaces/{spaceId}/source/file

Request

  • Base URL: https://api.spacefast.com
  • URL: https://api.spacefast.com/v1/spaces/{spaceId}/source/file
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.spacefast.com/v1/auth/oauth2/authorize, token URL https://api.spacefast.com/v1/auth/oauth2/token; client credentials, token URL https://api.spacefast.com/v1/auth/oauth2/token, scopes: spaces:read)

Path parameters

spaceIdstring required

Query parameters

connectionType'connected' | 'hosted'

Which of the space's repository connections to act on: connected for the repository you linked from a provider, hosted for the one Spacefast hosts and you push to.

refstring

Branch, tag, or commit SHA to read. Defaults to the repository's default branch.

pathstring required

Exact file path from the repository root. Use forward slashes. Do not add a leading slash.

headstring

Return the file's metadata only, with content null.

maxBytesinteger

Maximum file content to read. The limit is 1 MiB.

Response

Response for status 200

$schemastring uri

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

Changes

No recorded changes to this operation across all 1 revision of this API.