/v1/api/discoveryConfigs (POST) - BlueCat Edge - Service Point v4.x.x

BlueCat Edge User Guide
Locale
English
Product name
BlueCat Edge
Version
Service Point v4.x.x

Creates a new discovery configuration.

POST https://api-<BlueCat.edge.url>/v1/api/discoveryConfigs
Authorization: Bearer authorization token
Content-Type: Application/JSON
{
  "name": "BAM Discovery",
  "pollingInterval": 300,
  "config": {
    "environment": "bam",
    "baseUrl": "http://10.244.14.130",
    "certificate": null,
    "onFailure": "ABANDON",
    "viewConfigs": [
      {
        "configurationName": "BPC",
        "viewName": "Internal",
        "onFailure": "CONTINUE"
      }
    ],
    "username": {
      "type": "edge",
      "secretId": "fbc8f263-3148-4948-a239-40aaf73f3f3b"
    },
    "password": {
      "type": "edge",
      "secretId": "453615aa-6eb9-4a6d-ac55-90b6f4fc9f3b"
    }
  }
}
Body parameters
  • name—the name of the discovery configuration
  • pollingInterval—the interval at which the source of the DNS data is polled. The minimum value is 60 seconds.
  • config—the configuration for the environment that you would like to pull DNS data from. The configuration includes the following:
    • environment—the environment where you would like to retrieve the DNS data. The only supported value is bam for Address Manager.
    • baseUrl—the Address Manager server URL in the following format: <protocol>://<domain>. For example, https://my-bam.com.
    • certificate—the Address Manager server certificate or signing certificate. This field is optional if the protocol in the baseURL is http and Address Manager uses a self-signed certificate.
      Note: The file must be in PEM format.
    • onFailure—determines how the discovery configuration handles failures to retrieve data. The value can be one of the following:
      • ABANDON—the discovery configuration uses the last successfully retrieved set of DNS data.
      • CONTINUE—the discovery configuration overwrites the DNS data from the last successful retrieval.
    • viewConfigs—the information about the DNS view. The configuration includes the following:
      • configurationName—the name of the Address Manager configuration in which the DNS data can be found.
      • viewName—the name of the Address Manager DNS view in which the DNS data can be found.
      • onFailure—determines how the discovery configuration handles failures to retrieve data from this Address Manager configuration and view. The value can be one of the following:
        • ABANDON—the discovery configuration uses the last successfully retrieved set of DNS data.
        • CONTINUE—the discovery configuration overwrites the DNS data from the last successful retrieval.
        Note:
        • The discovery failure options configured per BAM configuration override the discovery option failures configured at the global level.
        • The onFailure field can be omitted from the viewConfigs configuration. If you omit this field, the view configuration uses the discovery option failures configured at the global level.
    • username—the API username used to access the DNS data. The API username includes the following information:
      • type—the type of API username. Currently, the only supported value is edge.
      • secretId—the value of the API user key credential stored in Edge secrets manager.
    • password—the API password used to access the DNS data. The API username includes the following information:
      • type—the type of API password. Currently, the only supported value is edge.
      • secretId—the value of the API password key credential stored in Edge secrets manager.

Successful response

201 CREATED
Possible error codes:
  • BAD REQUEST - Invalid request
  • INTERNAL SERVER ERROR - Unexpected error