Manage environments within projects such as production, staging, and development.
openapi: 3.1.0
info:
title: LaunchDarkly Relay Proxy Access Tokens Environments 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: Environments
description: Manage environments within projects such as production, staging, and development.
paths:
/projects/{projectKey}/environments:
get:
operationId: listEnvironments
summary: List environments
description: Returns a list of all environments within the specified project.
tags:
- Environments
parameters:
- $ref: '#/components/parameters/ProjectKey'
- name: limit
in: query
description: Maximum number of environments to return.
schema:
type: integer
- name: offset
in: query
description: Number of environments to skip for pagination.
schema:
type: integer
responses:
'200':
description: Successful response containing a list of environments.
content:
application/json:
schema:
$ref: '#/components/schemas/Environments'
'401':
description: Unauthorized. Invalid or missing access token.
'404':
description: Project not found.
post:
operationId: createEnvironment
summary: Create an environment
description: Creates a new environment in the specified project.
tags:
- Environments
parameters:
- $ref: '#/components/parameters/ProjectKey'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentBody'
responses:
'201':
description: Environment created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Environment'
'400':
description: Invalid request body.
'401':
description: Unauthorized. Invalid or missing access token.
'409':
description: An environment with the given key already exists.
/projects/{projectKey}/environments/{environmentKey}:
get:
operationId: getEnvironment
summary: Get an environment
description: Returns a single environment by its key within the specified project.
tags:
- Environments
parameters:
- $ref: '#/components/parameters/ProjectKey'
- $ref: '#/components/parameters/EnvironmentKey'
responses:
'200':
description: Successful response containing the environment.
content:
application/json:
schema:
$ref: '#/components/schemas/Environment'
'401':
description: Unauthorized. Invalid or missing access token.
'404':
description: Environment or project not found.
patch:
operationId: patchEnvironment
summary: Update an environment
description: Updates an environment using a JSON Patch representation.
tags:
- Environments
parameters:
- $ref: '#/components/parameters/ProjectKey'
- $ref: '#/components/parameters/EnvironmentKey'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchOperation'
responses:
'200':
description: Environment updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Environment'
'400':
description: Invalid patch request.
'401':
description: Unauthorized. Invalid or missing access token.
'404':
description: Environment or project not found.
delete:
operationId: deleteEnvironment
summary: Delete an environment
description: Permanently deletes an environment from the specified project.
tags:
- Environments
parameters:
- $ref: '#/components/parameters/ProjectKey'
- $ref: '#/components/parameters/EnvironmentKey'
responses:
'204':
description: Environment deleted successfully.
'401':
description: Unauthorized. Invalid or missing access token.
'404':
description: Environment or project not found.
components:
schemas:
Environment:
type: object
description: An environment within a project, such as production or staging.
properties:
_id:
type: string
description: The unique identifier of this environment.
key:
type: string
description: The environment key.
name:
type: string
description: The human-readable name of the environment.
color:
type: string
description: The color swatch for the environment in the dashboard.
pattern: ^[0-9a-fA-F]{6}$
apiKey:
type: string
description: The SDK key for server-side SDKs.
mobileKey:
type: string
description: The mobile key for mobile SDKs.
defaultTtl:
type: integer
description: The default time-to-live in minutes for flag values.
secureMode:
type: boolean
description: Whether secure mode is enabled for this environment.
tags:
type: array
description: Tags applied to this environment.
items:
type: string
_links:
$ref: '#/components/schemas/Links'
PatchOperation:
type: object
description: A JSON Patch or semantic patch request.
properties:
patch:
type: array
description: An array of JSON Patch operations.
items:
type: object
required:
- op
- path
properties:
op:
type: string
description: The patch operation type.
enum:
- add
- remove
- replace
- move
- copy
- test
path:
type: string
description: The JSON Pointer path to the target field.
value:
description: The value to apply for add or replace operations.
comment:
type: string
description: An optional comment describing the change.
EnvironmentBody:
type: object
description: The request body for creating a new environment.
required:
- name
- key
- color
properties:
name:
type: string
description: The human-readable name of the environment.
key:
type: string
description: The environment key.
pattern: ^[a-z0-9]([a-z0-9-])*$
color:
type: string
description: The color swatch for the environment in the dashboard.
pattern: ^[0-9a-fA-F]{6}$
defaultTtl:
type: integer
description: The default time-to-live in minutes.
secureMode:
type: boolean
description: Whether to enable secure mode.
tags:
type: array
description: Tags to apply to the environment.
items:
type: string
Environments:
type: object
description: A collection of environments.
properties:
items:
type: array
description: The list of environments.
items:
$ref: '#/components/schemas/Environment'
totalCount:
type: integer
description: The total number of environments.
_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.
parameters:
ProjectKey:
name: projectKey
in: path
required: true
description: The project key identifying a LaunchDarkly project.
schema:
type: string
pattern: ^[a-z0-9]([a-z0-9-])*$
EnvironmentKey:
name: environmentKey
in: path
required: true
description: The environment key identifying a specific environment.
schema:
type: string
pattern: ^[a-z0-9]([a-z0-9-])*$
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