launchdarkly Code References API

View code references that show where feature flags are used in your codebase.

OpenAPI Specification

launchdarkly-code-references-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: LaunchDarkly Relay Proxy Access Tokens Code References API
  description: The LaunchDarkly Relay Proxy is a small Go application that connects to the LaunchDarkly streaming API and proxies that connection to SDK clients within an organization's network. It exposes endpoints for status monitoring, flag evaluation, and SDK streaming that mirror the LaunchDarkly service endpoints. Instead of each server making outbound connections to LaunchDarkly's streaming service, multiple servers connect to the local Relay Proxy which maintains a single upstream connection.
  version: '8.0'
  contact:
    name: LaunchDarkly Support
    url: https://support.launchdarkly.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:8030
  description: Default Relay Proxy instance
tags:
- name: Code References
  description: View code references that show where feature flags are used in your codebase.
paths:
  /code-refs/repositories:
    get:
      operationId: listCodeReferenceRepositories
      summary: List code reference repositories
      description: Returns a list of all repositories connected for code reference scanning.
      tags:
      - Code References
      responses:
        '200':
          description: Successful response containing code reference repositories.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CodeReferenceRepositories'
        '401':
          description: Unauthorized. Invalid or missing access token.
components:
  schemas:
    CodeReferenceRepositories:
      type: object
      description: A collection of code reference repositories.
      properties:
        items:
          type: array
          description: The list of code reference repositories.
          items:
            type: object
            properties:
              name:
                type: string
                description: The repository name.
              sourceLink:
                type: string
                description: The URL to the repository source.
              type:
                type: string
                description: The repository hosting type.
              _links:
                $ref: '#/components/schemas/Links'
    Links:
      type: object
      description: HATEOAS links for navigating related resources.
      properties:
        self:
          type: object
          description: A link to this resource.
          properties:
            href:
              type: string
              description: The URL of this resource.
            type:
              type: string
              description: The media type.
      additionalProperties:
        type: object
        properties:
          href:
            type: string
            description: The URL of the linked resource.
          type:
            type: string
            description: The media type.
  securitySchemes:
    sdkKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Server-side SDK key for authenticating with the Relay Proxy.
    mobileKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Mobile SDK key for authenticating with the Relay Proxy.
externalDocs:
  description: Relay Proxy Documentation
  url: https://launchdarkly.com/docs/sdk/relay-proxy