Chapter 7. Domains

This chapter provides information on API resources to add, update, and manage OpenShift user domains. A domain must be created before OpenShift applications can be created. Domain names on OpenShift are non-strict, meaning there is no preceding period, and form part of the application name. Therefore, the syntax for the application name is ApplicationName-DomainName.rhcloud.com.
The following table describes each parameter associated with an OpenShift domain.
Name Description
name Name of the domain
suffix Domain suffix
allowed_gear_sizes Array of zero or more gear sizes allowed on this domain

7.1. Create a Domain

Description

Create a new domain for an OpenShift user account. Note that a domain is required to create applications on OpenShift Enterprise.

Method and URL Structure

Method URL Structure
POST /broker/rest/domains

Request Parameters

Name Description Required Default
name Name of domain Yes
allowed_gear_sizes List of gear sizes that can be created on this domain No

See Section A.3, “Domains” for more information about the valid options applicable to these request parameters.
Request

{
  "name": "mydomain",
  "allowed_gear_sizes": "small"
}

cURL Command Example

$ curl -X POST https://openshift.redhat.com/broker/rest/domains/ --user user@example.com:password --data-urlencode name=mydomain --data-urlencode allowed_gear_sizes=small

JSON Response

The API returns the domain resource with related resource links which have been left out for brevity. See Chapter 7, Domains for more information on all domain parameters. 

{
  "api_version": 1.6,
  "data": {
    "allowed_gear_sizes": [
      "small"
    ],
    "creation_time": "2013-11-07T00:28:13Z",
    "id": "527ade9d7f9c48d371000009",
    "members": [
      {
        "explicit_role": null,
        "from": [
          {
            "type": "owner",
            "role": "admin"
          }
        ],
        "id": "527ade897f9c48d371000001",
        "login": "user@example.com",
        "owner": true,
        "role": "admin",
        "type": "user"
      }
    ],
    "name": "mydomain",
    "suffix": "rhcloud.com"
  },
  "messages": [
    {
      "exit_code": 0,
      "field": null,
      "index": null,
      "severity": "info",
      "text": "Created domain with name mydomain"
    }
  ],
  "status": "created",
  ],
  "supported_api_versions": [
    1.0,
    1.1,
    1.2,
    1.3,  
    1.4,
    1.5,
    1.6
  ],
  "type": "domain",
  "version": "1.6"
}