POST /query/connections

Retrieve connection details for a set of certnames.

Request format

When Forming node inventory API requests to this endpoint, the request body must be a JSON object. At minimum, it must be an empty object ({}), or it can use these keys:

• certnames: An array containing a list of certnames to retrieve from the inventory service database. If omitted, then all connections are returned.
• sensitive: An optional Boolean indicating whether you want the response to include sensitive connection parameters. This parameter has a permission gate, and it doesn't work if you don't have the proper permissions.
• extract: An array of keys indicating the information you want the response to include. The connection_id key is always returned, and you can use extract to limit the remaining keys. For example, ["type"] limits the response to connection_id and type. If omitted, all keys are returned.

Here are some examples of JSON bodies for the /query/connections endpoint.

An empty request body, which returns information for all known connections but does not include sensitive parameters:

{}

A request for connection details for a specific certname:

{
  "certnames": ["mynode1"]
}

A request for a specific certname, specific keys, and sensitive parameters:

{
  "certnames": ["averygood.device"],
  "sensitive": "true",
  "extract": ["certnames", "sensitive_parameters"]
}

Response format

The successful response is the same as the GET /query/connections endpoint.