/v1/api/loggingEndpoints/{loggingEndpointId} (GET) - BlueCat DNS Edge

DNS Edge API Guide

Locale
English (United States)
Product name
BlueCat DNS Edge

Returns a logging endpoint by ID.

GET https://api-<DNS.Edge.URL>/v1/api/loggingEndpoints/{loggingEndpointId}
Authorization: Bearer token

Successful response

200 OK
Content-Type: application/JSON
            
{
   "id": "123e4567-e89b-12d3-a456-426614174000",
   "name": "Site Y repository",
   "description": "DNS query data repository for Site Y of Company X",
   "scheme": "https",
   "host": "internal.data-server.com",
   "port": 443,
   "path": "/v1/storage",
   "query": "param=value",
   "serverCertificate": "string",
   "headers": [
     {
       "name": "Authorization",
       "value": "Bearer <token>"
     }
   ],
   "createdAt": 1592566130000,
   "updatedAt": 1592566130000
}
Returns the following information:
  • ID: The ID of the logging endpoint.
  • Name: The name of the logging endpoint.
  • Description: A description of the logging endpoint.
  • Scheme: The protocol of the logging endpoint's URL.
  • Host: The domain, IPv4 address, or IPv6 address of the logging endpoint.
  • Port: The port number of the logging endpoint.
  • Path: The path of the target URL.
  • Query: The query string of the URL.
  • Server certificate: The authentication certificate for accessing the logging endpoint.
  • Headers: The HTTP headers for authenticating the request.
  • Created at: The Unix time (in milliseconds) of when the logging endpoint was created.
  • Updated at: The Unix time (in milliseconds) of when the logging endpoint was updated.

Response on unsuccessful authorization

401 Unauthorized
Content-Type: application/JSON
{"code": "UNAUTHORIZED", "brief": "You are not authorized to perform this action"}
Possible error codes
  • 404 Not Found - No resource was found with the specified ID.
  • 500 Internal Server Error - An internal server error occurred, contact application support.