1. Learn Siteleaf
2. API

Source

Overview

The Source API can be thought of as a filesystem view, as if you were looking at your Jekyll source code locally. It functions a little differently than the rest of the API and isn’t as structured.

1. Get files
2. Create or replace a file
3. Delete a file

Get files

Returns information about a single file or the contents of a directory. The :name is optional, and without it lists the contents of the root directory.

Endpoint

GET https://api.siteleaf.com/v2/sites/:site_id/source/:name

Response if name is a file

Status: 200 OK

{
  "name": "index.html",
  "type": "page",
  "sha": "ba7f4bd2da35e372fc34fdf3b60cb108b7412b52",
  "url": "/",
  "download_url": "https://api.siteleaf.com/v2/sites/56965a9dbe6765465c000007/source/index.html?download",
  "user_id": "51ac1ebd5dde223c94000001",
  "created_at": "2016-01-13 14:09:33 +0000",
  "updated_at": "2016-01-13 14:09:33 +0000"
}

Response if name is a directory

Status: 200 OK

[
  {
    "name": "_config.yml",
    "type": "site",
    "sha": "5a25a3ad7878fdf634e55cba9fd8336d78042a27",
    "download_url": "https://api.siteleaf.com/v2/sites/56965a9dbe6765465c000007/source/_config.yml?download",
    "user_id": "51ac1ebd5dde223c94000001",
    "created_at": "2016-01-13 14:09:33 +0000",
    "updated_at": "2016-01-15 16:22:12 +0000"
  },
  {
    "name": "index.html",
    "type": "page",
    "sha": "ba7f4bd2da35e372fc34fdf3b60cb108b7412b52",
    "url": "/",
    "download_url": "https://api.siteleaf.com/v2/sites/56965a9dbe6765465c000007/source/index.html?download",
    "user_id": "51ac1ebd5dde223c94000001",
    "created_at": "2016-01-13 14:09:33 +0000",
    "updated_at": "2016-01-13 14:09:33 +0000"
  },
  {
    "filesize": null,
    "name": "_posts",
    "sha": null,
    "type": "directory"
  }
]

Create or replace a file

This endpoint has a couple functions:

• If a file with the specified name already existed the file will be replaced.
• Otherwise a new file will be created with that name and the returned type will be one of page, document, or file.

It’s useful for uploading raw Jekyll source files and creating the correct type of Siteleaf resource.

Endpoint

PUT https://api.siteleaf.com/v2/sites/:site_id/source/:name

Input

Name	Type	Desc
file	File	A multipart/form-data file attachment

Response

Status: 200 OK

{
  "name": "index.html",
  "type": "page",
  "sha": "ba7f4bd2da35e372fc34fdf3b60cb108b7412b52",
  "url": "/",
  "download_url": "https://api.siteleaf.com/v2/sites/56965a9dbe6765465c000007/source/index.html?download",
  "user_id": "51ac1ebd5dde223c94000001",
  "created_at": "2016-01-13 14:09:33 +0000",
  "updated_at": "2016-01-13 14:09:33 +0000"
}

Delete a file

Will not delete directories or the _config.yml file.

Endpoint

DELETE https://api.siteleaf.com/v2/sites/:site_id/source/:name

Response

Status: 200 OK

{
  "name": "index.html",
  "type": "page",
  "sha": "ba7f4bd2da35e372fc34fdf3b60cb108b7412b52",
  "url": "/",
  "download_url": "https://api.siteleaf.com/v2/sites/56965a9dbe6765465c000007/source/index.html?download",
  "user_id": "51ac1ebd5dde223c94000001",
  "created_at": "2016-01-13 14:09:33 +0000",
  "updated_at": "2016-01-13 14:09:33 +0000"
}

Help improve this page

← Documents Pagination →