Rapidly Integrate Any Supported Service

The Domain resource lets you attach A/CNAME/MX resource records for external domains to your account for use as a bip domain_id.

For any domain records you wish to set up, please CNAME them to {username}.bip.io - this will help us verify your ownership and add capacity for you when you need it.

Parameter Data Type Description
id UUID (String) Unique Domain ID
name** String Domain Name (FQDN)
renderer Object keyed by :

  • channel_id Target Channel Id
  • renderer Renderer name
  • query Additional URI GET query string
Invokes a Channel Renderer, serving the renderer contents to the requesting client.

eg:
 {
  "channel_id" : "cf01c8ec-e542-46ce-9895-74b6ea3fcf5b",
  "renderer" : "rss"
}
Domain Renderers are not authenticated
Domains are not immediately available unless they are already aliased to {username}.bip.io, so its better to set this up in advance. Otherwise, verify domain ownership via your Account Settings area in the Bipio website after a 202 Accepted response packet, or simply call the Domain Confirm RPC once DNS is propertly configured.

IMPORTANT Any bip.io subdomains (*.bip.io), such as your {username}.bip.io account domain is immutable.
Decorators augment a resource record with useful meta-data and are read-only
Parameter Description
_available boolean, Domain has validated and is available
_href Record URI

eg: https://api.bip.io/rest/domain/cf01c8ec-e542-46ce-9895-74b6ea3fcf5b
_repr Derived Domain Representation

eg: example.cloudspark.com.au

REST Examples

REQUEST
GET /rest/domain/664616d3-5caf-ab09-b398-000012b5e920 HTTP/1.1
RESPONSE
200 OK

{
  "id": "664616d3-5caf-ab09-b398-000012b5e920",
  "name": "foobar.com",
  "_repr": "foobar.com",
  "_href": "https://api.bip.io/rest/domain/664616d3-5caf-ab09-b398-000012b5e920",
  "_available": "false"
}

            
REQUEST
POST /rest/domain HTTP/1.1

{
    name: "foobar.com"
}
RESPONSE
202 Accepted

{
  "id": "664616d3-5caf-ab09-b398-000012b5e920",
  "name": "foobar.com",
  "_repr": "foobar.com",
  "_href": "https://api.bip.io/rest/domain/664616d3-5caf-ab09-b398-000012b5e920"
}

            
REQUEST
PUT /rest/domain HTTP/1.1

{
    id: "664616d3-5caf-ab09-b398-000012b5e920",
    name: "subdomain.foobar.com"
}
RESPONSE
202 Accepted

{
  "id": "664616d3-5caf-ab09-b398-000012b5e920",
  "name": "subdomain.foobar.com",
  "_repr": "subdomain.foobar.com",
  "_href": "https://api.bip.io/rest/domain/664616d3-5caf-ab09-b398-000012b5e920"
}

            
REQUEST
DELETE /rest/domain/664616d3-5caf-ab09-b398-000012b5e920 HTTP/1.1
RESPONSE
200 OK