Skip to content
cloudspark edited this page Dec 15, 2013 · 8 revisions

The Domain resource lets you attach A/CNAME/MX resource records for external domains to your account for use as a bip domain_id. Domains can also serve channel content by pointing to a channel renderer. A default 'vanity' system domain is installed when a new account is boarded, of the form {username}.{localdomain}. Domains marked as type : "vanity" are immutable. ie: they can not be renamed.

Attributes

id (string, UUID) Domain UUID

name (string, required) FQDN

renderer (object, optional) renderer structured keyed by

  • channel_id (string, UUID) Channel ID
  • renderer (string) Channel renderer name

Sample Request

GET /rest/domain/
{
  "id": "664616d3-5caf-ab09-b398-000012b5e920",
  "name": "docuser.bip.io",
  "renderer" : {
    "channel_id" : "61bea7bc-37dd-3368-9b36-00006fa6319e",
    "renderer" : "rss"
  }
  "_repr": "docuser.bip.io",
  "_href": "https://api.bip.io/rest/domain/664616d3-5caf-ab09-b398-000012b5e920"
}
Clone this wiki locally