Browse Feature Flags Configuration

stable · api · 0.1.0

Get the latest Feature Flag and Configuration version

GET /api/v1/feature-configuration

Capability Domain: Feature Flags Configuration

Authentication

projectCredential (configuration:read)

Scope: configuration:read

Parameters and request body

  • X-Correlation-ID — header, optional
    X-Correlation-ID schema
    {
        "type": "string",
        "format": "uuid"
    }
  • If-None-Match — header, optional

    ETag returned with the last valid configuration.

    If-None-Match schema
    {
        "type": "string"
    }

Responses and errors

StatusDescription
200Latest immutable client-scoped configuration version
304The cached version is still current
401Invalid or revoked Project Credential
403Project Credential lacks the required scope
404No configuration version has been published for this Project Client

200 schema

200 response schema
{
    "type": "object",
    "required": [
        "data"
    ],
    "properties": {
        "data": {
            "type": "object",
            "required": [
                "id",
                "version",
                "published_at",
                "max_age_seconds",
                "flags",
                "configuration",
                "secret_references"
            ],
            "properties": {
                "id": {
                    "type": "string",
                    "format": "uuid"
                },
                "version": {
                    "type": "integer",
                    "minimum": 1
                },
                "published_at": {
                    "type": "string"
                },
                "max_age_seconds": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 86400
                },
                "flags": {
                    "type": "object",
                    "maxProperties": 100,
                    "additionalProperties": {
                        "type": "object",
                        "required": [
                            "enabled",
                            "safe_default"
                        ],
                        "properties": {
                            "enabled": {
                                "type": "boolean"
                            },
                            "safe_default": {
                                "type": "boolean"
                            }
                        }
                    }
                },
                "configuration": {
                    "type": "object",
                    "maxProperties": 100
                },
                "secret_references": {
                    "type": "object",
                    "maxProperties": 100,
                    "additionalProperties": {
                        "type": "string"
                    }
                }
            }
        }
    }
}

401 schema

401 response schema
{
    "type": "object",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "type": "object",
            "required": [
                "code",
                "message",
                "retryable",
                "correlation_id",
                "details"
            ],
            "properties": {
                "code": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "retryable": {
                    "type": "boolean"
                },
                "correlation_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "details": {
                    "type": "object"
                }
            }
        }
    }
}

403 schema

403 response schema
{
    "type": "object",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "type": "object",
            "required": [
                "code",
                "message",
                "retryable",
                "correlation_id",
                "details"
            ],
            "properties": {
                "code": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "retryable": {
                    "type": "boolean"
                },
                "correlation_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "details": {
                    "type": "object"
                }
            }
        }
    }
}

404 schema

404 response schema
{
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

200 example

200 response example
{
    "data": {
        "id": "8a000000-0000-4000-8000-000000000001",
        "version": 7,
        "published_at": "2026-08-01T01:00:00Z",
        "max_age_seconds": 300,
        "flags": {
            "new_checkout": {
                "enabled": true,
                "safe_default": false
            }
        },
        "configuration": {
            "support_url": "https://support.example.com"
        },
        "secret_references": {
            "mailgun": "projects/minicenter/secrets/mailgun-api-key/versions/latest"
        }
    }
}

404 example

404 response example
{
    "message": "No records found."
}

Idempotency

Safe read. Send If-None-Match with the last ETag to receive 304 when the version is unchanged.