/v1/api/loggingEndpoints (POST) - BlueCat Edge - Service Point v3.x.x

BlueCat Edge API Guide
Locale
English
Product name
BlueCat Edge
Version
Service Point v3.x.x

Creates a logging endpoint. 

POST https://api-<BlueCat.edge.url>/v1/api/loggingEndpoints
Authorization: Bearer token
Content-Type: application/json
            
{
  "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>"
    }
  ]
}

Parameters

Name Description Type Required
name The name of the logging endpoint. String Required
description A description of the logging endpoint. String Optional
scheme The protocol of the logging endpoint's URL. The value is either http or https. String Required
host The domain, IPv4 address, or IPv6 address of the logging endpoint. The URL specified must conform to RFC 3986. String Required
port The port number used by the logging endpoint. Integer Required
path The path of the target URL. This parameter contains the leading character "/". For example, "/mypath". String Optional
query The query string of the URL. This parameter does not contain the leading character "?". For example, the correct syntax is "param=value", not "?param=value". String Optional
serverCertificate This is required for logging endpoints that are secured with SSL/TLS certificates. Enter the root certificate for the corresponding certificate authority (root CA) in PEM format.
Note:
  • If you are securing the logging endpoints with private SSL/TLS certificates, upload the private root anchor certificate.
  • If you are using a trusted public root certificate, you do not need to upload any certificate.

BlueCat does not recommend using the server's certificate instead of the trust anchor (root CA) in production systems, as this incurs additional overhead of updating the certificate when it expires and can result in logging downtime.

 String Optional
headers The HTTP headers for authenticating the request. String Optional

Successful response

201 CREATED
Possible error codes
  • 400 Bad Request - JSON is malformed in request body.
  • 401 Unauthorized - Missing or invalid token
  • 403 Forbidden - You are not authorized to perform this action
  • 409 Conflict - A resource with the specified name already exists.
  • 500 Internal Server Error - An internal server error occurred, contact applciation support.