langfuse_client_base/models/api_key_summary.rs
1/*
2 * server
3 *
4 * ## Real-time data The only real-time path to get tracing data is to ingest via OpenTelemetry (`POST /api/public/otel/v1/traces`) and retrieve via Observations API v2 (`GET /api/public/v2/observations`) and Metrics API v2 (`GET /api/public/v2/metrics`). Other public API write and read endpoints can delay data by about 10 minutes. Direct OpenTelemetry exporters must send the `x-langfuse-ingestion-version: 4` header; current Python and JS SDKs already do. See the [Public API docs](https://langfuse.com/docs/api-and-data-platform/features/public-api) and [real-time ingestion](https://langfuse.com/integrations/native/opentelemetry.md#real-time-ingestion). ## Authentication Authenticate with the API using [Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication), get API keys in the project settings: - username: Langfuse Public Key - password: Langfuse Secret Key ## Exports - OpenAPI spec: https://cloud.langfuse.com/generated/api/openapi.yml - Self-hosted deployments: interactive API reference at `/api/docs` and OpenAPI spec at `/api/openapi.yaml`
5 *
6 * The version of the OpenAPI document:
7 *
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// ApiKeySummary : Summary of an API key
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
16pub struct ApiKeySummary {
17 #[serde(rename = "id")]
18 pub id: String,
19 #[serde(rename = "createdAt")]
20 pub created_at: chrono::DateTime<chrono::FixedOffset>,
21 /// Expiration timestamp. Null if the key does not expire.
22 #[serde(
23 rename = "expiresAt",
24 default,
25 with = "::serde_with::rust::double_option",
26 skip_serializing_if = "Option::is_none"
27 )]
28 pub expires_at: Option<Option<chrono::DateTime<chrono::FixedOffset>>>,
29 #[serde(
30 rename = "lastUsedAt",
31 default,
32 with = "::serde_with::rust::double_option",
33 skip_serializing_if = "Option::is_none"
34 )]
35 pub last_used_at: Option<Option<chrono::DateTime<chrono::FixedOffset>>>,
36 /// Name of the API key. Contains the same value as note; null if no name was provided.
37 #[serde(
38 rename = "name",
39 default,
40 with = "::serde_with::rust::double_option",
41 skip_serializing_if = "Option::is_none"
42 )]
43 pub name: Option<Option<String>>,
44 /// Deprecated alias for name. Contains the same value as name.
45 #[serde(
46 rename = "note",
47 default,
48 with = "::serde_with::rust::double_option",
49 skip_serializing_if = "Option::is_none"
50 )]
51 pub note: Option<Option<String>>,
52 #[serde(rename = "publicKey")]
53 pub public_key: String,
54 #[serde(rename = "displaySecretKey")]
55 pub display_secret_key: String,
56}
57
58impl ApiKeySummary {
59 /// Summary of an API key
60 pub fn new(
61 id: String,
62 created_at: chrono::DateTime<chrono::FixedOffset>,
63 public_key: String,
64 display_secret_key: String,
65 ) -> ApiKeySummary {
66 ApiKeySummary {
67 id,
68 created_at,
69 expires_at: None,
70 last_used_at: None,
71 name: None,
72 note: None,
73 public_key,
74 display_secret_key,
75 }
76 }
77}