Configurations & assets

#Get an asset

Address

https://<your-org>.brambleit.cloud/atlas/api/assets/:id

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Path parameters

Response 200

{
  "asset": null,
  "type": "string",
  "refs": [],
  "rmm": null
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/assets/42', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Update an asset

Address

https://<your-org>.brambleit.cloud/atlas/api/assets/:id

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Path parameters

Request body JSON

Response 200

{
  "ok": true
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/assets/42', {
  method: 'PUT',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"data":"…"}),
});
const data = await res.json();

#Reveal a secret field

Address

https://<your-org>.brambleit.cloud/atlas/api/assets/:id/reveal

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Path parameters

Request body JSON

Response 200

{
  "value": null
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/assets/42/reveal', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"key":"…","copy":"…"}),
});
const data = await res.json();

#Delete an asset

Address

https://<your-org>.brambleit.cloud/atlas/api/assets/:id

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Path parameters

Response 200

{
  "ok": true
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/assets/42', {
  method: 'DELETE',
  credentials: 'include',
});
const data = await res.json();

#Update an asset from its RMM device

Address

https://<your-org>.brambleit.cloud/atlas/api/assets/:id/rmm-sync

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Path parameters

Response 200

{
  "rmm": null
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/assets/42/rmm-sync', {
  method: 'POST',
  credentials: 'include',
});
const data = await res.json();

#Link an asset to an RMM device

Address

https://<your-org>.brambleit.cloud/atlas/api/assets/:id/rmm-link

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Path parameters

Request body JSON

Response 200

{
  "ok": true
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/assets/42/rmm-link', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"device_id":7}),
});
const data = await res.json();

#What a record is related to

Address

https://<your-org>.brambleit.cloud/atlas/api/relations

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Query parameters

Response 200

{
  "relations": []
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/relations', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Relate two records

Address

https://<your-org>.brambleit.cloud/atlas/api/relations

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Request body JSON

Response 200

{
  "ok": true
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/relations', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"a_kind":"string","b_kind":"string","note":"string","a_id":7,"b_id":7}),
});
const data = await res.json();

#Remove a relation

Address

https://<your-org>.brambleit.cloud/atlas/api/relations/:id

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Path parameters

Response 200

{
  "ok": true
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/relations/42', {
  method: 'DELETE',
  credentials: 'include',
});
const data = await res.json();

#Diagrams an asset appears on (asset page)

Address

https://<your-org>.brambleit.cloud/atlas/api/assets/:id/diagrams

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Path parameters

Response 200

{
  "diagrams": [
    {
      "id": 42,
      "kind": "string",
      "name": "Example name"
    }
  ]
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/assets/42/diagrams', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();