API docs by Redocly

Data Exporter API (1.0.0)

Download OpenAPI specification:

E-mail: klidston@cisco.com License: Proprietary License

The data export APIs provide capabilities to configure PCA to export metrics data to external systems using Kafka exporters.

createExporter

Create an exporter

Request Body schema: application/json
required
name
required
string

A unique name for this configuration.

clientId
required
string

The client ID of the exporter

bootstrapServers
required
Array of strings

The Kafka bootstrap servers. The servers must be accessible to the PCA deployment.

required
Array of objects (KafkaExporterConsumerGroup)

A list of consumer groups. A consumer group exports data to its export topic. The data it exports is defined by its data subscriptions.

required
object (KafkaExporterHeartbeat)
object (KafkaExporterAuthentication)

Responses

Request samples

Content type
application/json
{
  • "name": "exporter-config-001",
  • "clientId": "test-exporter-config-clientId-001",
  • "bootstrapServers": [
    ],
  • "consumerGroups": [
    ],
  • "heartbeat": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

retrieveExporters

Retrieves all exporters

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

getExporter

Retrieve an exporter

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

updateExporter

Update an exporter

path Parameters
id
required
string
Request Body schema: application/json
required
name
string

A unique name for this configuration.

clientId
string

The client ID of the exporter

bootstrapServers
Array of strings

The Kafka bootstrap servers. The servers must be accessible to the PCA deployment.

Array of objects (KafkaExporterConsumerGroup)

A list of consumer groups. A consumer group exports data to its export topic. The data it exports is defined by its data subscriptions.

object (KafkaExporterHeartbeat)
object (KafkaExporterAuthentication)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "clientId": "string",
  • "bootstrapServers": [
    ],
  • "consumerGroups": [
    ],
  • "heartbeat": {
    },
  • "authentication": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteExporter

Delete an exporter

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "code": 404,
  • "message": "ExporterConsumerConfig not found for id {id}"
}

downloadExporterClientCA

Download an exporters client CA

Responses

Response samples

Content type
text/plain
-----BEGIN CERTIFICATE-----
MIIDXTCCAkWgAwIBAgIJALa3j3mX5j9OMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV
BAYTAkFVMRMwEQYDVQQIDApxdWVlbnNsYW5kMRMwEQYDVQQKDApFeGFtcGxlIElu
YzAeFw0xOTA1MTkxNzI0MjJaFw0yOTA1MTYxNzI0MjJaMEUxCzAJBgNVBAYTAkFV
MRMwEQYDVQQIDApxdWVlbnNsYW5kMRMwEQYDVQQKDApFeGFtcGxlIEluYzCCASIw
DQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANk0+7s6f6b2ZsX4U5r7a5v9R8u8H
...
-----END CERTIFICATE-----