Exceptions (Geolocation)

Retrieves the specified Geolocation exception.

get/v1/configuration/{accountid}/exceptions/geolocation/{objectid}

Request

Base URL
https://api.usa.cloud.watchguard.com/rest/firecloud/management
Auth
API key in header WatchGuard-API-Key and HTTP bearer
TypeScript
https://skmtc.dev/watchguard/apis/firecloud-management-api/docs/v1/configuration/:accountid/exceptions/geolocation/:objectid/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

objectidstring required

ID of the Geolocation exception to retrieve.

Response

The Geolocation exception object.

idstring required

Unique ID that identifies this object.

objectstring required

Type of object.

versioninteger required

Version number of the object.

accountstring required

Your WatchGuard Cloud account ID.

createdinteger required

Time that the object was created, specified in Unix epoch time format.

device'firewan' required

Device this object applies to.

authorstring required

Author of the object. This is always empty for objects added or updated with the FireCloud Management API.

descriptionstring

Specifies the description of the Geolocation exception. Maximum: 127 characters.

action'allow'

Specifies the action to take for the specified address.

Example response

{
  "id": "geoe_12345_aHbWC5IuWO3qzyV2t",
  "object": "geolocation_exception",
  "version": 1,
  "account": "WGC-1-123abc456",
  "created": 1579907960,
  "device": "firewan",
  "author": "jsmith",
  "description": "Allow example.com",
  "address": {
    "type": "fqdn",
    "value": "example.com"
  },
  "action": "allow"
}

Changes

No recorded changes to this operation across all 1 revision of this API.