launchdarkly PHP Polling API

Polling endpoints for PHP server-side SDKs which do not support streaming mode.

OpenAPI Specification

launchdarkly-php-polling-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: LaunchDarkly Relay Proxy Access Tokens PHP Polling 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: PHP Polling
  description: Polling endpoints for PHP server-side SDKs which do not support streaming mode.
paths:
  /sdk/latest-all:
    get:
      operationId: getLatestAllFlags
      summary: Get latest all flags (PHP polling)
      description: Returns the latest flag data for PHP server-side SDKs that use polling mode instead of streaming. Requires an SDK key in the Authorization header.
      tags:
      - PHP Polling
      security:
      - sdkKeyAuth: []
      responses:
        '200':
          description: Successful response containing the latest flag data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlagData'
        '401':
          description: Unauthorized. Invalid SDK key.
        '503':
          description: Service unavailable. Flag data not yet available.
components:
  schemas:
    FlagData:
      type: object
      description: The complete flag data set for PHP polling mode.
      properties:
        flags:
          type: object
          description: A map of flag keys to their complete flag configurations.
          additionalProperties:
            type: object
        segments:
          type: object
          description: A map of segment keys to their complete segment configurations.
          additionalProperties:
            type: object
  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