launchdarkly Relay Proxy Configurations API

openapi: 3.1.0
info:
  title: LaunchDarkly Relay Proxy Access Tokens Relay Proxy Configurations 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: Relay Proxy Configurations
  description: Manage automatic configuration entries for LaunchDarkly Relay Proxy instances.
paths:
  /account/relay-auto-configs:
    get:
      operationId: listRelayProxyConfigs
      summary: List Relay Proxy configurations
      description: Returns a list of all Relay Proxy automatic configuration entries.
      tags:
      - Relay Proxy Configurations
      responses:
        '200':
          description: Successful response containing Relay Proxy configurations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelayProxyConfigs'
        '401':
          description: Unauthorized. Invalid or missing access token.
    post:
      operationId: createRelayProxyConfig
      summary: Create a Relay Proxy configuration
      description: Creates a new Relay Proxy automatic configuration entry that generates a unique key for Relay Proxy instances.
      tags:
      - Relay Proxy Configurations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RelayProxyConfigBody'
      responses:
        '201':
          description: Relay Proxy configuration created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelayProxyConfig'
        '400':
          description: Invalid request body.
        '401':
          description: Unauthorized. Invalid or missing access token.
components:
  schemas:
    Statement:
      type: object
      description: A policy statement controlling resource access or event filtering.
      properties:
        effect:
          type: string
          description: Whether this statement allows or denies the action.
          enum:
          - allow
          - deny
        resources:
          type: array
          description: Resource specifiers this statement applies to.
          items:
            type: string
        notResources:
          type: array
          description: Resource specifiers this statement does not apply to.
          items:
            type: string
        actions:
          type: array
          description: The actions this statement applies to.
          items:
            type: string
        notActions:
          type: array
          description: The actions this statement does not apply to.
          items:
            type: string
    RelayProxyConfig:
      type: object
      description: A Relay Proxy automatic configuration entry.
      properties:
        _id:
          type: string
          description: The unique identifier of this configuration.
        name:
          type: string
          description: The human-readable name of this configuration.
        fullKey:
          type: string
          description: The full key for authenticating Relay Proxy instances. Only returned at creation time.
        displayKey:
          type: string
          description: The last four characters of the full key.
        creationDate:
          type: integer
          format: int64
          description: Unix epoch timestamp when the configuration was created.
        lastModified:
          type: integer
          format: int64
          description: Unix epoch timestamp of the last modification.
        policy:
          type: array
          description: Policy statements controlling which projects and environments this Relay Proxy can access.
          items:
            $ref: '#/components/schemas/Statement'
        _links:
          $ref: '#/components/schemas/Links'
    RelayProxyConfigBody:
      type: object
      description: The request body for creating a Relay Proxy configuration.
      required:
      - name
      - policy
      properties:
        name:
          type: string
          description: A human-readable name for the configuration.
        policy:
          type: array
          description: Policy statements controlling access.
          items:
            $ref: '#/components/schemas/Statement'
    RelayProxyConfigs:
      type: object
      description: A collection of Relay Proxy configurations.
      properties:
        items:
          type: array
          description: The list of Relay Proxy configurations.
          items:
            $ref: '#/components/schemas/RelayProxyConfig'
    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