Apoxy
Core API

Cloud Monitoring Integrations

API reference for Cloud Monitoring Integrations (core.apoxy.dev/v1alpha2)

API Group: core.apoxy.dev/v1alpha2

Operations

List Cloud Monitoring Integrations

GET/apis/core.apoxy.dev/v1alpha2/cloudmonitoringintegrations

List CloudMonitoringIntegration

Response

  • 200: OK

Create Cloud Monitoring Integration

POST/apis/core.apoxy.dev/v1alpha2/cloudmonitoringintegrations

Create a CloudMonitoringIntegration

Request Body

Spec fields (CloudMonitoringIntegrationSpec):

FieldTypeDescription
axiomCredentialsAxiomCredentialsAxiomCredentials configures Axiom integration. Only one of DatadogCredentials, GrafanaCredentials, or AxiomCredentials may be specified.
datadogCredentialsDatadogCredentialsDatadogCredentials configures DataDog integration. Only one of DatadogCredentials, GrafanaCredentials, or AxiomCredentials may be specified.
enabledbooleanEnabled indicates whether the monitoring integration is active.
grafanaCredentialsGrafanaCredentialsGrafanaCredentials configures Grafana Cloud integration. Only one of DatadogCredentials, GrafanaCredentials, or AxiomCredentials may be specified.

Response

  • 200: OK
  • 201: Created
  • 202: Accepted

Delete All Cloud Monitoring Integrations

DELETE/apis/core.apoxy.dev/v1alpha2/cloudmonitoringintegrations

Delete collection of CloudMonitoringIntegration

Response

  • 200: OK

Get Cloud Monitoring Integration

GET/apis/core.apoxy.dev/v1alpha2/cloudmonitoringintegrations/{name}

Get the specified CloudMonitoringIntegration

Response

  • 200: OK

Replace Cloud Monitoring Integration

PUT/apis/core.apoxy.dev/v1alpha2/cloudmonitoringintegrations/{name}

Replace the specified CloudMonitoringIntegration

Request Body

Spec fields (CloudMonitoringIntegrationSpec):

FieldTypeDescription
axiomCredentialsAxiomCredentialsAxiomCredentials configures Axiom integration. Only one of DatadogCredentials, GrafanaCredentials, or AxiomCredentials may be specified.
datadogCredentialsDatadogCredentialsDatadogCredentials configures DataDog integration. Only one of DatadogCredentials, GrafanaCredentials, or AxiomCredentials may be specified.
enabledbooleanEnabled indicates whether the monitoring integration is active.
grafanaCredentialsGrafanaCredentialsGrafanaCredentials configures Grafana Cloud integration. Only one of DatadogCredentials, GrafanaCredentials, or AxiomCredentials may be specified.

Response

  • 200: OK
  • 201: Created

Update Cloud Monitoring Integration

PATCH/apis/core.apoxy.dev/v1alpha2/cloudmonitoringintegrations/{name}

Partially update the specified CloudMonitoringIntegration

Response

  • 200: OK
  • 201: Created

Delete Cloud Monitoring Integration

DELETE/apis/core.apoxy.dev/v1alpha2/cloudmonitoringintegrations/{name}

Delete a CloudMonitoringIntegration

Response

  • 200: OK
  • 202: Accepted

Schema Reference

AxiomCredentials

FieldTypeDescription
apiTokenstringAPIToken is the Axiom API token. This field should reference a secret in production environments. (required)
datasetNamestringDatasetName is the name of the Axiom dataset to send data to. (required)
regionstringRegion specifies the Axiom region. Common values: us, eu (required)

DatadogCredentials

FieldTypeDescription
apiKeystringAPIKey is the DataDog API key. This field should reference a secret in production environments. (required)
sitestringSite specifies the DataDog site to send data to. Common values: datadoghq.com, datadoghq.eu, us3.datadoghq.com, us5.datadoghq.com, ddog-gov.com (required)

GrafanaCredentials

FieldTypeDescription
apiKeystringAPIKey is the Grafana Cloud API key. This field should reference a secret in production environments. (required)
endpointstringEndpoint is the OTLP endpoint URL for Grafana Cloud. Example: https://otlp-endpoint-xyz.grafana.net/otlp (required)
instanceIdstringInstanceID is the Grafana Cloud instance identifier. (required)

On this page