---
title: "Get the details of an existing telemetry source."
method: GET
path: "/v2/organizations/{organization}/telemetry/sources/{source}"
tags: ["Sources"]
---

# Get the details of an existing telemetry source.

`GET /v2/organizations/{organization}/telemetry/sources/{source}`

## Request

- Base URL: `https://docs.tetrate.io` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.tetrate.io/v2/organizations/{organization}/telemetry/sources/{source}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/tetrate/apis/tetrate-service-bridge-api/docs/v2/organizations/:organization/telemetry/sources/:source/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `organization` string, required
- `source` string, required

## Response `200`

A successful response.

- V2Source: Source identifies a set of observed resources that have a group of metrics that emit measurements at runtime.
  - `fqn` string
  - `displayName` string
  - `etag` string
  - `description` string
  - `belongsTo` string: Which concrete TSB resource in the configuration hierarchy this telemetry source belongs to. For instance, a telemetry source can belong to a service,or a gateway, or a workspace, or any other resource in the configuration hierarchy.
  - `metricSourceKey` string: A key to query metric measurements from the resources that the telemetry source is observing.
  - `type` 'INVALID' | 'SERVICE' | 'INGRESS' | 'RELATION': The type of scopes which defines telemetry source's wingspan in the mesh. - SERVICE: A telemetry source service based scope. - INGRESS: A telemetry source ingress's hostname based scope. - RELATION: A telemetry source relation based scope.
  - `scope` V2SourceScope: Source scope defines the source's wingspan in the mesh. It defines how we are observing the resources. For instance we can observer a resources at service, ingress, or relation level.
    - `serviceScopes` SourceScopeServiceScopes: ServiceScopes defines one or many service's telemetry source wingspan in the mesh.
      - `scopes` ServiceScopesServiceScope[]: Multiple ServiceScope can be defined to group under a single telemetry source different services.
        - `type` 'INVALID' | 'INSTANCE' | 'SERVICE' | 'SUBSET' | 'GLOBAL_SUBSET' | 'GLOBAL': ScopeType denotes the wingspan of a telemetry source for a service. - INSTANCE: A instance telemetry source belongs to a specific service instance (pod or VM) in a cluster. - SERVICE: A service telemetry source belongs to a specific service, without subsets, in a cluster. - SUBSET: A subset telemetry source belongs to a specific service of a concrete subset in a cluster. - GLOBAL_SUBSET: A global subset telemetry source represents a concrete subset from a service across cluster. Subset scope type does not apply to ingress services. - GLOBAL: A global telemetry source represents all subsets from a service across clusters.
        - `scope` ServiceScopesServiceScopeScope: Each of the scope properties can have the following values: - A non empty value. - An empty value or absence of the property act as a wildcard, meaning any possible value.
          - `instance` string: instance is a concrete value or an empty value meaning any instance.
          - `subset` string: subset can be a concrete value or an empty value meaning any subset.
          - `service` string: service is always a concrete value.
          - `namespace` string: namespace is always a concrete value.
          - `cluster` string: cluster can be a concrete value or an empty value meaning any cluster.
        - `deployment` string: The FQN of the service deployment in a concrete cluster related with this telemetry source scope. Will have a value for scope types INSTANCE or SERVICE.
    - `ingressScopes` SourceScopeIngressScopes: IngressScopes defines one or many Ingress's hostname telemetry source wingspan in the mesh.
      - `scopes` IngressScopesIngressScope[]: Multiple IngressScope can be defined to group under a single telemetry source different ingresses.
        - `type` 'INVALID' | 'HOSTNAME' | 'GLOBAL': ScopeType denotes the wingspan of a telemetry source for an ingress's hostname. - HOSTNAME: A hostname telemetry source that belongs to a specific ingress instance in a cluster. - GLOBAL: A global telemetry source of a hostname from an ingress across clusters.
        - `scope` IngressScopesIngressScopeScope: Each of the scope properties can have the following values: - A non empty value. - An empty value or absence of the property act as a wildcard, meaning any possible value.
          - `hostname` string
          - `ingressService` string
          - `cluster` string: cluster can be a concrete value or an empty value meaning any cluster.
        - `deployment` string: The FQN of the service deployment in a concrete cluster related with this telemetry source scope. Will have a value for scope types HOSTNAME.
    - `relationScopes` SourceScopeRelationScopes: RelationScopes represents the physical connection that exists between observable resources. A relation can represent for instance the physical connection that exist when a call between services is done: - Between a gateway and a service or vice versa. - Between a service and another service. This observation can produce client-side measurements, server side measurements or both.
      - `scopes` RelationScopesRelationScope[]: Multiple RelationScope can be defined to group under a single telemetry source different relations.
        - `type` 'INVALID' | 'SERVICE': ScopeType denotes the wingspan of a telemetry source for relation between resources. - SERVICE: A service telemetry source that belongs to a specific relation between logical services.
        - `scope` RelationScopesRelationScopeScope
          - `serviceRelation` RelationScopeServiceRelation: A relation between logical services.
            - `source` string: The source resource's fqn of the relation between two logical services.
            - `target` string: The target resource's fqn of the relation between two logical services.

## Other responses

- `default`: An unexpected error response.

---

[API](https://skmtc.dev/tetrate/apis/tetrate-service-bridge-api.md) - [All operations](https://skmtc.dev/tetrate/apis/tetrate-service-bridge-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tetrate/apis/tetrate-service-bridge-api/revisions/2f19c3a1ae57?raw)