REST Resources

/api/space/domain-management/domains

The following operations are supported on this resource:

  • GET - Get the Global domain and all its top-level children
  • GET - This API is used to return all domains in Space
  • POST - Add a new domain to the list of domains in Junos Space
GET /domains Version 1

Get the Global domain and all its top-level children.

Sample Usage

GET /domains


  • Sample Output XML:
    <domain href="/api/space/domain-management/domains/{id}" uri="/api/space/domain-management/domains">
         <write-enabled>Boolean</write-enabled>
         <id>Integer</id>
         <child-count>Integer</child-count>
         <modified-at>String</modified-at>
         <created-at>String</created-at>
         <description>String</description>
         <name>String</name>
         <children uri="/api/space/domain-management/domains/children">
               <domain href="/api/space/domain-management/domains/{id}" uri="/api/space/domain-management/domains/children/{id}">
                   <id>Integer</id>
                   <name>String</name>
                   <child-count>Integer</child-count>
                   <created-at>String</created-at>
                   <description>String</description>
                   <write-enabled>Boolean</write-enabled>
                   <child-lock>Boolean</child-lock>
                   <no-of-assigned-users>Integer</no-of-assigned-users>
                   <no-of-assigned-remote-profile>Integer</no-of-assigned-remote-profile>
               </domain>
         </children>
         <child-lock>Boolean</child-lock>
                 <domain-type>String</domain-type>
         <no-of-assigned-users>Integer</no-of-assigned-users>
         <no-of-assigned-remote-profile>Integer</no-of-assigned-remote-profile>
         <users href="/api/space/domain-management/domains/{id}/users"/>
         <profiles href="/api/space/domain-management/domains/{id}/profiles"/>
         <devices href="/api/space/domain-management/domains/{id}/devices"/>
    </domain>

  • Sample Output JSON:
    {
       "domain" : {
         "@href" : "/api/space/domain-management/domains/{id}" ,
         "@uri" : "/api/space/domain-management/domains" ,
         "write-enabled" : "Boolean" ,
         "id" : "Integer" ,
         "child-count" : "Integer" ,
         "modified-at" : "String" ,
         "created-at" : "String" ,
         "description" : "String" ,
         "name" : "String" ,
         "children" : {
           "@uri" : "/api/space/domain-management/domains/children" ,
           "domain" : {
             "@href" : "/api/space/domain-management/domains/{id}" ,
             "@uri" : "/api/space/domain-management/domains/children/{id}" ,
             "id" : "Integer" ,
             "name" : "String" ,
             "child-count" : "Integer" ,
             "created-at" : "String" ,
             "description" : "String" ,
             "write-enabled" : "Boolean" ,
             "child-lock" : "Boolean" ,
             "no-of-assigned-users" : "Integer" ,
             "no-of-assigned-remote-profile" : "Integer"
           }
         } ,
         "child-lock" : "Boolean" ,
           "domain-type" : "String"
         "no-of-assigned-users" : "Integer" ,
         "no-of-assigned-remote-profile" : "Integer" ,
         "users" : {
           "@href" : "/api/space/domain-management/domains/{id}/users"
         } ,
         "profiles" : {
           "@href" : "/api/space/domain-management/domains/{id}/profiles"
         } ,
         "devices" : {
           "@href" : "/api/space/domain-management/domains/{id}/devices"
         }
       }
    }

    • GET /domains Version 2

    This API is used to return all domains in Space.

    Sample Usage

    GET /domains


  • Sample Output XML:
    <domains total="Integer" uri="/api/space/domain-management/domains">
         <domain href="/api/space/domain-management/domains/{id}" uri="/api/space/domain-management/domains/{id}">
               <id>Integer</id>
               <name>String</name>
               <children total="Integer" uri="/api/space/domain-management/domains/{id}/children">
                   <domain href="/api/space/domain-management/domains/{id}" uri="/api/space/domain-management/domains/{id}/children/{id}">
                         <child-count>Integer</child-count>
                         <id>Integer</id>
                         <name>String</name>
                         <child-lock>Boolean</child-lock>
                   </domain>
               </children>
               <child-count>Integer</child-count>
               <child-lock>Boolean</child-lock>
               <domain-type>String</domain-type>
         </domain>
    </domains>

  • Sample Output JSON:
    {
       "domains" : {
         "@total" : "Integer" ,
         "@uri" : "/api/space/domain-management/domains" ,
         "domain" : {
           "@href" : "/api/space/domain-management/domains/{id}" ,
           "@uri" : "/api/space/domain-management/domains/{id}" ,
           "id" : "Integer" ,
           "name" : "String" ,
           "children" : {
             "@total" : "Integer" ,
             "@uri" : "/api/space/domain-management/domains/{id}/children" ,
             "domain" : {
               "@href" : "/api/space/domain-management/domains/{id}" ,
               "@uri" : "/api/space/domain-management/domains/{id}/children/{id}" ,
               "child-count" : "Integer" ,
               "id" : "Integer" ,
               "name" : "String" ,
               "child-lock" : "Boolean"
             }
           } ,
           "child-count" : "Integer" ,
           "child-lock" : "Boolean" ,
           "domain-type" : "String"
         }
       }
    }

    • Access Control

    The following capabilities are required to access this API: ReadDomain

      For other non-deprecated versions of this API, refer to :
    • version 1


    POST /domains Version 1

    Add a new domain to the list of domains in Junos Space.

    Sample Usage

    POST /domains


  • Sample Input XML:
    <domain>
         <description>String</description>
         <name>String</name>
         <child-lock>Boolean</child-lock>
    </domain>

  • Sample Output XML:
    <domain href="/api/space/domain-management/domains/{id}" uri="/api/space/domain-management/domains/{id}">
         <write-enabled>Boolean</write-enabled>
         <id>Integer</id>
         <child-count>Integer</child-count>
         <modified-at>String</modified-at>
         <created-at>String</created-at>
         <description>String</description>
         <name>String</name>
         <children uri="/api/space/domain-management/domains/{id}/children">
               <domain href="/api/space/domain-management/domains/{id}" uri="/api/space/domain-management/domains/{id}/children/{id}">
                   <child-count>Integer</child-count>
                   <write-enabled>Boolean</write-enabled>
                   <id>Integer</id>
                   <name>String</name>
                   <child-lock>Boolean</child-lock>
               </domain>
         </children>
         <child-lock>Boolean</child-lock>
    </domain>

  • Sample Input JSON:
    {
       "domain" : {
         "description" : "String" ,
         "name" : "String" ,
         "child-lock" : "Boolean"
       }
    }

  • Sample Output JSON:
    {
       "domain" : {
         "@href" : "/api/space/domain-management/domains/{id}" ,
         "@uri" : "/api/space/domain-management/domains/{id}" ,
         "write-enabled" : "Boolean" ,
         "id" : "Integer" ,
         "child-count" : "Integer" ,
         "modified-at" : "String" ,
         "created-at" : "String" ,
         "description" : "String" ,
         "name" : "String" ,
         "children" : {
           "@uri" : "/api/space/domain-management/domains/{id}/children" ,
           "domain" : {
             "@href" : "/api/space/domain-management/domains/{id}" ,
             "@uri" : "/api/space/domain-management/domains/{id}/children/{id}" ,
             "child-count" : "Integer" ,
             "write-enabled" : "Boolean" ,
             "id" : "Integer" ,
             "name" : "String" ,
             "child-lock" : "Boolean"
           }
         } ,
         "child-lock" : "Boolean"
       }
    }

    • Access Control

    The following capabilities are required to access this API: CreateDomain