LaunchDarkly

List projects

Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

Return a list of projects.

Inputs

Champ

Type

Description

limit

number

The number of projects to return in the response.

default: 20

query

[string]

A list of strings that match against the projects' names and keys. It is not case sensitive. It filters the list of projects whose names or keys match all the query strings. Each string cannot contain “,”.

tags

A list of project tags. It filters the list of projects that have all of the tags in the list. Each tag cannot contain “,” or “+”.

Outputs

Expand All

Champ

Type

Description

projects [required]

[object]

_links [required]

object

The location and content type of related resources

_id [required]

string

The ID of this project

key [required]

string

The key of this project

includeInSnippetByDefault [required]

boolean

Whether or not flags created in this project are made available to the client-side JavaScript SDK by default

defaultClientSideAvailability

object

usingMobileKey

boolean

usingEnvironmentId

boolean

name [required]

string

A human-friendly name for the project

_access

object

denied [required]

[object]

action [required]

string

reason [required]

object

resources

[string]

Resource specifier strings

notResources

[string]

Targeted resources are the resources NOT in this list. The resources and notActions fields must be empty to use this field.

actions

[string]

Actions to perform on a resource

notActions

[string]

Targeted actions are the actions NOT in this list. The actions and notResources fields must be empty to use this field.

effect [required]

enum

Whether this statement should allow or deny actions on the resources. Allowed enum values: allow,deny

role_name

string

allowed [required]

[object]

action [required]

string

reason [required]

object

resources

[string]

Resource specifier strings

notResources

[string]

Targeted resources are the resources NOT in this list. The resources and notActions fields must be empty to use this field.

actions

[string]

Actions to perform on a resource

notActions

[string]

Targeted actions are the actions NOT in this list. The actions and notResources fields must be empty to use this field.

effect [required]

enum

Whether this statement should allow or deny actions on the resources. Allowed enum values: allow,deny

role_name

string

tags [required]

[string]

A list of tags for the project

defaultReleasePipelineKey

string

The key of the default release pipeline for this project

environments

object

_links

object

The location and content type of related resources

totalCount

number

The number of environments returned

items [required]

[object]

An array of environments

_links [required]

object

The location and content type of related resources

_id [required]

string

The ID for the environment. Use this as the client-side ID for authorization in some client-side SDKs, and to associate LaunchDarkly environments with CDN integrations in edge SDKs.

key [required]

string

A project-unique key for the new environment

name [required]

string

A human-friendly name for the new environment

apiKey [required]

string

The SDK key for the environment. Use this for authorization in server-side SDKs.

mobileKey [required]

string

The mobile key for the environment. Use this for authorization in mobile SDKs.

color [required]

string

The color used to indicate this environment in the UI

defaultTtl [required]

number

The default time (in minutes) that the PHP SDK can cache feature flag rules locally

secureMode [required]

boolean

Ensures that one end user of the client-side SDK cannot inspect the variations for another end user

defaultTrackEvents [required]

boolean

Enables tracking detailed information for new flags by default

requireComments [required]

boolean

Whether members who modify flags and segments through the LaunchDarkly user interface are required to add a comment

confirmChanges [required]

boolean

Whether members who modify flags and segments through the LaunchDarkly user interface are required to confirm those changes

tags [required]

[string]

A list of tags for this environment

approvalSettings

object

required [required]

boolean

If approvals are required for this environment

bypassApprovalsForPendingChanges [required]

boolean

Whether to skip approvals for pending changes

minNumApprovals [required]

number

Sets the amount of approvals required before a member can apply a change. The minimum is one and the maximum is five.

canReviewOwnRequest [required]

boolean

Allow someone who makes an approval request to apply their own change

canApplyDeclinedChanges [required]

boolean

Allow applying the change as long as at least one person has approved

serviceKind [required]

string

Which service to use for managing approvals

serviceConfig [required]

object

requiredApprovalTags [required]

[string]

Require approval only on flags with the provided tags. Otherwise all flags will require approval.

critical [required]

boolean

Whether the environment is critical