---
title: "GET /apis/kalix.io/v1beta1/namespaces/{projectId}/kalixobservabilities/{name}"
method: GET
path: "/apis/kalix.io/v1beta1/namespaces/{projectId}/kalixobservabilities/{name}"
tags: ["AkkaControlPlane"]
---

# GET /apis/kalix.io/v1beta1/namespaces/{projectId}/kalixobservabilities/{name}

`GET /apis/kalix.io/v1beta1/namespaces/{projectId}/kalixobservabilities/{name}`

## Request

- The document declares no server URL.
- Auth: none declared
- TypeScript: <https://skmtc.dev/akka/apis/akka-control-plane-api/docs/apis/kalix.io/v1beta1/namespaces/:projectId/kalixobservabilities/:name/get.ts> (a function with typed inputs; its response is checked against the schema)

read the specified Observability

## Response `200`

OK

- Observability: KalixObservability is the Schema for the kalixobservabilities API (v1beta1). This version supports multiple exporters per signal type (traces, metrics, logs).
  - `status` ObservabilityStatus: KalixObservabilityStatus defines the observed state of KalixObservability.
    - `observabilityPlatform` ObservabilityStatusObservabilityPlatform: ObservabilityPlatform contains the status of the Akka observability platform.
      - `usingInternalLogs` boolean: UsingInternalLogs indicates whether logs are being sent to the internal Akka platform.
      - `usingInternalMetrics` boolean: UsingInternalMetrics indicates whether metrics are being sent to the internal Akka platform.
      - `usingInternalTraces` boolean: UsingInternalTraces indicates whether traces are being sent to the internal Akka platform.
    - `resourceSyncStatus` ResourceSyncStatus: ResourceSyncStatus of the KalixSecret, if deployed to a multi-region project.
      - `regions` ResourceSyncStatusRegion[], required: Regions are the regions that have been synced to.
        - `name` string, required: Name is the name of the region
        - `lastSyncStatus` boolean, required: LastSyncStatus is true if the last sync was successful
        - `reason` 'Synced' | 'NotSynced' | 'Failed' | 'Conflict': Reason is a human readable reason for the last sync status
        - `hash` string, byte: Hash is a hash of the spec of the resource if it was successfully synced.
        - `lastTransitionTime` string, date-time: LastTransitionTime is the last time the status changed
        - `detail` string: Detail is the details of any error that occurred
  - `spec` ObservabilitySpec: KalixObservabilitySpec defines the desired state of KalixObservability in v1beta1. This version supports multiple exporters per signal type.
    - `resourceSync` ResourceSync: Configuration for how this resource should be synced across regions
      - `mode` 'global' | 'regional': Mode is the mode in which resource sync is done.
    - `traceSampling` ObservabilitySpecTraceSampling: Trace sampling configuration (applies to all trace exporters). OTel has one sampling processor per pipeline, so this is at spec level rather than per-exporter.
      - `probabilistic` ObservabilitySpecTraceSamplingProbabilistic: Enables sampling trace production with a percentage.
        - `percentage` string: Percentage of traces that are sampled; 1 means, filters 99% of the traces.
    - `heapDump` ObservabilitySpecHeapDump: Heap dump configuration.
      - `aws` ObservabilitySpecHeapDumpAws: KalixHeapDumpAws describes AWS configuration for heap dumps.
        - `workloadIdentity` ObservabilitySpecHeapDumpAwsWorkloadIdentity: If set, will use workload identity to access AWS.
          - `roleArnOverride` string: If set, will override the Role ARN set on the service.
        - `pathPrefix` string: The prefix to prepend onto the name of the object
        - `credentialsSecretRef` ObservabilitySpecHeapDumpAwsCredentialsSecretRef: If set, will use the configured credentials to access AWS
          - `awsAccessKeyId` SecretKeyRef, required: SecretKeySelector selects a key of a Secret.
            - `key` string, required: The key of the secret to select from. Must be a valid secret key.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
            - `optional` boolean: Specify whether the Secret or its key must be defined
          - `awsSecretAccessKey` SecretKeyRef, required: SecretKeySelector selects a key of a Secret.
            - `key` string, required: The key of the secret to select from. Must be a valid secret key.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
            - `optional` boolean: Specify whether the Secret or its key must be defined
        - `concurrentUploads` integer
        - `bucket` string, required: The bucket to store heap dumps in.
        - `region` string, required: The region of the bucket.
      - `platformManaged` ObservabilitySpecHeapDumpPlatformManaged: Use the platform managed heap dump configuration. Not available in all regions.
        - `pathPrefix` string: The prefix to prepend onto the name of the object
    - `traces` ObservabilitySpecTrace[]: Exporters that should be used just for traces. Multiple exporters can be configured to send traces to multiple targets.
      - `kalixConsole` Patch: Configuration for the kalix console exporter (ie, the built in tempo that we will provide)
      - `otlpHttp` OtlpHttp: OpenTelemetry protocol (OTLP) http exporter.
        - `endpointUrl` string: The HTTP endpoint URL. Either this or endpointBaseUrl must be set. Not valid when defining a global OTLP HTTP exporter.
        - `encoding` 'proto' | 'json': The encoding to use for the messages. Either proto or json. Defaults to proto.
        - `tls` Tls: TLS configuration.
          - `caSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `clientCertSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `insecure` boolean: Whether plaintext should be used, defaults to false.
          - `insecureSkipVerify` boolean: Whether hostname verification should be done, defaults to false.
        - `headers` Header[]: Custom HTTP Headers.
          - `name` string
          - `value` string
          - `valueFrom` ValueFrom: Source for the environment variable's value. Cannot be used if value is not empty.
            - `secretKeyRef` SecretKeyRef: SecretKeySelector selects a key of a Secret.
              - …
        - `endpointBaseUrl` string: The HTTP endpoint base URL. Either this or endpointUrl must be set. If specified, the URL that's used will have a traces/metrics/logs specific path appended to it, specifically, /v1/traces for traces, /v1/metrics for metrics, and /v1/logs for logs. This must be used when defining a global OTLP HTTP exporter.
      - `googleCloud` GoogleCloud: Google Cloud exporter
        - `serviceAccountKeySecret` ServiceSpecJwtKeySecret, required: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
          - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
      - `azureMonitor` AzureMonitor: Azure Monitor exporter
        - `connectionString` string, required: ConnectionString The Azure Application Insights Connection String.
      - `otlp` Otlp: OpenTelemetry protocol (OTLP) gRPC exporter.
        - `endpoint` string: The gRPC endpoint.
        - `headers` Header[]: Custom HTTP Headers.
          - `name` string
          - `value` string
          - `valueFrom` ValueFrom: Source for the environment variable's value. Cannot be used if value is not empty.
            - `secretKeyRef` SecretKeyRef: SecretKeySelector selects a key of a Secret.
              - …
        - `tls` Tls: TLS configuration.
          - `caSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `clientCertSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `insecure` boolean: Whether plaintext should be used, defaults to false.
          - `insecureSkipVerify` boolean: Whether hostname verification should be done, defaults to false.
    - `metrics` ObservabilitySpecMetric[]: Exporters that should be used just for metrics. Multiple exporters can be configured to send metrics to multiple targets.
      - `kalixConsole` Patch: Configuration for the kalix console exporter (ie, the built in tempo that we will provide)
      - `otlpHttp` OtlpHttp: OpenTelemetry protocol (OTLP) http exporter.
        - `endpointUrl` string: The HTTP endpoint URL. Either this or endpointBaseUrl must be set. Not valid when defining a global OTLP HTTP exporter.
        - `encoding` 'proto' | 'json': The encoding to use for the messages. Either proto or json. Defaults to proto.
        - `tls` Tls: TLS configuration.
          - `caSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `clientCertSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `insecure` boolean: Whether plaintext should be used, defaults to false.
          - `insecureSkipVerify` boolean: Whether hostname verification should be done, defaults to false.
        - `headers` Header[]: Custom HTTP Headers.
          - `name` string
          - `value` string
          - `valueFrom` ValueFrom: Source for the environment variable's value. Cannot be used if value is not empty.
            - `secretKeyRef` SecretKeyRef: SecretKeySelector selects a key of a Secret.
              - …
        - `endpointBaseUrl` string: The HTTP endpoint base URL. Either this or endpointUrl must be set. If specified, the URL that's used will have a traces/metrics/logs specific path appended to it, specifically, /v1/traces for traces, /v1/metrics for metrics, and /v1/logs for logs. This must be used when defining a global OTLP HTTP exporter.
      - `googleCloud` GoogleCloud: Google Cloud exporter
        - `serviceAccountKeySecret` ServiceSpecJwtKeySecret, required: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
          - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
      - `azureMonitor` AzureMonitor: Azure Monitor exporter
        - `connectionString` string, required: ConnectionString The Azure Application Insights Connection String.
      - `splunkHec` SplunkHec: SplunkHec exporter
        - `sourceType` string: SourceType The Splunk source type: https://docs.splunk.com/Splexicon:Sourcetype A [default field](https://docs.splunk.com/Splexicon:Defaultfield) that identifies the data structure of an [event](https://docs.splunk.com/Splexicon:Event). A source type determines how the Splunk platform formats the data during the indexing process. Example source types include access_combined and cisco_syslog.
        - `source` string: Source The Splunk source: https://docs.splunk.com/Splexicon:Source A [default field](https://docs.splunk.com/Splexicon:Defaultfield) that identifies the source of an [event](https://docs.splunk.com/Splexicon:Event), that is, where the event originated. In the case of data monitored from files and directories, the source consists of the full pathname of the file or directory. In the case of a network-based source, the source field consists of the protocol and port, such as UDP:514.
        - `tls` Tls: TLS configuration.
          - `caSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `clientCertSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `insecure` boolean: Whether plaintext should be used, defaults to false.
          - `insecureSkipVerify` boolean: Whether hostname verification should be done, defaults to false.
        - `endpoint` string, required: Endpoint is the URL to a Splunk instance to send data to.
        - `tokenSecret` SecretKeyRef, required: SecretKeySelector selects a key of a Secret.
          - `key` string, required: The key of the secret to select from. Must be a valid secret key.
          - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `optional` boolean: Specify whether the Secret or its key must be defined
        - `index` string: Index The splunk index, optional name of the Splunk index targeted.
      - `prometheuswrite` ObservabilitySpecMetricPrometheuswrite: Prometheus exporter
        - `endpoint` string: The HTTP endpoint.
        - `headers` Header[]: Custom HTTP Headers.
          - `name` string
          - `value` string
          - `valueFrom` ValueFrom: Source for the environment variable's value. Cannot be used if value is not empty.
            - `secretKeyRef` SecretKeyRef: SecretKeySelector selects a key of a Secret.
              - …
        - `tls` Tls: TLS configuration.
          - `caSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `clientCertSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `insecure` boolean: Whether plaintext should be used, defaults to false.
          - `insecureSkipVerify` boolean: Whether hostname verification should be done, defaults to false.
      - `otlp` Otlp: OpenTelemetry protocol (OTLP) gRPC exporter.
        - `endpoint` string: The gRPC endpoint.
        - `headers` Header[]: Custom HTTP Headers.
          - `name` string
          - `value` string
          - `valueFrom` ValueFrom: Source for the environment variable's value. Cannot be used if value is not empty.
            - `secretKeyRef` SecretKeyRef: SecretKeySelector selects a key of a Secret.
              - …
        - `tls` Tls: TLS configuration.
          - `caSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `clientCertSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `insecure` boolean: Whether plaintext should be used, defaults to false.
          - `insecureSkipVerify` boolean: Whether hostname verification should be done, defaults to false.
    - `logs` ObservabilitySpecLog[]: Exporters that should be used just for logs. Multiple exporters can be configured to send logs to multiple targets.
      - `otlpHttp` OtlpHttp: OpenTelemetry protocol (OTLP) http exporter.
        - `endpointUrl` string: The HTTP endpoint URL. Either this or endpointBaseUrl must be set. Not valid when defining a global OTLP HTTP exporter.
        - `encoding` 'proto' | 'json': The encoding to use for the messages. Either proto or json. Defaults to proto.
        - `tls` Tls: TLS configuration.
          - `caSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `clientCertSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `insecure` boolean: Whether plaintext should be used, defaults to false.
          - `insecureSkipVerify` boolean: Whether hostname verification should be done, defaults to false.
        - `headers` Header[]: Custom HTTP Headers.
          - `name` string
          - `value` string
          - `valueFrom` ValueFrom: Source for the environment variable's value. Cannot be used if value is not empty.
            - `secretKeyRef` SecretKeyRef: SecretKeySelector selects a key of a Secret.
              - …
        - `endpointBaseUrl` string: The HTTP endpoint base URL. Either this or endpointUrl must be set. If specified, the URL that's used will have a traces/metrics/logs specific path appended to it, specifically, /v1/traces for traces, /v1/metrics for metrics, and /v1/logs for logs. This must be used when defining a global OTLP HTTP exporter.
      - `googleCloud` GoogleCloud: Google Cloud exporter
        - `serviceAccountKeySecret` ServiceSpecJwtKeySecret, required: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
          - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
      - `azureMonitor` AzureMonitor: Azure Monitor exporter
        - `connectionString` string, required: ConnectionString The Azure Application Insights Connection String.
      - `splunkHec` SplunkHec: SplunkHec exporter
        - `sourceType` string: SourceType The Splunk source type: https://docs.splunk.com/Splexicon:Sourcetype A [default field](https://docs.splunk.com/Splexicon:Defaultfield) that identifies the data structure of an [event](https://docs.splunk.com/Splexicon:Event). A source type determines how the Splunk platform formats the data during the indexing process. Example source types include access_combined and cisco_syslog.
        - `source` string: Source The Splunk source: https://docs.splunk.com/Splexicon:Source A [default field](https://docs.splunk.com/Splexicon:Defaultfield) that identifies the source of an [event](https://docs.splunk.com/Splexicon:Event), that is, where the event originated. In the case of data monitored from files and directories, the source consists of the full pathname of the file or directory. In the case of a network-based source, the source field consists of the protocol and port, such as UDP:514.
        - `tls` Tls: TLS configuration.
          - `caSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `clientCertSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `insecure` boolean: Whether plaintext should be used, defaults to false.
          - `insecureSkipVerify` boolean: Whether hostname verification should be done, defaults to false.
        - `endpoint` string, required: Endpoint is the URL to a Splunk instance to send data to.
        - `tokenSecret` SecretKeyRef, required: SecretKeySelector selects a key of a Secret.
          - `key` string, required: The key of the secret to select from. Must be a valid secret key.
          - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `optional` boolean: Specify whether the Secret or its key must be defined
        - `index` string: Index The splunk index, optional name of the Splunk index targeted.
      - `otlp` Otlp: OpenTelemetry protocol (OTLP) gRPC exporter.
        - `endpoint` string: The gRPC endpoint.
        - `headers` Header[]: Custom HTTP Headers.
          - `name` string
          - `value` string
          - `valueFrom` ValueFrom: Source for the environment variable's value. Cannot be used if value is not empty.
            - `secretKeyRef` SecretKeyRef: SecretKeySelector selects a key of a Secret.
              - …
        - `tls` Tls: TLS configuration.
          - `caSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `clientCertSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `insecure` boolean: Whether plaintext should be used, defaults to false.
          - `insecureSkipVerify` boolean: Whether hostname verification should be done, defaults to false.
    - `exporters` ObservabilitySpecExporter[]: Exporters that should be used for all applicable pipelines - logs, metrics and traces. Multiple exporters can be configured to send telemetry to multiple targets.
      - `kalixConsole` Patch: Configuration for the kalix console exporter (ie, the built in tempo that we will provide)
      - `otlpHttp` OtlpHttp: OpenTelemetry protocol (OTLP) http exporter.
        - `endpointUrl` string: The HTTP endpoint URL. Either this or endpointBaseUrl must be set. Not valid when defining a global OTLP HTTP exporter.
        - `encoding` 'proto' | 'json': The encoding to use for the messages. Either proto or json. Defaults to proto.
        - `tls` Tls: TLS configuration.
          - `caSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `clientCertSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `insecure` boolean: Whether plaintext should be used, defaults to false.
          - `insecureSkipVerify` boolean: Whether hostname verification should be done, defaults to false.
        - `headers` Header[]: Custom HTTP Headers.
          - `name` string
          - `value` string
          - `valueFrom` ValueFrom: Source for the environment variable's value. Cannot be used if value is not empty.
            - `secretKeyRef` SecretKeyRef: SecretKeySelector selects a key of a Secret.
              - …
        - `endpointBaseUrl` string: The HTTP endpoint base URL. Either this or endpointUrl must be set. If specified, the URL that's used will have a traces/metrics/logs specific path appended to it, specifically, /v1/traces for traces, /v1/metrics for metrics, and /v1/logs for logs. This must be used when defining a global OTLP HTTP exporter.
      - `googleCloud` GoogleCloud: Google Cloud exporter
        - `serviceAccountKeySecret` ServiceSpecJwtKeySecret, required: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
          - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
      - `azureMonitor` AzureMonitor: Azure Monitor exporter
        - `connectionString` string, required: ConnectionString The Azure Application Insights Connection String.
      - `splunkHec` SplunkHec: SplunkHec exporter
        - `sourceType` string: SourceType The Splunk source type: https://docs.splunk.com/Splexicon:Sourcetype A [default field](https://docs.splunk.com/Splexicon:Defaultfield) that identifies the data structure of an [event](https://docs.splunk.com/Splexicon:Event). A source type determines how the Splunk platform formats the data during the indexing process. Example source types include access_combined and cisco_syslog.
        - `source` string: Source The Splunk source: https://docs.splunk.com/Splexicon:Source A [default field](https://docs.splunk.com/Splexicon:Defaultfield) that identifies the source of an [event](https://docs.splunk.com/Splexicon:Event), that is, where the event originated. In the case of data monitored from files and directories, the source consists of the full pathname of the file or directory. In the case of a network-based source, the source field consists of the protocol and port, such as UDP:514.
        - `tls` Tls: TLS configuration.
          - `caSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `clientCertSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `insecure` boolean: Whether plaintext should be used, defaults to false.
          - `insecureSkipVerify` boolean: Whether hostname verification should be done, defaults to false.
        - `endpoint` string, required: Endpoint is the URL to a Splunk instance to send data to.
        - `tokenSecret` SecretKeyRef, required: SecretKeySelector selects a key of a Secret.
          - `key` string, required: The key of the secret to select from. Must be a valid secret key.
          - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `optional` boolean: Specify whether the Secret or its key must be defined
        - `index` string: Index The splunk index, optional name of the Splunk index targeted.
      - `otlp` Otlp: OpenTelemetry protocol (OTLP) gRPC exporter.
        - `endpoint` string: The gRPC endpoint.
        - `headers` Header[]: Custom HTTP Headers.
          - `name` string
          - `value` string
          - `valueFrom` ValueFrom: Source for the environment variable's value. Cannot be used if value is not empty.
            - `secretKeyRef` SecretKeyRef: SecretKeySelector selects a key of a Secret.
              - …
        - `tls` Tls: TLS configuration.
          - `caSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `clientCertSecret` ServiceSpecJwtKeySecret: An optional TLS secret containing a TLS certificate and its private key to be used by the server to authenticate the client.
            - `name` string: Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
          - `insecure` boolean: Whether plaintext should be used, defaults to false.
          - `insecureSkipVerify` boolean: Whether hostname verification should be done, defaults to false.
    - `logLevel` string: Log level for the OpenTelemetry collector.
  - `metadata` ObjectMeta: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
    - `name` string: Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
    - `ownerReferences` OwnerReference[]: List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
      - `name` string, required: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
      - `blockOwnerDeletion` boolean: If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
      - `uid` string, required: UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
      - `controller` boolean: If true, this reference points to the managing controller.
      - `kind` string, required: Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
      - `apiVersion` string, required: API version of the referent.
    - `creationTimestamp` string, date-time: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
    - `generation` integer: A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
    - `resourceVersion` string: An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
    - `generateName` string: GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
    - `deletionGracePeriodSeconds` integer: Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
    - `selfLink` string: Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
    - `finalizers` string[]: Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
    - `annotations` ObjectMetaLabels: Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
    - `managedFields` ManagedFieldsEntry[]: ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
      - `operation` string: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
      - `manager` string: Manager is an identifier of the workflow managing these fields.
      - `fieldsV1` Patch: Configuration for the kalix console exporter (ie, the built in tempo that we will provide)
      - `time` string, date-time: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
      - `apiVersion` string: APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
      - `fieldsType` string: FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
      - `subresource` string: Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
    - `labels` ObjectMetaLabels: Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
    - `uid` string: UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
    - `namespace` string: Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
    - `deletionTimestamp` string, date-time: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
  - `kind` string: Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  - `apiVersion` string: APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/akka/apis/akka-control-plane-api.md) - [All operations](https://skmtc.dev/akka/apis/akka-control-plane-api/llms.txt) - [OpenAPI document](https://skmtc.dev/akka/apis/akka-control-plane-api/revisions/bea0010b3fc7?raw)
