ReferenceAtlas API

Domains & certificates

Domains and their SSL certificates, checked daily (registration expiry from RDAP, certificate from port 443).

Method	Path	Summary
PUT	`/api/domains/:id`	Update a domain
POST	`/api/domains/:id/check`	Check a domain and its certificate now
DELETE	`/api/domains/:id`	Delete a domain

#Update a domain

PUT/api/domains/:id

Address: https://<your-org>.brambleit.cloud/atlas/api/domains/:id
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Path parameters

Name	Type	Description
`id`required	integer

Response 200

Field	Type	Description
`ok`	boolean

Example response

JSON

{
  "ok": true
}

Example request

JavaScript

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

#Check a domain and its certificate now

POST/api/domains/:id/check

Address: https://<your-org>.brambleit.cloud/atlas/api/domains/:id/check
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Path parameters

Name	Type	Description
`id`required	integer

Response 200

Field	Type	Description
`domain`	string

Example response

JSON

{
  "domain": "string"
}

Errors

Status	Message
429	Checked less than a minute ago — try again shortly

Example request

JavaScript

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

#Delete a domain

DELETE/api/domains/:id

Address: https://<your-org>.brambleit.cloud/atlas/api/domains/:id
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Path parameters

Name	Type	Description
`id`required	integer

Response 200

Field	Type	Description
`ok`	boolean

Example response

JSON

{
  "ok": true
}

Example request

JavaScript

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

Was this page helpful?