--- title: "CreateTelemetry" method: POST path: "/v1/namespaces/{tenant_meta.namespace}/telemetries" tags: ["TelemetryService"] --- # CreateTelemetry `POST /v1/namespaces/{tenant_meta.namespace}/telemetries` ## Request - Base URL: `https://api.endorlabs.com` - URL: `https://api.endorlabs.com/v1/namespaces/{tenant_meta.namespace}/telemetries` - Auth: none declared Creates a telemetry. ## Path parameters - `tenant_meta.namespace` string, required ## Request body - TelemetryServiceCreateTelemetryBody: Telemetry represents the Prometheus metrics obtained from endorctl processes. - `meta` V1Meta, required: Common fields for all Endor Labs resources. - `annotations` object: Annotations can be used to attach metadata to a resource message. Annotation values can be small or large, structured or unstructured, and may include characters not permitted by labels. The keys may contain alphanumerics, underscores (_), dots (.) and dashes (-). The values of an annotation must be 16384 bytes or smaller. - `create_time` string, date-time: Time the resource was created. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `created_by` string: Name and authentication source of the user who created the object, for example, ewok@endor.ai@google@api-key. - `description` string: Resource description. Must be less than 1024 bytes. - `index_data` V1IndexData: IndexData is used to index the resource for search. It's an internal object. - `data` string[] - `search_score` number, float: search_score is the score of the resource for search. Internal use only. - `tenant` string - `will_be_deleted_at` string, date-time: Time that the resource will be deleted. - `kind` string: Resource kind, for example, HelloResponse. Auto-generated using the protobuf message proto.MessageName().Name(). - `name` string, required: Resource name. Must be 63 characters or less. - `parent_kind` string: Parent object resource kind, for example, Project. - `parent_uuid` string: Parent object UUID. - `references` object: Map of objects referenced in a query API. - `tags` string[]: List of tags attached to the resource. Tags can be used to select objects and to find collections of objects that satisfy certain conditions. A tag must be 255 characters or less. - `update_time` string, date-time: Time the resource was last updated. Note: Updated on all create/patch/delete operations. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `updated_by` string: Name and authentication source of the last user who updated the object, for example, vulnerabilityingestor@endor.ai@x509. - `upsert_time` string, date-time: Time the resource was last upserted. Note: create_time is only set the first time the resource is created. upsert_time is set every time the resource is upseted. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `version` string: Message version. - `spec` V1TelemetrySpec, required - `caller_prefix` string, required: Identifies where the metrics come from. - `caller_version` string: Version of the caller. - `execution_id` string: The UUID for the endorctl run. - `metric_families` ClientMetricFamily[]: An array of metric families sent to the server. - `help` string - `metric` PrometheusclientMetric[] - `counter` ClientCounter - `created_timestamp` string, date-time - `exemplar` ClientExemplar - `label` ClientLabelPair[] - … - `timestamp` string, date-time: OpenMetrics-style. - `value` number, double - `value` number, double - `gauge` ClientGauge - `value` number, double - `histogram` ClientHistogram - `bucket` ClientBucket[]: Buckets for the conventional histogram. Ordered in increasing order of upper_bound, +Inf bucket is optional. - `cumulative_count` string, uint64: Cumulative in increasing order. - `cumulative_count_float` number, double: Overrides cumulative_count if > 0. - `exemplar` ClientExemplar - … - `upper_bound` number, double: Inclusive. - `created_timestamp` string, date-time - `exemplars` ClientExemplar[]: Only used for native histograms. These exemplars MUST have a timestamp. - `label` ClientLabelPair[] - … - `timestamp` string, date-time: OpenMetrics-style. - `value` number, double - `negative_count` number[]: Absolute count of each bucket. - `negative_delta` string[]: Use either "negative_delta" or "negative_count", the former for regular histograms with integer counts, the latter for float histograms. Count delta of each bucket compared to previous one (or to zero for 1st bucket). - `negative_span` ClientBucketSpan[]: Negative buckets for the native histogram. - `length` integer: Length of consecutive buckets. - `offset` integer: Gap to previous span, or starting point for 1st span (which can be negative). - `positive_count` number[]: Absolute count of each bucket. - `positive_delta` string[]: Use either "positive_delta" or "positive_count", the former for regular histograms with integer counts, the latter for float histograms. Count delta of each bucket compared to previous one (or to zero for 1st bucket). - `positive_span` ClientBucketSpan[]: Positive buckets for the native histogram. Use a no-op span (offset 0, length 0) for a native histogram without any observations yet and with a zero_threshold of 0. Otherwise, it would be indistinguishable from a classic histogram. - `length` integer: Length of consecutive buckets. - `offset` integer: Gap to previous span, or starting point for 1st span (which can be negative). - `sample_count` string, uint64 - `sample_count_float` number, double: Overrides sample_count if > 0. - `sample_sum` number, double - `schema` integer: schema defines the bucket schema. Currently, valid numbers are -4 <= n <= 8. They are all for base-2 bucket schemas, where 1 is a bucket boundary in each case, and then each power of two is divided into 2^n logarithmic buckets. Or in other words, each bucket boundary is the previous boundary times 2^(2^-n). In the future, more bucket schemas may be added using numbers < -4 or > 8. - `zero_count` string, uint64: Count in zero bucket. - `zero_count_float` number, double: Overrides sb_zero_count if > 0. - `zero_threshold` number, double: Breadth of the zero bucket. - `label` ClientLabelPair[] - `name` string - `value` string - `summary` ClientSummary - `created_timestamp` string, date-time - `quantile` ClientQuantile[] - `quantile` number, double - `value` number, double - `sample_count` string, uint64 - `sample_sum` number, double - `timestamp_ms` string, int64 - `untyped` ClientUntyped - `value` number, double - `name` string - `type` 'COUNTER' | 'GAUGE' | 'SUMMARY' | 'UNTYPED' | 'HISTOGRAM' | 'GAUGE_HISTOGRAM': - COUNTER: COUNTER must use the Metric field "counter". - GAUGE: GAUGE must use the Metric field "gauge". - SUMMARY: SUMMARY must use the Metric field "summary". - UNTYPED: UNTYPED must use the Metric field "untyped". - HISTOGRAM: HISTOGRAM must use the Metric field "histogram". - GAUGE_HISTOGRAM: GAUGE_HISTOGRAM must use the Metric field "histogram". - `unit` string - `tenant_meta` object: Namespace of the message that is accessed. - `uuid` string: The UUID of the telemetry. ## Response `200` A successful response. - V1Telemetry: Telemetry represents the Prometheus metrics obtained from endorctl processes. - `meta` V1Meta, required: Common fields for all Endor Labs resources. - `annotations` object: Annotations can be used to attach metadata to a resource message. Annotation values can be small or large, structured or unstructured, and may include characters not permitted by labels. The keys may contain alphanumerics, underscores (_), dots (.) and dashes (-). The values of an annotation must be 16384 bytes or smaller. - `create_time` string, date-time: Time the resource was created. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `created_by` string: Name and authentication source of the user who created the object, for example, ewok@endor.ai@google@api-key. - `description` string: Resource description. Must be less than 1024 bytes. - `index_data` V1IndexData: IndexData is used to index the resource for search. It's an internal object. - `data` string[] - `search_score` number, float: search_score is the score of the resource for search. Internal use only. - `tenant` string - `will_be_deleted_at` string, date-time: Time that the resource will be deleted. - `kind` string: Resource kind, for example, HelloResponse. Auto-generated using the protobuf message proto.MessageName().Name(). - `name` string, required: Resource name. Must be 63 characters or less. - `parent_kind` string: Parent object resource kind, for example, Project. - `parent_uuid` string: Parent object UUID. - `references` object: Map of objects referenced in a query API. - `tags` string[]: List of tags attached to the resource. Tags can be used to select objects and to find collections of objects that satisfy certain conditions. A tag must be 255 characters or less. - `update_time` string, date-time: Time the resource was last updated. Note: Updated on all create/patch/delete operations. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `updated_by` string: Name and authentication source of the last user who updated the object, for example, vulnerabilityingestor@endor.ai@x509. - `upsert_time` string, date-time: Time the resource was last upserted. Note: create_time is only set the first time the resource is created. upsert_time is set every time the resource is upseted. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `version` string: Message version. - `spec` V1TelemetrySpec, required - `caller_prefix` string, required: Identifies where the metrics come from. - `caller_version` string: Version of the caller. - `execution_id` string: The UUID for the endorctl run. - `metric_families` ClientMetricFamily[]: An array of metric families sent to the server. - `help` string - `metric` PrometheusclientMetric[] - `counter` ClientCounter - `created_timestamp` string, date-time - `exemplar` ClientExemplar - `label` ClientLabelPair[] - … - `timestamp` string, date-time: OpenMetrics-style. - `value` number, double - `value` number, double - `gauge` ClientGauge - `value` number, double - `histogram` ClientHistogram - `bucket` ClientBucket[]: Buckets for the conventional histogram. Ordered in increasing order of upper_bound, +Inf bucket is optional. - `cumulative_count` string, uint64: Cumulative in increasing order. - `cumulative_count_float` number, double: Overrides cumulative_count if > 0. - `exemplar` ClientExemplar - … - `upper_bound` number, double: Inclusive. - `created_timestamp` string, date-time - `exemplars` ClientExemplar[]: Only used for native histograms. These exemplars MUST have a timestamp. - `label` ClientLabelPair[] - … - `timestamp` string, date-time: OpenMetrics-style. - `value` number, double - `negative_count` number[]: Absolute count of each bucket. - `negative_delta` string[]: Use either "negative_delta" or "negative_count", the former for regular histograms with integer counts, the latter for float histograms. Count delta of each bucket compared to previous one (or to zero for 1st bucket). - `negative_span` ClientBucketSpan[]: Negative buckets for the native histogram. - `length` integer: Length of consecutive buckets. - `offset` integer: Gap to previous span, or starting point for 1st span (which can be negative). - `positive_count` number[]: Absolute count of each bucket. - `positive_delta` string[]: Use either "positive_delta" or "positive_count", the former for regular histograms with integer counts, the latter for float histograms. Count delta of each bucket compared to previous one (or to zero for 1st bucket). - `positive_span` ClientBucketSpan[]: Positive buckets for the native histogram. Use a no-op span (offset 0, length 0) for a native histogram without any observations yet and with a zero_threshold of 0. Otherwise, it would be indistinguishable from a classic histogram. - `length` integer: Length of consecutive buckets. - `offset` integer: Gap to previous span, or starting point for 1st span (which can be negative). - `sample_count` string, uint64 - `sample_count_float` number, double: Overrides sample_count if > 0. - `sample_sum` number, double - `schema` integer: schema defines the bucket schema. Currently, valid numbers are -4 <= n <= 8. They are all for base-2 bucket schemas, where 1 is a bucket boundary in each case, and then each power of two is divided into 2^n logarithmic buckets. Or in other words, each bucket boundary is the previous boundary times 2^(2^-n). In the future, more bucket schemas may be added using numbers < -4 or > 8. - `zero_count` string, uint64: Count in zero bucket. - `zero_count_float` number, double: Overrides sb_zero_count if > 0. - `zero_threshold` number, double: Breadth of the zero bucket. - `label` ClientLabelPair[] - `name` string - `value` string - `summary` ClientSummary - `created_timestamp` string, date-time - `quantile` ClientQuantile[] - `quantile` number, double - `value` number, double - `sample_count` string, uint64 - `sample_sum` number, double - `timestamp_ms` string, int64 - `untyped` ClientUntyped - `value` number, double - `name` string - `type` 'COUNTER' | 'GAUGE' | 'SUMMARY' | 'UNTYPED' | 'HISTOGRAM' | 'GAUGE_HISTOGRAM': - COUNTER: COUNTER must use the Metric field "counter". - GAUGE: GAUGE must use the Metric field "gauge". - SUMMARY: SUMMARY must use the Metric field "summary". - UNTYPED: UNTYPED must use the Metric field "untyped". - HISTOGRAM: HISTOGRAM must use the Metric field "histogram". - GAUGE_HISTOGRAM: GAUGE_HISTOGRAM must use the Metric field "histogram". - `unit` string - `tenant_meta` V1TenantMeta: Tenant related data for the tenant containing the resource. - `namespace` string, required: Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". - `uuid` string: The UUID of the telemetry. ## Other responses - `default`: An unexpected error response. ## Changes - **2026-11-03** `4acd9fe15140`: 1 info - endpoint added [Operation history](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference/changes/v1/namespaces/:tenant_meta.namespace/telemetries/post.md) --- [API](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference.md) - [All operations](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference/revisions/9c1a64674369?raw)