/v3/api/sites (PATCH) - BlueCat Edge - Service Point v4.x.x

BlueCat Edge User Guide
Locale
English
Product name
BlueCat Edge
Version
Service Point v4.x.x
Update the DNS resolver service version or logging endpoint configuration of specified sites.
Note: You must disable automatic DNS resolver service updates to update the DNS resolver service versions.
PATCH https://api-<BlueCat.edge.url>/v3/api/sites
Authorization: Bearer token
Content-type: application/JSON
[
    {
        "id": "a16a009e-4790-42b6-9374-b1b18e619d76",
        "version": "3.0.5",
        "blockedServicePointIds": ["7793fcc1-21d9-40d2-a382-3df72276b501", "1233fcc1-4569-40d2-a382-abc2276b502"]
        "streamDataToCI": true,
        "loggingEndpointId": "123e4567-e89b-12d3-a456-426614174000",
        "identityServiceEnabled": true
    },
    ...
]

Parameters

Name Description Type Required
id The ID of the site. String Required
version The updated DNS resolver service version of the site. This value must be a supported DNS resolver service version.
Attention: This parameter must not be included if automatic DNS resolver service updates is enabled.
 String Optional
blockedServicePointIds The service points that were blocked from updating. Remove the ID of service points that were blocked to allow the service point to retry the update. String Optional
streamDataToCI Sends DNS queries from a service point to the BlueCat Edge Cloud console. The default value is true. If the value is false, loggingEndpointId must have a value. Boolean Optional
loggingEndpointId The ID of local logging endpoint. If this parameter does not have a value, the service point will not send DNS queries to a local logging endpoint. String Optional
identityServiceEnabled Indicates whether DNS queries include a mapping of user IDs, in addition to client IP addresses. This information is retrieved by the identity service when Azure Event Hub is configured to use Microsoft Active Directory. This authorization allows requests to extract data from the event logs stored in Azure Event Hub. The default value is false. Boolean Optional

Successful response

204 NO_CONTENT
If you have Edge Service Point v4 instances configured, the response returns a skippedInstances section contains a list of sites and any associated DNS resolver services on Edge Service Point v4 instances that did not successfully update due to version incompatibility. The following displays an example of the response:
200 OK
Content-Type: application/JSON
{
  "skippedInstances": {
    "site-id-1": ["dps-id-1", "dps-id-2"],
    "site-id-2": [...],
    ...
  }
}
Possible error codes
  • UNAUTHORIZED
  • NOT_FOUND
  • BAD_REQUEST
  • FORBIDDEN
  • UNEXPECTED_ERROR