Geo Filtering Policy

Geo Policy Controller

Describe a Geo policy by ID

get/geopolicies/{id}
Request
path Parameters
id
required
integer <int64>
header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Response samples
application/json
{
  • "id": 0,
  • "version": "string",
  • "rule": {
    },
  • "enabled": true
}

Update a Geo policy by ID

put/geopolicies/{id}
Request
path Parameters
id
required
integer <int64>
header Parameters
api-version
required
string

API Version

Value: "v1"
Request Body schema: application/json
enabled
required
boolean
required
object (GeoPolicyRuleInfo)
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Request samples
application/json
{
  • "rule": {
    },
  • "enabled": true
}
Response samples
application/json
{
  • "id": 0,
  • "version": "string",
  • "rule": {
    },
  • "enabled": true
}

Distribute a Geo policy to an appliance

post/geopolicies/{policyId}/appliances/{applianceId}/distribute
Request
path Parameters
applianceId
required
integer <int64>
policyId
required
integer <int64>
header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Response samples
application/json
{
  • "id": 0,
  • "rootJobId": 0,
  • "type": "entry",
  • "state": "pending",
  • "applianceId": 0,
  • "entryVersion": "string",
  • "policyVersion": "string",
  • "completeMessage": "string",
  • "submitted": "2019-08-24T14:15:22Z",
  • "started": "2019-08-24T14:15:22Z",
  • "completed": "2019-08-24T14:15:22Z"
}

List all Geo policies

get/geopolicies
Request
query Parameters
cursor
string
Default: ""
limit
integer <int32>
Default: 10
header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

503

Service Unavailable

Response samples
application/json
{
  • "next": "string",
  • "totalCount": 0,
  • "policies": [
    ]
}