ReferenceSites API

Pages & news

A page's draft, publishing, versions, pinning and making it the site's home page.

Method	Path	Summary
GET	`/api/v2/pages/:id`	Get a page
PUT	`/api/v2/pages/:id/draft`	Save a page's draft
POST	`/api/v2/pages/:id/publish`	Publish a page's draft
POST	`/api/v2/pages/:id/discard`	Throw away a page's draft
DELETE	`/api/v2/pages/:id`	Delete a page
POST	`/api/v2/pages/:id/home`	Make a page the site's home page
POST	`/api/v2/pages/:id/pin`	Pin or unpin a news post
GET	`/api/v2/pages/:id/versions`	A page's published versions
POST	`/api/v2/pages/:id/versions/:vid/restore`	Restore a published version

#Get a page

GET/api/v2/pages/:id

Address: https://<your-org>.brambleit.cloud/sites/api/v2/pages/:id
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: Sites.

Path parameters

Name	Type	Description
`id`required	number

Response 200

Example request

Bash

curl -X GET 'https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5', {
  method: 'GET',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method GET -Uri 'https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5' -Headers $headers

#Save a page's draft

PUT/api/v2/pages/:id/draft

Address: https://<your-org>.brambleit.cloud/sites/api/v2/pages/:id/draft
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: Sites.

Path parameters

Name	Type	Description
`id`required	number

Request body JSON

Name	Type	Description
`content`	any	The page's blocks.
`banner_asset_id`	number	A banner image (from the image upload).
`title`	string	Its title.
`summary`	any	Its summary (for news).

Response 200

Errors

Status	Message
400	Give it a title

Example request

Bash

curl -X PUT 'https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/draft' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"content":"…","banner_asset_id":12.5,"title":"Example title","summary":"…"}'

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/draft', {
  method: 'PUT',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"content":"…","banner_asset_id":12.5,"title":"Example title","summary":"…"}),
});
const data = await res.json();

Python

import os, requests

r = requests.put(
    "https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/draft",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
    json={"content":"…","banner_asset_id":12.5,"title":"Example title","summary":"…"},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
$body = '{"content":"…","banner_asset_id":12.5,"title":"Example title","summary":"…"}'
Invoke-RestMethod -Method PUT -Uri 'https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/draft' -Headers $headers -ContentType 'application/json' -Body $body

#Publish a page's draft

POST/api/v2/pages/:id/publish

Address: https://<your-org>.brambleit.cloud/sites/api/v2/pages/:id/publish
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: Sites.

Path parameters

Name	Type	Description
`id`required	number

Response 200

Example request

Bash

curl -X POST 'https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/publish' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/publish', {
  method: 'POST',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.post(
    "https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/publish",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method POST -Uri 'https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/publish' -Headers $headers

#Throw away a page's draft

POST/api/v2/pages/:id/discard

Address: https://<your-org>.brambleit.cloud/sites/api/v2/pages/:id/discard
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: Sites.

Path parameters

Name	Type	Description
`id`required	number

Response 200

Example request

Bash

curl -X POST 'https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/discard' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/discard', {
  method: 'POST',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.post(
    "https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/discard",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method POST -Uri 'https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/discard' -Headers $headers

#Delete a page

DELETE/api/v2/pages/:id

Address: https://<your-org>.brambleit.cloud/sites/api/v2/pages/:id
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: Sites.

Path parameters

Name	Type	Description
`id`required	number

Response 200

Field	Type	Description
`ok`	boolean

Example response

JSON

{
  "ok": true
}

Example request

Bash

curl -X DELETE 'https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5', {
  method: 'DELETE',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.delete(
    "https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method DELETE -Uri 'https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5' -Headers $headers

#Make a page the site's home page

POST/api/v2/pages/:id/home

Address: https://<your-org>.brambleit.cloud/sites/api/v2/pages/:id/home
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: Sites.

Path parameters

Name	Type	Description
`id`required	number

Response 200

Field	Type	Description
`ok`	boolean

Example response

JSON

{
  "ok": true
}

Example request

Bash

curl -X POST 'https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/home' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/home', {
  method: 'POST',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.post(
    "https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/home",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method POST -Uri 'https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/home' -Headers $headers

#Pin or unpin a news post

POST/api/v2/pages/:id/pin

Address: https://<your-org>.brambleit.cloud/sites/api/v2/pages/:id/pin
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: Sites.

Path parameters

Name	Type	Description
`id`required	number

Request body JSON

Name	Type	Description
`on`	any

Response 200

Field	Type	Description
`ok`	boolean

Example response

JSON

{
  "ok": true
}

Example request

Bash

curl -X POST 'https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/pin' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"on":"…"}'

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/pin', {
  method: 'POST',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"on":"…"}),
});
const data = await res.json();

Python

import os, requests

r = requests.post(
    "https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/pin",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
    json={"on":"…"},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
$body = '{"on":"…"}'
Invoke-RestMethod -Method POST -Uri 'https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/pin' -Headers $headers -ContentType 'application/json' -Body $body

#A page's published versions

GET/api/v2/pages/:id/versions

Address: https://<your-org>.brambleit.cloud/sites/api/v2/pages/:id/versions
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: Sites.

Path parameters

Name	Type	Description
`id`required	number

Response 200

Field	Type	Description
`versions`	array of any

Example response

JSON

{
  "versions": []
}

Example request

Bash

curl -X GET 'https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/versions' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/versions', {
  method: 'GET',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/versions",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method GET -Uri 'https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/versions' -Headers $headers

#Restore a published version

POST/api/v2/pages/:id/versions/:vid/restore

Address: https://<your-org>.brambleit.cloud/sites/api/v2/pages/:id/versions/:vid/restore
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: Sites.

Path parameters

Name	Type	Description
`id`required	number
`vid`required	number

Response 200

Example request

Bash

curl -X POST 'https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/versions/12.5/restore' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/versions/12.5/restore', {
  method: 'POST',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.post(
    "https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/versions/12.5/restore",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method POST -Uri 'https://<your-org>.brambleit.cloud/sites/api/v2/pages/12.5/versions/12.5/restore' -Headers $headers

Was this page helpful?