> ## Documentation Index
> Fetch the complete documentation index at: https://docs.up.telestream.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Returns information about the source with the specified identifier.



## OpenAPI

````yaml /platform/livesources-api/openapi.json get /sources/{source_id}
openapi: 3.1.3
info:
  title: UP.LiveSources API Specification
  version: 1.0.0
  description: |
    Telestream UP.LiveSources API Specification.

    REST surface for the UP.LiveSources service: organization-scoped
    SRT source ingestion that other UP applications (LiveCapture, Lens,
    and so on) consume as CHLS streams.

    Naming conventions follow the rest of the UP REST surface
    (snake_case path parameters, operation IDs, and JSON properties).
    Pagination is offset-based (`page`, `per_page`) returning a wrapper
    with the resource-named array plus `page_count` and `total_count`.
  termsOfService: https://www.telestream.net/telestream-cloud/terms.htm
  contact:
    name: API Support
    url: https://www.telestream.com
    email: up@telestream.net
  license:
    name: Proprietary — Telestream
servers:
  - url: https://api.up.telestream.com/livesources/v1
    description: Production
security:
  - BearerAuth: []
tags:
  - name: source
    description: Operations related to live sources
  - name: access
    description: Operations related to access checks
paths:
  /sources/{source_id}:
    parameters:
      - $ref: '#/components/parameters/source_id'
    get:
      tags:
        - source
      summary: Returns information about the source with the specified identifier.
      operationId: get_source
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Source'
          description: Get particular Source Details
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - BearerAuth:
            - livesources:source:access
components:
  parameters:
    source_id:
      name: source_id
      description: Unique identifier of a Source
      schema:
        type: string
        format: uuid
      in: path
      required: true
  schemas:
    Source:
      type: object
      description: |
        Common source representation. The `kind` discriminator
        indicates which subtype-specific fields are populated.
        Currently only `SrtSource` is defined.
      required:
        - id
        - name
        - description
        - kind
        - status
        - active_receiver
        - primary_connection_state
        - secondary_connection_state
      properties:
        id:
          description: This is the GUID for the Source.
          type: string
          format: uuid
          readOnly: true
          examples:
            - e3c908ad-dc8f-4edb-88f7-c84dec0aef99
        kind:
          $ref: '#/components/schemas/SourceKind'
        name:
          description: Source name
          type: string
          examples:
            - CNN East Feed
        description:
          description: Describes the Source purpose
          type: string
          examples:
            - Primary east-coast feed for breaking news.
        status:
          $ref: '#/components/schemas/SourceStatus'
        activated_at:
          format: date-time
          description: Timestamp when the Source was last activated, in UTC iso8601 format.
          type:
            - string
            - 'null'
          readOnly: true
          examples:
            - '2025-04-21T15:53:12.388317Z'
        active_receiver:
          $ref: '#/components/schemas/ConnectionType'
        engine_version:
          description: Engine version that hosts the source.
          type:
            - string
            - 'null'
        errors:
          type:
            - array
            - 'null'
          items:
            type: string
          readOnly: true
        passthrough_url:
          description: >-
            Optional SRT passthrough URL when the source has passthrough
            enabled.
          type:
            - string
            - 'null'
          readOnly: true
        primary_connection_state:
          $ref: '#/components/schemas/ConnectionStateType'
        primary_ingress_url:
          description: >-
            Ingress URL the customer's encoder pushes the primary stream to
            (caller mode), or that LiveCapture listens on (listener mode).
          type:
            - string
            - 'null'
          readOnly: true
        region:
          description: Cloud region in which the source is hosted.
          type:
            - string
            - 'null'
        secondary_connection_state:
          $ref: '#/components/schemas/ConnectionStateType'
        secondary_ingress_url:
          description: Ingress URL for the redundant receiver, when redundancy is enabled.
          type:
            - string
            - 'null'
          readOnly: true
        stream_metadata:
          description: Engine-reported metadata of the active stream as a JSON string.
          type:
            - string
            - 'null'
          readOnly: true
        tags:
          type:
            - array
            - 'null'
          items:
            type: string
        transport_statistics_primary:
          description: >-
            Engine-reported SRT transport statistics for the primary receiver as
            a JSON string.
          type:
            - string
            - 'null'
          readOnly: true
        transport_statistics_secondary:
          description: >-
            Engine-reported SRT transport statistics for the secondary receiver
            as a JSON string.
          type:
            - string
            - 'null'
          readOnly: true
        created_at:
          format: date-time
          description: Timestamp when Source was created, in UTC iso8601 format.
          type: string
          readOnly: true
          examples:
            - '2025-04-21T15:53:12.388317Z'
        updated_at:
          format: date-time
          description: Timestamp when Source was last updated, in UTC iso8601 format.
          type: string
          readOnly: true
          examples:
            - '2025-04-22T15:53:12.182617Z'
    SourceKind:
      enum:
        - SRT
      type: string
      readOnly: true
      examples:
        - SRT
    SourceStatus:
      enum:
        - INACTIVE
        - PENDING
        - ACTIVE
        - STOPPING
        - ERROR
      type: string
      readOnly: true
      examples:
        - ACTIVE
    ConnectionType:
      enum:
        - PRIMARY
        - SECONDARY
        - UNKNOWN
      type: string
      readOnly: true
    ConnectionStateType:
      enum:
        - CONNECTED
        - DISCONNECTED
        - WAITING
      type: string
      readOnly: true
  responses:
    Unauthorized:
      content:
        application/json:
          schema:
            type: object
            properties:
              error_message:
                type: string
            examples:
              - error_message: You don't have permission to access this resource
      description: Not authorized
    NotFound:
      content:
        application/json:
          schema:
            type: object
            properties:
              error_message:
                type: string
            examples:
              - error_message: 404 Not found
      description: Item not found
    InternalError:
      content:
        application/json:
          schema:
            type: object
            properties:
              error_message:
                type: string
            examples:
              - error_message: 500 internal error
      description: 500 Internal error
  securitySchemes:
    BearerAuth:
      type: oauth2
      description: OAuth2 bearer token in the Authorization header
      flows:
        clientCredentials:
          tokenUrl: /auth/token
          scopes:
            livesources:access: Validate that the token has access to LiveSources
            livesources:source:access: Read access to live sources
            livesources:source:source-management: Manage (create / update / delete / activate) live sources

````