feature-flags

Get a flag

Retrieve a specific feature flag by its ID or slug.

get/v1/projects/{projectIdOrName}/feature-flags/flags/{flagIdOrSlug}

Path parameters

projectIdOrNamestring required

The project id or name

The project id or name

flagIdOrSlugstring required

The flag id or name

The flag id or name

Query parameters

ifMatchstring

Etag to match, can be used interchangeably with the if-match header

Etag to match, can be used interchangeably with the if-match header

withMetadataboolean

Whether to include metadata in the response

Whether to include metadata in the response

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

descriptionstring
variantsobject[] required
idstring required
environmentsobject required
kind'boolean' | 'json' | 'number' | 'string' required
revisionnumber required
seednumber required
state'active' | 'archived' required
maintainerIdsstring[]
permanentfalse | true
tagsstring[]
slugstring required
createdAtnumber required
updatedAtnumber required
updatedBystring
createdBystring required
ownerIdstring required
projectIdstring required
typeName'flag' required

Changes

Changed in 6 of the 40 revisions of this API.81711

    • added subschema #4 to the environments/additionalProperties/fallthrough response property oneOf list for the response status 200

      response-property-one-of-added

    • added subschema #4 to the environments/additionalProperties/rules/items/outcome response property oneOf list for the response status 200

      response-property-one-of-added

    • removed subschema #4 from the environments/additionalProperties/fallthrough response property oneOf list for the response status 200

      response-property-one-of-removed

    • removed subschema #4 from the environments/additionalProperties/rules/items/outcome response property oneOf list for the response status 200

      response-property-one-of-removed

    • removed the optional property experiment from the response with the 200 status

      response-optional-property-removed

  • 4a14567fe8366167See the full diff
    • the response property experiment became nullable for the status 200

      response-property-became-nullable

    • added subschema #4 to the environments/additionalProperties/fallthrough response property oneOf list for the response status 200

      response-property-one-of-added

    • added subschema #4 to the environments/additionalProperties/rules/items/outcome response property oneOf list for the response status 200

      response-property-one-of-added

    • removed the required property experiment/allocationUnit from the response with the 200 status

      response-required-property-removed

    • removed the required property experiment/primaryMetrics from the response with the 200 status

      response-required-property-removed

    • removed the required property experiment/status from the response with the 200 status

      response-required-property-removed

    • removed the optional property experiment/allocationPercent from the response with the 200 status

      response-optional-property-removed

    • removed the optional property experiment/controlVariantId from the response with the 200 status

      response-optional-property-removed

    • removed the optional property experiment/decision from the response with the 200 status

      response-optional-property-removed

    • removed the optional property experiment/decisionReason from the response with the 200 status

      response-optional-property-removed

    • removed the optional property experiment/device from the response with the 200 status

      response-optional-property-removed

    • removed the optional property experiment/duration from the response with the 200 status

      response-optional-property-removed

    • removed the optional property experiment/durationUnit from the response with the 200 status

      response-optional-property-removed

    • removed the optional property experiment/endedAt from the response with the 200 status

      response-optional-property-removed

    • removed the optional property experiment/guardrailMetrics from the response with the 200 status

      response-optional-property-removed

    • removed the optional property experiment/hypothesis from the response with the 200 status

      response-optional-property-removed

    • removed the optional property experiment/layer from the response with the 200 status

      response-optional-property-removed

    • removed the optional property experiment/name from the response with the 200 status

      response-optional-property-removed

    • removed the optional property experiment/numVariants from the response with the 200 status

      response-optional-property-removed

    • removed the optional property experiment/startedAt from the response with the 200 status

      response-optional-property-removed

    • removed the optional property experiment/stickyRequirement from the response with the 200 status

      response-optional-property-removed

    • removed the optional property experiment/surfaceArea from the response with the 200 status

      response-optional-property-removed

    • added the optional property experiment/rampId to the response with the 200 status

      response-optional-property-added

    • added the optional property experiment/rampPercentage to the response with the 200 status

      response-optional-property-added

    • the response property experiment/id became required for the status 200

      response-property-became-required

    • added the required property experiment/base to the response with the 200 status

      response-required-property-added

    • added the required property experiment/defaultVariantId to the response with the 200 status

      response-required-property-added

    • added the required property experiment/exposureLogging to the response with the 200 status

      response-required-property-added

    • added the required property experiment/weights to the response with the 200 status

      response-required-property-added

    • added the optional property updatedBy to the response with the 200 status

      response-optional-property-added

    • added the non-success response with the status 410

      response-non-success-status-added

Of the 40 revisions, 1 has no diff computed.