Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation  Back up to About Overview 
ContentIndex
  
[+] Expand All
[-] Collapse All

SDG Groups Management RESTful Web Services

The following operations can be performed using the Edge Services Director SDG Groups Management RESTful Web Services. A service delivery gateway (SDG) device can be combined into a group of devices for easier and streamlined administration.

Create SDG Groups

This request is used to create an SDG group for easier and simplified administration of a large number of SDGs in your network.

URI

/api/sgd/sdgmgmt/sdgGroups/createGroup

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.sdgmgmt.sdgGroups.
createGroup+json;version=1;charset=UTF-8

Consumes

None

Produces

Creates an SDG group

Response Status Code

Message

Description

204 No Content

The server fulfilled the request, but does not need to return a response message body.

Input

Sample JSON Input

{"sdgGroupTO":{"name":"my-sdg-group","description":"my-sdg-group"}}

Delete SDG Groups

This request is used to delete an SDG group.

URI

/api/sgd/sdgmgmt/sdgGroups/deleteGroup

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.sdgmgmt.sdgGroups.
deleteGroup+json;version=1;charset=UTF-8

Consumes

None

Produces

Deletes an SDG group

Response Status Code

Message

Description

204 No Content

The server fulfilled the request, but does not need to return a response message body.

Input

Sample JSON Input

net.juniper.jmp.sgd.management.sdg.groups.SDGGroupMO:46133
 

Get SDG Groups Only

This request is used to collect all the SDG groups that were previously configured.

URI

/api/sgd/sdgmgmt/sdgGroups/getAllSDGGroups

HTTP Method

GET

Content-Type

application/vnd.net.juniper.space.sdgmgmt.sdgGroups.
getAllSDGGroups+json;version=1;charset=UTF-8

Consumes

None

Produces

Set of SDG groups

Response Status Code

Message

Description

200 OK

Successful retrieval of the list of SDG groups.

Output

Sample JSON Output

{ "response" : { "data" : { "MOID" : "net.juniper.jmp.sgd.management.sdg.groups.jpa.SDGGroupEntity:32768",
          "createdTime" : "2014-11-17T14:12:11+05:30",
          "description" : "Default Service Gateway Group for ESD",
          "isDefault" : true,
          "modifiedTime" : "2014-11-17T14:12:11+05:30",
          "name" : "Default-Group"
        },
      "schemaName" : "SDGGroupTO",
      "success" : true,
      "totalRows" : 1
    } }

Get SDG Groups With Statistics

This request is used to collect all the SDG groups with statistics.

URI

/api/sgd/sdgmgmt/sdgGroups/sdggroupsstatistics

HTTP Method

GET

Content-Type

application/vnd.net.juniper.space.sdgmgmt.sdgGroups.
sdggroupsstatistics+json;version=1;charset=UTF-8

Consumes

None

Produces

Set of SDG groups with statistics

Response Status Code

Message

Description

200 OK

Successful retrieval of the list of SDG groups with statistics.

Output

Sample JSON Output

[ { "SGDStatisticTO" : { "data" : 1,
        "name" : "Default-Group"
      } } ]

Get SDG Groups By Name

This request is used to collect a particular SDG group based on its name.

URI

/api/sgd/sdgmgmt/sdgGroups/getSDGGroupsByname/{SDGGroupName}

HTTP Method

GET

Content-Type

application/vnd.net.juniper.space.sdgmgmt.sdgGroups.
getSDGGroupsByname.{SDGGroupName}+json;version=1;charset=UTF-8

Consumes

None

Produces

An SDG group

Response Status Code

Message

Description

200 OK

Successful retrieval of a specific SDG group

Output

Sample JSON Output

{ "sdgGroupTO" : { "MOID" : "net.juniper.jmp.sgd.management.sdg.groups.jpa.SDGGroupEntity:38714",
      "createdBy" : "super",
      "createdTime" : "2014-11-19T13:31:26+05:30",
      "description" : "TestGrp",
      "isDefault" : false,
      "modifiedBy" : "super",
      "modifiedTime" : "2014-11-19T13:31:26+05:30",
      "name" : "TestGrp"
    } }

Modified: 2016-08-02