--- title: Archive a feature flag description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Feature Flags --- # Archive a feature flag{% #archive-a-feature-flag %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | --------------------------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/feature-flags/{feature_flag_id}/archive | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/feature-flags/{feature_flag_id}/archive | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/feature-flags/{feature_flag_id}/archive | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/feature-flags/{feature_flag_id}/archive | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/feature-flags/{feature_flag_id}/archive | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/feature-flags/{feature_flag_id}/archive | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/feature-flags/{feature_flag_id}/archive | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/feature-flags/{feature_flag_id}/archive | ### Overview Archives a feature flag. Archived flags are hidden from the main list but remain accessible and can be unarchived. This endpoint requires all of the following permissions: `feature_flag_config_write``feature_flag_environment_config_read` ### Arguments #### Path Parameters | Name | Type | Description | | --------------------------------- | ------ | --------------------------- | | feature_flag_id [*required*] | string | The ID of the feature flag. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Response containing a feature flag. | Parent field | Field | Type | Description | | ------------------------- | -------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------ | | | data [*required*] | object | A feature flag resource. | | data | attributes [*required*] | object | Attributes of a feature flag. | | attributes | archived_at | date-time | The timestamp when the feature flag was archived. | | attributes | created_at | date-time | The timestamp when the feature flag was created. | | attributes | created_by | uuid | The ID of the user who created the feature flag. | | attributes | description [*required*] | string | The description of the feature flag. | | attributes | distribution_channel | string | Distribution channel for the feature flag. | | attributes | feature_flag_environments | [object] | Environment-specific settings for the feature flag. | | feature_flag_environments | allocations | object | Allocation metadata for this environment. | | feature_flag_environments | default_allocation_key | string | The allocation key used for the default variant. | | feature_flag_environments | default_variant_id | string | The ID of the default variant for this environment. | | feature_flag_environments | environment_id [*required*] | uuid | The ID of the environment. | | feature_flag_environments | environment_name | string | The name of the environment. | | feature_flag_environments | environment_queries | [string] | Queries that target this environment. | | feature_flag_environments | is_production | boolean | Indicates whether the environment is production. | | feature_flag_environments | override_allocation_key | string | The allocation key used for the override variant. | | feature_flag_environments | override_variant_id | string | The ID of the override variant for this environment. | | feature_flag_environments | pending_suggestion_id | string | Pending suggestion identifier, if approval is required. | | feature_flag_environments | require_feature_flag_approval | boolean | Indicates whether feature flag changes require approval in this environment. | | feature_flag_environments | status [*required*] | enum | The status of a feature flag in an environment. Allowed enum values: `ENABLED,DISABLED` | | attributes | json_schema | string | JSON schema for validation when value_type is JSON. | | attributes | key [*required*] | string | The unique key of the feature flag. | | attributes | last_updated_by | uuid | The ID of the user who last updated the feature flag. | | attributes | name [*required*] | string | The name of the feature flag. | | attributes | require_approval | boolean | Indicates whether this feature flag requires approval for changes. | | attributes | staleness_status | string | Indicates the whether a feature flag is stale or not. | | attributes | tags | [string] | Tags associated with the feature flag. | | attributes | updated_at | date-time | The timestamp when the feature flag was last updated. | | attributes | value_type [*required*] | enum | The type of values for the feature flag variants. Allowed enum values: `BOOLEAN,INTEGER,NUMERIC,STRING,JSON` | | attributes | variants [*required*] | [object] | The variants of the feature flag. | | variants | created_at | date-time | The timestamp when the variant was created. | | variants | id [*required*] | uuid | The unique identifier of the variant. | | variants | key [*required*] | string | The unique key of the variant. | | variants | name [*required*] | string | The name of the variant. | | variants | updated_at | date-time | The timestamp when the variant was last updated. | | variants | value [*required*] | string | The value of the variant as a string. | | data | id [*required*] | uuid | The unique identifier of the feature flag. | | data | type [*required*] | enum | The resource type. Allowed enum values: `feature-flags` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "archived_at": "2023-01-01T00:00:00Z", "created_at": "2023-01-01T00:00:00Z", "created_by": "550e8400-e29b-41d4-a716-446655440010", "description": "This is an example feature flag for demonstration", "distribution_channel": "ALL", "feature_flag_environments": [ { "allocations": {}, "default_allocation_key": "allocation-default-123abc", "default_variant_id": "550e8400-e29b-41d4-a716-446655440002", "environment_id": "550e8400-e29b-41d4-a716-446655440001", "environment_name": "env-search-term", "environment_queries": [ "test-feature-flag", "env-search-term" ], "is_production": false, "override_allocation_key": "allocation-override-123abc", "override_variant_id": "550e8400-e29b-41d4-a716-446655440003", "pending_suggestion_id": "550e8400-e29b-41d4-a716-446655440099", "require_feature_flag_approval": false, "status": "ENABLED" } ], "json_schema": "{\"type\": \"object\", \"properties\": {\"enabled\": {\"type\": \"boolean\"}}}", "key": "feature-flag-abc123", "last_updated_by": "550e8400-e29b-41d4-a716-446655440010", "name": "Feature Flag ABC123", "require_approval": false, "staleness_status": "ACTIVE", "tags": [ [] ], "updated_at": "2023-01-01T00:00:00Z", "value_type": "BOOLEAN", "variants": [ { "created_at": "2023-01-01T00:00:00Z", "id": "550e8400-e29b-41d4-a716-446655440002", "key": "variant-abc123", "name": "Variant ABC123", "updated_at": "2023-01-01T00:00:00Z", "value": "true" } ] }, "id": "550e8400-e29b-41d4-a716-446655440000", "type": "feature-flags" } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Not Found {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parameters export feature_flag_id="550e8400-e29b-41d4-a716-446655440000" \# Curl command curl -X POST "https://api.datadoghq.com/api/v2/feature-flags/${feature_flag_id}/archive" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Archive a feature flag returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.feature_flags_api import FeatureFlagsApi # there is a valid "feature_flag" in the system FEATURE_FLAG_DATA_ID = environ["FEATURE_FLAG_DATA_ID"] configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = FeatureFlagsApi(api_client) response = api_instance.archive_feature_flag( feature_flag_id=FEATURE_FLAG_DATA_ID, ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Archive a feature flag returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::FeatureFlagsAPI.new # there is a valid "feature_flag" in the system FEATURE_FLAG_DATA_ID = ENV["FEATURE_FLAG_DATA_ID"] p api_instance.archive_feature_flag(FEATURE_FLAG_DATA_ID) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Archive a feature flag returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" "github.com/google/uuid" ) func main() { // there is a valid "feature_flag" in the system FeatureFlagDataID := uuid.MustParse(os.Getenv("FEATURE_FLAG_DATA_ID")) ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewFeatureFlagsApi(apiClient) resp, r, err := api.ArchiveFeatureFlag(ctx, FeatureFlagDataID) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `FeatureFlagsApi.ArchiveFeatureFlag`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `FeatureFlagsApi.ArchiveFeatureFlag`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Archive a feature flag returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.FeatureFlagsApi; import com.datadog.api.client.v2.model.FeatureFlagResponse; import java.util.UUID; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); FeatureFlagsApi apiInstance = new FeatureFlagsApi(defaultClient); // there is a valid "feature_flag" in the system UUID FEATURE_FLAG_DATA_ID = null; try { FEATURE_FLAG_DATA_ID = UUID.fromString(System.getenv("FEATURE_FLAG_DATA_ID")); } catch (IllegalArgumentException e) { System.err.println("Error parsing UUID: " + e.getMessage()); } try { FeatureFlagResponse result = apiInstance.archiveFeatureFlag(FEATURE_FLAG_DATA_ID); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling FeatureFlagsApi#archiveFeatureFlag"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Archive a feature flag returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_feature_flags::FeatureFlagsAPI; #[tokio::main] async fn main() { // there is a valid "feature_flag" in the system let feature_flag_data_id = uuid::Uuid::parse_str(&std::env::var("FEATURE_FLAG_DATA_ID").unwrap()) .expect("Invalid UUID"); let configuration = datadog::Configuration::new(); let api = FeatureFlagsAPI::with_config(configuration); let resp = api.archive_feature_flag(feature_flag_data_id.clone()).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Archive a feature flag returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.FeatureFlagsApi(configuration); // there is a valid "feature_flag" in the system const FEATURE_FLAG_DATA_ID = process.env.FEATURE_FLAG_DATA_ID as string; const params: v2.FeatureFlagsApiArchiveFeatureFlagRequest = { featureFlagId: FEATURE_FLAG_DATA_ID, }; apiInstance .archiveFeatureFlag(params) .then((data: v2.FeatureFlagResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}