Feature flag

The Feature flag object type represents a feature flag object. atlassian:feature-flag should be used to ingest feature flag-specific fields.

Payload structure

1
2
  objects {}
  ├─ schemaVersion (string) [Required]
  ├─ id (string) [Required]
  ├─ updateSequenceNumber (long) [Required]
  ├─ displayName (string) [Optional]
  ├─ description (string) [Optional]
  ├─ url (string) [Optional]
  ├─ createdAt (Instant (ISO8601 / RFC3339)) [Optional]
  └─ createdBy (userReference) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Optional]
  └─ lastUpdatedAt (Instant (ISO8601 / RFC3339)) [Optional]
  └─ lastUpdatedBy (userReference) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Optional]
  └─ permissions [] [Required]
      └─ accessControls
         └─ principals
            └─type
  └─ associations [] [Optional]
      ├─ associationType (string)
      └─ values []

  atlassian:feature-flag
  ├─ key (string) [Required]
  ├─ updateSequenceId (number) [Optional]
  ├─ summary (FeatureFlagSummary) [Required]
      ├─ url (string) [Optional]
      ├─ status (FeatureFlagStatus) [Required]
          ├─ enabled (boolean) [Required]
          ├─ defaultValue (string) [Optional]
          └─ rollout (FeatureFlagRollout) [Optional]
              ├─ percentage (number) [Optional]
              ├─ text (string) [Optional]
              └─ rules (number) [Optional]
      └─ lastUpdated (string) [Required]
  └─ details (List<FeatureFlagDetails>) [Required]
      ├─ url (string) [Optional]
      ├─ lastUpdated (string) [Required]
      ├─ status (FeatureFlagStatus) [Required]
          ├─ enabled (boolean) [Required]
          ├─ defaultValue (string) [Optional]
          └─ rollout (FeatureFlagRollout) [Optional]
              ├─ percentage (number) [Optional]
              ├─ text (string) [Optional]
              └─ rules (number) [Optional]
      └─ environment (FeatureFlagEnvironment) [Optional]
          ├─ name (string) [Required]
          └─ type (EnvironmentType) [Optional]

Common properties

Feature flag properties

Example payload

1
2
{
  "objects" : [ {
    "schemaVersion" : "2.0",
    "id" : "feature-flag-1",
    "updateSequenceNumber" : 1,
    "displayName" : "New Checkout Flow",
    "description" : "Feature flag controlling the new checkout flow",
    "url" : "https://featureflag.example.com/flags/new-checkout-flow",
    "createdAt" : "2024-07-01T05:00:45Z",
    "createdBy" : {
      "externalId" : "external-id-1"
    },
    "lastUpdatedAt" : "2024-07-09T14:27:37.000Z",
    "lastUpdatedBy" : {
      "externalId" : "external-id-1"
    },
    "permissions" : [ {
      "accessControls" : [ {
        "principals" : [ {
          "type" : "ATLASSIAN_WORKSPACE"
        } ]
      } ]
    } ],
    "atlassian:feature-flag" : {
      "key" : "new-checkout-flow",
      "updateSequenceId" : 123,
      "summary" : {
        "url" : "https://featureflag.example.com/flags/new-checkout-flow",
        "status" : {
          "enabled" : true,
          "defaultValue" : "true",
          "rollout" : {
            "percentage" : 50,
            "text" : "Rolled out to 50% of users",
            "rules" : 2
          }
        },
        "lastUpdated" : "2024-07-09T14:27:37.000Z"
      },
      "details" : [ {
        "url" : "https://featureflag.example.com/flags/new-checkout-flow/production",
        "lastUpdated" : "2024-07-09T14:27:37.000Z",
        "status" : {
          "enabled" : true,
          "defaultValue" : "true",
          "rollout" : {
            "percentage" : 50,
            "text" : "Rolled out to 50% of users",
            "rules" : 2
          }
        },
        "environment" : {
          "name" : "Production",
          "type" : "PRODUCTION"
        }
      }, {
        "url" : "https://featureflag.example.com/flags/new-checkout-flow/staging",
        "lastUpdated" : "2024-07-08T10:15:22.000Z",
        "status" : {
          "enabled" : true,
          "defaultValue" : "true",
          "rollout" : {
            "percentage" : 100,
            "text" : "Fully rolled out",
            "rules" : 1
          }
        },
        "environment" : {
          "name" : "Staging",
          "type" : "STAGING"
        }
      } ]
    }
  } ]
}