Policy Enforcer

REST API for policy enforcer
Contact Info: JTAC@juniper.net
Version: 1
BasePath:/api/v1/controller
Copyright 2016, Juniper Networks, Inc.
www.juniper.net

Access

Methods

[ Jump to Models ]

Table of Contents

Default

Default

Up
delete /customFeeds/{feedType}/param/{inputType}/{name}
(customFeedsFeedTypeParamInputTypeNameDelete)
Delete CustomFeed

Path parameters

feedType (required)
Path Parameter — Custom feed type
name (required)
Path Parameter — Custom feed object name
inputType (required)
Path Parameter — Custom feed content type, can include ip, url, domain

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

CustomFeed deleted

Up
get /customFeeds/{feedType}/param/{inputType}/{name}
(customFeedsFeedTypeParamInputTypeNameGet)
Specific CustomFeed based on CustomFeed Id

Path parameters

feedType (required)
Path Parameter — Custom feed type
name (required)
Path Parameter — Custom feed object name
inputType (required)
Path Parameter — Custom feed content type, can include ip, url, domain

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

customFeed

Example data

Content-Type: application/json
{
  "domian" : "aeiou",
  "feedType" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "id" : "aeiou",
  "content" : [ "aeiou" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Specific CustomFeed customFeed

500

Unexpected error

Up
post /customFeeds/{feedType}/param/{inputType}/{name}
(customFeedsFeedTypeParamInputTypeNamePost)
Creates a new CustomFeed

Path parameters

feedType (required)
Path Parameter — Custom feed type
name (required)
Path Parameter — Custom feed object name
inputType (required)
Path Parameter — Custom feed content type, can include ip, url, domain

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

customFeed CustomFeed (required)
Body Parameter — Custom feed object

Return type

customFeed

Example data

Content-Type: application/json
{
  "domian" : "aeiou",
  "feedType" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "id" : "aeiou",
  "content" : [ "aeiou" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Custom feed added customFeed

400

Bad request

500

Unexpected error

Up
put /customFeeds/{feedType}/param/{inputType}/{name}
(customFeedsFeedTypeParamInputTypeNamePut)
Update CustomFeed

Path parameters

feedType (required)
Path Parameter — Custom feed type
name (required)
Path Parameter — Custom feed object name
inputType (required)
Path Parameter — Custom feed content type, can include ip, url, domain

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

customFeed CustomFeed (required)
Body Parameter — updated CustomFeed

Return type

customFeed

Example data

Content-Type: application/json
{
  "domian" : "aeiou",
  "feedType" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "id" : "aeiou",
  "content" : [ "aeiou" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

CustomFeed updated customFeed

400

Bad request

500

Unexpected error

Up
get /customFeeds/param
(customFeedsParamGet)
The list of Custom Feeds.

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

customFeeds

Example data

Content-Type: application/json
{
  "total" : "",
  "uri" : "aeiou",
  "threatPolicy" : [ {
    "domian" : "aeiou",
    "feedType" : "aeiou",
    "name" : "aeiou",
    "description" : "aeiou",
    "id" : "aeiou",
    "content" : [ "aeiou" ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

An array of custom feed objects customFeeds

500

Unexpected error

Up
delete /feedSources/{feedSourceId}
(feedSourcesFeedSourceIdDelete)
Delete feed source

Path parameters

feedSourceId (required)
Path Parameter — UUID of feed source format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

feed source deleted

Up
put /feedSources/{feedSourceId}/devices
(feedSourcesFeedSourceIdDevicesPut)
Associate or dis-associate devices with feed source, it is used for "SkyATP" mode only

Path parameters

feedSourceId (required)
Path Parameter — UUID of feed source format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

devices Devices (required)
Body Parameter — list of devices to assiciate or dis-associate with feed source

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No content

400

Bad request

500

Unexpected error

Up
get /feedSources/{feedSourceId}
(feedSourcesFeedSourceIdGet)
Specific Feed Sources based on feedSourceId

Path parameters

feedSourceId (required)
Path Parameter — UUID of feed source format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

feedSource

Example data

Content-Type: application/json
{
  "authMode" : "aeiou",
  "domain" : "aeiou",
  "name" : "aeiou",
  "id" : "aeiou",
  "region" : "aeiou",
  "feedSourceType" : "aeiou",
  "feedSourceUrl" : "aeiou",
  "uri" : "aeiou",
  "token" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Specific feed source feedSource

500

Unexpected error

Up
put /feedSources/{feedSourceId}
(feedSourcesFeedSourceIdPut)
Update feed source

Path parameters

feedSourceId (required)
Path Parameter — UUID of feed source format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

feedSource FeedSource (required)
Body Parameter — updated feed source

Return type

feedSource

Example data

Content-Type: application/json
{
  "authMode" : "aeiou",
  "domain" : "aeiou",
  "name" : "aeiou",
  "id" : "aeiou",
  "region" : "aeiou",
  "feedSourceType" : "aeiou",
  "feedSourceUrl" : "aeiou",
  "uri" : "aeiou",
  "token" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

feed source updated feedSource

400

Bad request

500

Unexpected error

Up
get /feedSources
(feedSourcesGet)
The Feed Sources from where Policy Enforcer get Feeds. One of the feed source is SkyATP. SkyATP supports mnay realms, each Feed Source in PE corresonds to one SkyATP realm.

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

feedSources

Example data

Content-Type: application/json
{
  "total" : "",
  "feedSource" : [ {
    "authMode" : "aeiou",
    "domain" : "aeiou",
    "name" : "aeiou",
    "id" : "aeiou",
    "region" : "aeiou",
    "feedSourceType" : "aeiou",
    "feedSourceUrl" : "aeiou",
    "uri" : "aeiou",
    "token" : "aeiou"
  } ],
  "uri" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

An array of Feed Sources feedSources

500

Unexpected error

Up
post /feedSources
(feedSourcesPost)
Creates a new feed source

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

feedSource FeedSource (required)
Body Parameter — feed source to add

Return type

feedSource

Example data

Content-Type: application/json
{
  "authMode" : "aeiou",
  "domain" : "aeiou",
  "name" : "aeiou",
  "id" : "aeiou",
  "region" : "aeiou",
  "feedSourceType" : "aeiou",
  "feedSourceUrl" : "aeiou",
  "uri" : "aeiou",
  "token" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

feed source added feedSource

400

Bad request

500

Unexpected error

Up
delete /geoIps/{geoIpId}
(geoIpsGeoIpIdDelete)
Delete GeoIP

Path parameters

geoIpId (required)
Path Parameter — UUID of GeoIP format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

GeoIP deleted

Up
get /geoIps/{geoIpId}
(geoIpsGeoIpIdGet)
Specific GeoIP based on geoIpId

Path parameters

geoIpId (required)
Path Parameter — UUID of GeoIP format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

geoIp

Example data

Content-Type: application/json
{
  "domian" : "aeiou",
  "name" : "aeiou",
  "action" : "aeiou",
  "id" : "aeiou",
  "countrys" : [ "aeiou" ],
  "policyGroups" : [ {
    "groupType" : "aeiou",
    "addressGroups" : [ "aeiou" ],
    "domian" : "aeiou",
    "name" : "aeiou",
    "sites" : [ {
      "devices" : [ {
        "serialNumber" : "aeiou",
        "role" : "aeiou",
        "emsId" : "aeiou",
        "emsSdId" : "aeiou",
        "ip" : "aeiou",
        "name" : "aeiou",
        "model" : "aeiou",
        "id" : "aeiou"
      } ],
      "domian" : "aeiou",
      "name" : "aeiou",
      "id" : "aeiou"
    } ],
    "id" : "aeiou"
  } ],
  "deployStatus" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Specific GeoIP geoIp

500

Unexpected error

Up
put /geoIps/{geoIpId}
(geoIpsGeoIpIdPut)
Update GeoIP

Path parameters

geoIpId (required)
Path Parameter — UUID of GeoIP format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

geoIp GeoIp (required)
Body Parameter — updated GeoIP

Return type

geoIp

Example data

Content-Type: application/json
{
  "domian" : "aeiou",
  "name" : "aeiou",
  "action" : "aeiou",
  "id" : "aeiou",
  "countrys" : [ "aeiou" ],
  "policyGroups" : [ {
    "groupType" : "aeiou",
    "addressGroups" : [ "aeiou" ],
    "domian" : "aeiou",
    "name" : "aeiou",
    "sites" : [ {
      "devices" : [ {
        "serialNumber" : "aeiou",
        "role" : "aeiou",
        "emsId" : "aeiou",
        "emsSdId" : "aeiou",
        "ip" : "aeiou",
        "name" : "aeiou",
        "model" : "aeiou",
        "id" : "aeiou"
      } ],
      "domian" : "aeiou",
      "name" : "aeiou",
      "id" : "aeiou"
    } ],
    "id" : "aeiou"
  } ],
  "deployStatus" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

GeoIP updated geoIp

400

Bad request

500

Unexpected error

Up
get /geoIps
(geoIpsGet)
The list of GeoIps.

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

geoIps

Example data

Content-Type: application/json
{
  "total" : "",
  "uri" : "aeiou",
  "threatPolicy" : [ {
    "domian" : "aeiou",
    "name" : "aeiou",
    "action" : "aeiou",
    "id" : "aeiou",
    "countrys" : [ "aeiou" ],
    "policyGroups" : [ {
      "groupType" : "aeiou",
      "addressGroups" : [ "aeiou" ],
      "domian" : "aeiou",
      "name" : "aeiou",
      "sites" : [ {
        "devices" : [ {
          "serialNumber" : "aeiou",
          "role" : "aeiou",
          "emsId" : "aeiou",
          "emsSdId" : "aeiou",
          "ip" : "aeiou",
          "name" : "aeiou",
          "model" : "aeiou",
          "id" : "aeiou"
        } ],
        "domian" : "aeiou",
        "name" : "aeiou",
        "id" : "aeiou"
      } ],
      "id" : "aeiou"
    } ],
    "deployStatus" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

An array of GeoIps geoIps

500

Unexpected error

Up
post /geoIps
(geoIpsPost)
Creates a new GeoIP

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

geoIp GeoIp (required)
Body Parameter — GeoIP

Return type

geoIp

Example data

Content-Type: application/json
{
  "domian" : "aeiou",
  "name" : "aeiou",
  "action" : "aeiou",
  "id" : "aeiou",
  "countrys" : [ "aeiou" ],
  "policyGroups" : [ {
    "groupType" : "aeiou",
    "addressGroups" : [ "aeiou" ],
    "domian" : "aeiou",
    "name" : "aeiou",
    "sites" : [ {
      "devices" : [ {
        "serialNumber" : "aeiou",
        "role" : "aeiou",
        "emsId" : "aeiou",
        "emsSdId" : "aeiou",
        "ip" : "aeiou",
        "name" : "aeiou",
        "model" : "aeiou",
        "id" : "aeiou"
      } ],
      "domian" : "aeiou",
      "name" : "aeiou",
      "id" : "aeiou"
    } ],
    "id" : "aeiou"
  } ],
  "deployStatus" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

GeoIP added geoIp

400

Bad request

500

Unexpected error

Up
get /logs
(logsGet)
Get all log files in zip format.

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Zipped content of all log files

500

Unexpected error

Up
get /policyGroups
(policyGroupsGet)
The list of policy enforcement groups. Each group can consist of location (site) or end host IP blocks.

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

policyGroups

Example data

Content-Type: application/json
{
  "total" : "",
  "policyGroup" : [ {
    "groupType" : "aeiou",
    "addressGroups" : [ "aeiou" ],
    "domian" : "aeiou",
    "name" : "aeiou",
    "sites" : [ {
      "devices" : [ {
        "serialNumber" : "aeiou",
        "role" : "aeiou",
        "emsId" : "aeiou",
        "emsSdId" : "aeiou",
        "ip" : "aeiou",
        "name" : "aeiou",
        "model" : "aeiou",
        "id" : "aeiou"
      } ],
      "domian" : "aeiou",
      "name" : "aeiou",
      "id" : "aeiou"
    } ],
    "id" : "aeiou"
  } ],
  "uri" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

An array of Policy Enforcement Groups policyGroups

500

Unexpected error

Up
delete /policyGroups/{policyGroupId}
(policyGroupsPolicyGroupIdDelete)
Delete policy enforcement group

Path parameters

policyGroupId (required)
Path Parameter — UUID of PEG format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

PEG deleted

Up
get /policyGroups/{policyGroupId}
(policyGroupsPolicyGroupIdGet)
Specific PEG (policy enforcement group) based on policyGroupId

Path parameters

policyGroupId (required)
Path Parameter — UUID of Policy Enforcement Group format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

policyGroup

Example data

Content-Type: application/json
{
  "groupType" : "aeiou",
  "addressGroups" : [ "aeiou" ],
  "domian" : "aeiou",
  "name" : "aeiou",
  "sites" : [ {
    "devices" : [ {
      "serialNumber" : "aeiou",
      "role" : "aeiou",
      "emsId" : "aeiou",
      "emsSdId" : "aeiou",
      "ip" : "aeiou",
      "name" : "aeiou",
      "model" : "aeiou",
      "id" : "aeiou"
    } ],
    "domian" : "aeiou",
    "name" : "aeiou",
    "id" : "aeiou"
  } ],
  "id" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Specific PEG policyGroup

500

Unexpected error

Up
put /policyGroups/{policyGroupId}
(policyGroupsPolicyGroupIdPut)
Update PEG

Path parameters

policyGroupId (required)
Path Parameter — UUID of PEG format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

policyGroup PolicyGroup (required)
Body Parameter — updated PEG

Return type

policyGroup

Example data

Content-Type: application/json
{
  "groupType" : "aeiou",
  "addressGroups" : [ "aeiou" ],
  "domian" : "aeiou",
  "name" : "aeiou",
  "sites" : [ {
    "devices" : [ {
      "serialNumber" : "aeiou",
      "role" : "aeiou",
      "emsId" : "aeiou",
      "emsSdId" : "aeiou",
      "ip" : "aeiou",
      "name" : "aeiou",
      "model" : "aeiou",
      "id" : "aeiou"
    } ],
    "domian" : "aeiou",
    "name" : "aeiou",
    "id" : "aeiou"
  } ],
  "id" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

PEG updated policyGroup

400

Bad request

500

Unexpected error

Up
post /policyGroups
(policyGroupsPost)
Creates a new Policy Enforcement Group

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

policyGroup PolicyGroup (required)
Body Parameter — policy enforcement group to add

Return type

site

Example data

Content-Type: application/json
{
  "devices" : [ {
    "serialNumber" : "aeiou",
    "role" : "aeiou",
    "emsId" : "aeiou",
    "emsSdId" : "aeiou",
    "ip" : "aeiou",
    "name" : "aeiou",
    "model" : "aeiou",
    "id" : "aeiou"
  } ],
  "domian" : "aeiou",
  "name" : "aeiou",
  "id" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

site added site

400

Bad request

500

Unexpected error

Up
get /sites
(sitesGet)
The Secure Fabric Sites, which contain SRX and switching devices

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

sites

Example data

Content-Type: application/json
{
  "total" : "",
  "site" : [ {
    "devices" : [ {
      "serialNumber" : "aeiou",
      "role" : "aeiou",
      "emsId" : "aeiou",
      "emsSdId" : "aeiou",
      "ip" : "aeiou",
      "name" : "aeiou",
      "model" : "aeiou",
      "id" : "aeiou"
    } ],
    "domian" : "aeiou",
    "name" : "aeiou",
    "id" : "aeiou"
  } ],
  "uri" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

An array of sites sites

500

Unexpected error

Up
post /sites
(sitesPost)
Creates a new site

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

site Site (required)
Body Parameter — site to add

Return type

site

Example data

Content-Type: application/json
{
  "devices" : [ {
    "serialNumber" : "aeiou",
    "role" : "aeiou",
    "emsId" : "aeiou",
    "emsSdId" : "aeiou",
    "ip" : "aeiou",
    "name" : "aeiou",
    "model" : "aeiou",
    "id" : "aeiou"
  } ],
  "domian" : "aeiou",
  "name" : "aeiou",
  "id" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

site added site

400

Bad request

500

Unexpected error

Up
delete /sites/{siteId}
(sitesSiteIdDelete)
Delete site

Path parameters

siteId (required)
Path Parameter — UUID of site format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

site deleted

Up
get /sites/{siteId}
(sitesSiteIdGet)
Specific site based on siteId

Path parameters

siteId (required)
Path Parameter — UUID of site format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

site

Example data

Content-Type: application/json
{
  "devices" : [ {
    "serialNumber" : "aeiou",
    "role" : "aeiou",
    "emsId" : "aeiou",
    "emsSdId" : "aeiou",
    "ip" : "aeiou",
    "name" : "aeiou",
    "model" : "aeiou",
    "id" : "aeiou"
  } ],
  "domian" : "aeiou",
  "name" : "aeiou",
  "id" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Specific site site

500

Unexpected error

Up
put /sites/{siteId}
(sitesSiteIdPut)
Update site

Path parameters

siteId (required)
Path Parameter — UUID of site format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

site Site (required)
Body Parameter — updated site

Return type

site

Example data

Content-Type: application/json
{
  "devices" : [ {
    "serialNumber" : "aeiou",
    "role" : "aeiou",
    "emsId" : "aeiou",
    "emsSdId" : "aeiou",
    "ip" : "aeiou",
    "name" : "aeiou",
    "model" : "aeiou",
    "id" : "aeiou"
  } ],
  "domian" : "aeiou",
  "name" : "aeiou",
  "id" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

site updated site

400

Bad request

500

Unexpected error

Up
get /threatPolicys
(threatPolicysGet)
The list of threat Policies.

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

threatPolicys

Example data

Content-Type: application/json
{
  "total" : "",
  "uri" : "aeiou",
  "threatPolicy" : [ {
    "secondaryActions" : [ "aeiou" ],
    "domian" : "aeiou",
    "name" : "aeiou",
    "profiles" : [ {
      "malwareProfileName" : "aeiou",
      "feedType" : "aeiou",
      "domian" : "aeiou",
      "name" : "aeiou",
      "id" : "aeiou",
      "https" : true,
      "actions" : [ {
        "threatLevelEnd" : "",
        "redirectUrl" : "aeiou",
        "action" : "aeiou",
        "threatLevelStart" : "",
        "quarantineVlanName" : "aeiou",
        "cusomMessage" : "aeiou"
      } ],
      "attachmentProfileName" : "aeiou"
    } ],
    "id" : "aeiou",
    "skipDevices" : [ "" ],
    "deployDevices" : [ "" ],
    "policyGroups" : [ {
      "groupType" : "aeiou",
      "addressGroups" : [ "aeiou" ],
      "domian" : "aeiou",
      "name" : "aeiou",
      "sites" : [ {
        "devices" : [ {
          "serialNumber" : "aeiou",
          "role" : "aeiou",
          "emsId" : "aeiou",
          "emsSdId" : "aeiou",
          "ip" : "aeiou",
          "name" : "aeiou",
          "model" : "aeiou",
          "id" : "aeiou"
        } ],
        "domian" : "aeiou",
        "name" : "aeiou",
        "id" : "aeiou"
      } ],
      "id" : "aeiou"
    } ],
    "deployStatus" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

An array of Policies threatPolicys

500

Unexpected error

Up
post /threatPolicys
(threatPolicysPost)
Creates a new Threat Policy

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

threatPolicy ThreatPolicy (required)
Body Parameter — Threat policy

Return type

threatPolicy

Example data

Content-Type: application/json
{
  "secondaryActions" : [ "aeiou" ],
  "domian" : "aeiou",
  "name" : "aeiou",
  "profiles" : [ {
    "malwareProfileName" : "aeiou",
    "feedType" : "aeiou",
    "domian" : "aeiou",
    "name" : "aeiou",
    "id" : "aeiou",
    "https" : true,
    "actions" : [ {
      "threatLevelEnd" : "",
      "redirectUrl" : "aeiou",
      "action" : "aeiou",
      "threatLevelStart" : "",
      "quarantineVlanName" : "aeiou",
      "cusomMessage" : "aeiou"
    } ],
    "attachmentProfileName" : "aeiou"
  } ],
  "id" : "aeiou",
  "skipDevices" : [ "" ],
  "deployDevices" : [ "" ],
  "policyGroups" : [ {
    "groupType" : "aeiou",
    "addressGroups" : [ "aeiou" ],
    "domian" : "aeiou",
    "name" : "aeiou",
    "sites" : [ {
      "devices" : [ {
        "serialNumber" : "aeiou",
        "role" : "aeiou",
        "emsId" : "aeiou",
        "emsSdId" : "aeiou",
        "ip" : "aeiou",
        "name" : "aeiou",
        "model" : "aeiou",
        "id" : "aeiou"
      } ],
      "domian" : "aeiou",
      "name" : "aeiou",
      "id" : "aeiou"
    } ],
    "id" : "aeiou"
  } ],
  "deployStatus" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

policy added threatPolicy

400

Bad request

500

Unexpected error

Up
delete /threatPolicys/{threatPolicyId}
(threatPolicysThreatPolicyIdDelete)
Delete policy

Path parameters

threatPolicyId (required)
Path Parameter — UUID of policy format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

policy deleted

Up
get /threatPolicys/{threatPolicyId}
(threatPolicysThreatPolicyIdGet)
Specific threat policy based on threatPolicyId

Path parameters

threatPolicyId (required)
Path Parameter — UUID of Policy format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

threatPolicy

Example data

Content-Type: application/json
{
  "secondaryActions" : [ "aeiou" ],
  "domian" : "aeiou",
  "name" : "aeiou",
  "profiles" : [ {
    "malwareProfileName" : "aeiou",
    "feedType" : "aeiou",
    "domian" : "aeiou",
    "name" : "aeiou",
    "id" : "aeiou",
    "https" : true,
    "actions" : [ {
      "threatLevelEnd" : "",
      "redirectUrl" : "aeiou",
      "action" : "aeiou",
      "threatLevelStart" : "",
      "quarantineVlanName" : "aeiou",
      "cusomMessage" : "aeiou"
    } ],
    "attachmentProfileName" : "aeiou"
  } ],
  "id" : "aeiou",
  "skipDevices" : [ "" ],
  "deployDevices" : [ "" ],
  "policyGroups" : [ {
    "groupType" : "aeiou",
    "addressGroups" : [ "aeiou" ],
    "domian" : "aeiou",
    "name" : "aeiou",
    "sites" : [ {
      "devices" : [ {
        "serialNumber" : "aeiou",
        "role" : "aeiou",
        "emsId" : "aeiou",
        "emsSdId" : "aeiou",
        "ip" : "aeiou",
        "name" : "aeiou",
        "model" : "aeiou",
        "id" : "aeiou"
      } ],
      "domian" : "aeiou",
      "name" : "aeiou",
      "id" : "aeiou"
    } ],
    "id" : "aeiou"
  } ],
  "deployStatus" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Specific threatPolicy threatPolicy

500

Unexpected error

Up
put /threatPolicys/{threatPolicyId}
(threatPolicysThreatPolicyIdPut)
Update threat policy

Path parameters

threatPolicyId (required)
Path Parameter — UUID of Policy format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

threatPolicy ThreatPolicy (required)
Body Parameter — updated policy

Return type

threatPolicy

Example data

Content-Type: application/json
{
  "secondaryActions" : [ "aeiou" ],
  "domian" : "aeiou",
  "name" : "aeiou",
  "profiles" : [ {
    "malwareProfileName" : "aeiou",
    "feedType" : "aeiou",
    "domian" : "aeiou",
    "name" : "aeiou",
    "id" : "aeiou",
    "https" : true,
    "actions" : [ {
      "threatLevelEnd" : "",
      "redirectUrl" : "aeiou",
      "action" : "aeiou",
      "threatLevelStart" : "",
      "quarantineVlanName" : "aeiou",
      "cusomMessage" : "aeiou"
    } ],
    "attachmentProfileName" : "aeiou"
  } ],
  "id" : "aeiou",
  "skipDevices" : [ "" ],
  "deployDevices" : [ "" ],
  "policyGroups" : [ {
    "groupType" : "aeiou",
    "addressGroups" : [ "aeiou" ],
    "domian" : "aeiou",
    "name" : "aeiou",
    "sites" : [ {
      "devices" : [ {
        "serialNumber" : "aeiou",
        "role" : "aeiou",
        "emsId" : "aeiou",
        "emsSdId" : "aeiou",
        "ip" : "aeiou",
        "name" : "aeiou",
        "model" : "aeiou",
        "id" : "aeiou"
      } ],
      "domian" : "aeiou",
      "name" : "aeiou",
      "id" : "aeiou"
    } ],
    "id" : "aeiou"
  } ],
  "deployStatus" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Threat policy updated threatPolicy

400

Bad request

500

Unexpected error

Up

Models

[ Jump to Methods ]

Table of Contents

  1. action
  2. customFeed
  3. customFeeds
  4. device
  5. devices
  6. feedProfile
  7. feedSource
  8. feedSources
  9. geoIp
  10. geoIps
  11. policyGroup
  12. policyGroups
  13. site
  14. sites
  15. threatPolicy
  16. threatPolicys

action - Up

threatLevelStart (optional)
threatLevelEnd (optional)
action (optional)
Enum:
PERMIT
LOG
BLOCK_DROP
BLOCK_CLOSE
BLOCK_QUARANTINE
redirectUrl (optional)
String used only when action BLOCK_CLOSE
cusomMessage (optional)
String used only when action BLOCK_CLOSE
quarantineVlanName (optional)
String used only when action BLOCK_QUARANTINE

customFeed - Up

id (optional)
String Custom feed id generated by PE, ignored for POST
name
String CustomFeed name
domian (optional)
String For future use
description (optional)
feedType (optional)
Enum:
Blacklist
Whitelist
Dynamic-Address
content (optional)
array[String] list of 1. IP, IP range, Subnet, 2. URLs, 3. Doamin

customFeeds - Up

uri (optional)
String URI of object.
total (optional)
Integer Number of records.
threatPolicy (optional)
array[customFeed] List of CustomFeeds.

device - Up

id (optional)
String device id generated by PE, ignored for POST
name
String device name
emsId
String Element Management System Id, example - junos space device id
emsSdId (optional)
String Security Director device id
serialNumber
String device serial number
model
String device model
ip (optional)
String device management IP
role (optional)
String device role, for Non-SDSN this value is always EDGE_FIREWALL
Enum:
EDGE_FIREWALL
AGGREGATION_FIREWALL
CORE_SWITCH
ACCESS_SWITCH

devices - Up

enroll (optional)
array[device] List of devices to be enrolled
disEnroll (optional)
array[device] List of devices to be dis-enrolled

feedProfile - Up

id (optional)
String for future use
feedType
Enum:
CnC
INFECTED_HOST
MALWARE
SMTP
name (optional)
String for future use
domian (optional)
String For future use
malwareProfileName (optional)
attachmentProfileName (optional)
https (optional)
actions
array[action] List of actions, for each profile there could be more than one actions

feedSource - Up

id (optional)
String feed source id generated by, ignored for POST
name
String feed source name (SkyATP user name)
domain
String feed source domain (SkyATP realm name)
feedSourceType
String feed source type, example - skyatp
authMode
String authentication mode
Enum:
token
token (optional)
String authentication token
region (optional)
String geographic region
feedSourceUrl
String Url of feed source. SkyAtp example - https://amer.sky.junipersecurity.net/
uri (optional)
String URI of feed source

feedSources - Up

uri (optional)
String URI of object.
total (optional)
Integer Number of records.
feedSource (optional)
array[feedSource] List of feed sources.

geoIp - Up

id (optional)
String GeoIp id generated by PE, ignored for POST
name
String GeoIP name
domian (optional)
String For future use
countrys (optional)
policyGroups (optional)
array[policyGroup] List of policy groups, each object should contain id and name, complete policy group object is not required.
action (optional)
Enum:
BLOCK_INBOUND
BLOCK_OUTBOUND
BLOCK_BOTH
deployStatus (optional)
Enum:
DRAFT
VIEW_ANALYSIS
UPDATING
UPDATED
UPDATE_FAILED

geoIps - Up

uri (optional)
String URI of object.
total (optional)
Integer Number of records.
threatPolicy (optional)
array[geoIp] List of GeoIPs.

policyGroup - Up

id (optional)
String policy group id generated by PE, ignored for POST
name
String policy group name
domian (optional)
String For future use
groupType (optional)
Enum:
IP
LOCATION
addressGroups (optional)
array[String] List of IP Address, IP Address range and or Subnet. Example - ["1.2.3.4/24", "2.3.4.1-2.3.4.256", "3.4.5.6"]
sites (optional)
array[site] List of sites, each site object should contain id and name, complete site object is not required.

policyGroups - Up

uri (optional)
String URI of object.
total (optional)
Integer Number of records.
policyGroup (optional)
array[policyGroup] List of policyGroups.

site - Up

id (optional)
String site id generated by PE, ignored for POST
name
String site name
domian (optional)
String For future use
devices (optional)
array[device] List of devices part of Secure Fabric Site

sites - Up

uri (optional)
String URI of object.
total (optional)
Integer Number of records.
site (optional)
array[site] List of sites.

threatPolicy - Up

id (optional)
String threat policy id generated by PE, ignored for POST
name
String threat policy name
domian (optional)
String For future use
policyGroups (optional)
array[policyGroup] List of policy groups, each object should contain id and name, complete policy group object is not required.
profiles (optional)
secondaryActions (optional)
Enum:
deployStatus (optional)
Enum:
DRAFT
VIEW_ANALYSIS
UPDATING
UPDATED
UPDATE_FAILED
deployDevices (optional)
array[device] list of devices on which policy would be deployed
skipDevices (optional)
array[device] list of devices on which policy would not be deployed. If policy have profile INFECTED_HOST and or MALWARE, then depending on device capability, policy would not be deployed on some devices, example - srx-550, srx-650.

threatPolicys - Up

uri (optional)
String URI of object.
total (optional)
Integer Number of records.
threatPolicy (optional)
array[threatPolicy] List of policys.