REST Resources
-
/ -
/domains -
/domains /{domain-id} /profiles -
/domains /{domain-id} /profiles /{profile-id} -
/domains /{domain-id} /unassigned-users -
/domains /{domain-id} /users -
/domains /{domain-id} /users /{user-id} -
/domains /{domian-id} /devices -
/domains /{id} -
/domains /{id} /children -
/domains /{id} /children /{id} -
/domains /{id} /delete-domain -
/domains /{id} /export-domain -
/job-instances /{job-id} /assign-devices-job-results -
/job-instances /{job-id} /delete-domain-job-results -
/job-instances /{job-id} /export-domain-data
/api/space/domain-management/domains/{id}
The following operations are supported on this resource:
GET /domains/{id} | Version 1 |
Get a single domain and it's top-level children.
Sample Usage
GET /domains/{id}
- Parameters:
Name Type URI Type Description Required id Integer Path ID Y
- Accept Headers:
application/vnd.net.juniper.space.domain-management.domain+xml;version=1
application/vnd.net.juniper.space.domain-management.domain+json;version=1
<domain href="/api/space/domain-management/domains/1703958" uri="/api/space/domain-management/domains/1703958">
<write-enabled>true</write-enabled>
<id>1703958</id>
<child-count>1</child-count>
<modified-at>Thu Apr 20 2017 07:27 PM UTC</modified-at>
<created-at>Thu Apr 20 2017 07:26 PM UTC</created-at>
<description>test doamin</description>
<name>test</name>
<parent href= "/api/space/domain-management/domains/327689">
<id>327689</id>
<name>Global</name>
</parent>
<children uri="/api/space/domain-management/domains/1703958/children">
<domain href="/api/space/domain-management/domains/1703962"
uri="/api/space/domain-management/domains/1703958/children/1703962">
<id>1703962</id>
<name>child</name>
<child-count>0</child-count>
<created-at>Thu Apr 20 2017 07:26
PM UTC</created-at>
<description>child domain</description>
<write-enabled>true</write-enabled>
<child-lock>true</child-lock>
<no-of-assigned-devices>1</no-of-assigned-devices>
<no-of-assigned-users>1</no-of-assigned-users>
<no-of-assigned-remote-profile>1</no-of-assigned-remote-profile>
</domain>
</children>
<child-lock>true</child-lock>
<domain-type>CUSTOM</domain-type>
<no-of-assigned-devices>1</no-of-assigned-devices>
<no-of-assigned-users>1</no-of-assigned-users>
<no-of-assigned-remote-profile>1</no-of-assigned-remote-profile>
<users href="/api/space/domain-management/domains/1703958/users"/>
<profiles href="/api/space/domain-management/domains/1703958/profiles"/>
<devices href="/api/space/domain-management/domains/1703958/devices"/>
</domain>
{
"domain" : {
"@href" : "/api/space/domain-management/domains/1703958" ,
"@uri" : "/api/space/domain-management/domains/1703958" ,
"write-enabled" : true ,
"id" : 1703958 ,
"child-count" : 1 ,
"modified-at" : "Thu Apr 20 2017 07:27 PM UTC" ,
"created-at" : "Thu Apr 20 2017 07:26 PM UTC" ,
"description" : "test doamin" ,
"name" : "test" ,
"parent": {
"@href": "/api/space/domain-management/domains/327689",
"id": 327689,
"name": "Global"
},
"children" : {
"@uri" : "/api/space/domain-management/domains/1703958/children"
,
"domain" : {
"@href" : "/api/space/domain-management/domains/1703962"
,
"@uri" : "/api/space/domain-management/domains/1703958/children/1703962"
,
"id" : 1703962 ,
"name" : "child" ,
"child-count" : "0" ,
"created-at" : "Thu Apr 20 2017 07:26 PM UTC" ,
"description" : "child domain" ,
"write-enabled" : true ,
"child-lock" : true ,
"no-of-assigned-devices" : 1 ,
"no-of-assigned-users" : 1 ,
"no-of-assigned-remote-profile" : 1
}
} ,
"child-lock" : true ,
"domain-type; : "CUSTOM" ,
"no-of-assigned-devices" : 1 ,
"no-of-assigned-users" : 1 ,
"no-of-assigned-remote-profile" : 1 ,
"users" : {
"@href" : "/api/space/domain-management/domains/1703958/users"
} ,
"profiles" : {
"@href" : "/api/space/domain-management/domains/1703958/profiles"
} ,
"devices" : {
"@href" : "/api/space/domain-management/domains/1703958/devices"
}
}
}
Access Control
The following capabilities are required to access this API: DefaultRead
PUT /domains/{id} | Version 1 |
Update domain attributes.
Sample Usage
PUT /domains/{id}
- Parameters:
Name Type URI Type Description Required domain Integer Path Domain Y
- Content-Type Headers:
application/vnd.net.juniper.space.domain-management.domain+xml;version=1;charset=UTF-8
application/vnd.net.juniper.space.domain-management.domain+json;version=1;charset=UTF-8 - Accept Headers:
application/vnd.net.juniper.space.domain-management.domain+xml;version=1
application/vnd.net.juniper.space.domain-management.domain+json;version=1
<domain>
<name>test</name>
<description>Description for test Domain</description>
<child-lock>false</child-lock>
</domain>
<domain href="/api/space/domain-management/domains/819407" uri="/api/space/domain-management/domains/819407">
<write-enabled>false</write-enabled>
<id>819407</id>
<child-count>1</child-count>
<modified-at>Thu Apr 20 2017 07:26 PM UTC</modified-at>
<created-at>Thu Apr 20 2017 07:27 PM UTC</created-at>
<description>Description for test Domain</description>
<name>test</name>
<parent href= "/api/space/domain-management/domains/32769">
<id>32769</id>
<name>Global</name>
</parent>
<children uri="/api/space/domain-management/domains/819407/children">
<domain href="/api/space/domain-management/domains/819611"
uri="/api/space/domain-management/domains/819407/children/819611">
<child-count>1</child-count>
<write-enabled>false</write-enabled>
<id>819611</id>
<name>child</name>
<modified-at>Thu Apr 20 2017 07:27
PM UTC</modified-at>
<created-at>Thu Apr 20 2017
07:26 PM UTC</created-at>
<description>Description for
child Domain</description>
<child-lock>false</child-lock>
<domain-type>CUSTOM</domain-type>
<no-of-assigned-devices>1</no-of-assigned-devices>
<no-of-assigned-users>1</no-of-assigned-users>
<no-of-assigned-remote-profile>1</no-of-assigned-remote-profile>
</domain>
</children>
<child-lock>false</child-lock>
<domain-type>CUSTOM</domain-type>
<no-of-assigned-devices>1</no-of-assigned-devices>
<no-of-assigned-users>2</no-of-assigned-users>
<no-of-assigned-remote-profile>1</no-of-assigned-remote-profile>
<users href="/api/space/domain-management/domains/819407/users"/>
<profiles href="/api/space/domain-management/domains/819407/profiles"/>
<devices href="/api/space/domain-management/domains/819407/devices"/>
</domain>
{
"domain" : {
"name" : "test" ,
"description" : "Description for test Domain" ,
"child-lock" : false
}
}
{
"domain" : {
"@href" : "/api/space/domain-management/domains/819407" ,
"@uri" : "/api/space/domain-management/domains/819407" ,
"write-enabled" : false ,
"id" : 819407 ,
"child-count" : "1" ,
"modified-at" : "Thu Apr 20 2017 07:26 PM UTC" ,
"created-at" : "Thu Apr 20 2017 07:27 PM UTC" ,
"description" : "Description for test Domain" ,
"name" : "test" ,
"parent": {
"@href": "/api/space/domain-management/domains/32769",
"id": 32769,
"name": "Global"
},
"children" : {
"@uri" : "/api/space/domain-management/domains/819407/children" ,
"domain" : {
"@href" : "/api/space/domain-management/domains/819611"
,
"@uri" : "/api/space/domain-management/domains/819407/children/819611"
,
"child-count" :1 ,
"write-enabled" : false ,
"id" : 819611 ,
"name" : "child" ,
"child-lock" : false ,
"modified-at" : "Thu Apr 20 2017 07:26 PM UTC" ,
"created-at" : "Thu Apr 20 2017 07:27 PM UTC" ,
"description" : "Description for child Domain" ,
"domain-type" : "CUSTOM" ,
"no-of-assigned-devices" : 1 ,
"no-of-assigned-users" : 1 ,
"no-of-assigned-remote-profile" : 1
}
} ,
"child-lock" : false ,
"domain-type" : "CUSTOM" ,
"no-of-assigned-devices" : 1 ,
"no-of-assigned-users" : 2 ,
"no-of-assigned-remote-profile" : 1 ,
"users" : {
"@href" : "/api/space/domain-management/domains/819407/users"
} ,
"profiles" : {
"@href" : "/api/space/domain-management/domains/819407/profiles"
} ,
"devices" : {
"@href" : "/api/space/domain-management/domains/819407/devices"
}
}
}
Access Control
The following capabilities are required to access this API: ModifyDomain
DELETE /domains/{id} | Version 2 |
Delete the domain (Async).
Sample Usage
This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:
DELETE /domains/{id}?queue=<queue>&schedule=<schedule>
Note: The queue URL denoted by <queue> must have been created already.
- Parameters:
Name Type URI Type Description Required id Integer Path ID Y queue Queue URL Query A fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage) N schedule cron-like-expression Query Schedule this API in the future, by specifying a cron-like-expression (See Job Scheduling) N
- Accept Headers:
application/vnd.net.juniper.space.job-management.task+xml;version=1
application/vnd.net.juniper.space.job-management.task+json;version=1
<task href="/api/space/job-management/jobs/688128">
<id>688128</id>
</task>
{
"task":{
"@href" : "/api/space/job-management/jobs/688128",
"id" : 688128
}
}
Access Control
The following capabilities are required to access this API: DeleteDomain