7.5. Update Domain

Description

Update an existing domain.

Method and URL Structure

Method URL Structure
PUT /broker/rest/domains/:name

Request Parameters

Name Description Required Default
name Name of domain Yes
allowed_gear_sizes Array of zero or more gear sizes allowed on this domain No

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

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

cURL Command Example

$ curl -X PUT https://openshift.redhat.com/broker/rest/domains/mydomain --user user@example.com --data-urlencode name=mydomainx --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": "mydomainx",
    "suffix": "rhcloud.com"
  },
  "messages": [
    {
      "exit_code": 0,
      "field": null,
      "index": null,
      "severity": "info",
      "text": "Changed namespace to 'mydomainx'."
    }
  ],
  "status": "ok",
  ],
  "supported_api_versions": [
    1.0,
    1.1,
    1.2,
    1.3,  
    1.4,
    1.5,
    1.6
  ],
  "type": "domain",
  "version": "1.6"
}