> ## 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 a list of sources visible to the caller's organization. ## OpenAPI ````yaml /platform/livesources-api/openapi.json get /sources 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: get: tags: - Live Sources summary: Returns a list of sources visible to the caller's organization. operationId: list_sources parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' - name: name_filter description: Substring match on source name (case-insensitive). schema: type: string in: query required: false - name: status description: Filter by one or more source statuses. schema: type: array items: $ref: '#/components/schemas/SourceStatus' in: query required: false - name: kind description: Filter by one or more source kinds. schema: type: array items: $ref: '#/components/schemas/SourceKind' in: query required: false - name: connection_state description: Filter by one or more connection states. schema: type: array items: $ref: '#/components/schemas/ConnectionStateType' in: query required: false - name: tags_any description: Match sources tagged with any of the given tags. schema: type: array items: type: string in: query required: false - name: tags_all description: Match sources tagged with all of the given tags. schema: type: array items: type: string in: query required: false - name: order schema: $ref: '#/components/schemas/SourcesOrder' in: query required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/SourcesCollection' description: List Sources '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' security: - BearerAuth: - livesources:source:access components: parameters: page: name: page description: Page schema: default: 1 type: integer in: query required: false per_page: name: per_page description: Number of entries per page schema: default: 30 type: integer in: query required: false schemas: SourceStatus: enum: - INACTIVE - PENDING - ACTIVE - STOPPING - ERROR type: string readOnly: true examples: - ACTIVE SourceKind: enum: - SRT type: string readOnly: true examples: - SRT ConnectionStateType: enum: - CONNECTED - DISCONNECTED - WAITING type: string readOnly: true SourcesOrder: enum: - CREATION - ACTIVATION - NAME_ASC - NAME_DESC type: string default: CREATION SourcesCollection: type: object properties: sources: description: List of Sources for the current page. type: array items: $ref: '#/components/schemas/Source' page: description: Number of current page type: integer examples: - 1 per_page: description: Quantity of Sources to show on one page type: integer examples: - 30 page_count: description: Total number of pages type: integer examples: - 3 total_count: description: Total number of Sources type: integer examples: - 78 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' ConnectionType: enum: - PRIMARY - SECONDARY - UNKNOWN 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 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 ````