Skip to main content
POST
/
v1
/
segments
/
{segment}
:archive
Archive Segment
curl --request POST \
  --url https://flags.eu.confidence.dev/v1/segments/{segment}:archive \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "displayName": "<string>",
  "description": "<string>",
  "targeting": {
    "criteria": [
      {}
    ],
    "expression": {
      "ref": "<string>",
      "not": {},
      "and": {
        "operands": [
          {}
        ]
      },
      "or": {
        "operands": [
          {}
        ]
      }
    }
  },
  "allocation": {
    "proportion": {
      "value": "<string>"
    },
    "exclusivityTags": [
      "<string>"
    ],
    "exclusiveTo": [
      "<string>"
    ]
  },
  "state": "STATE_UNSPECIFIED",
  "bitsetAllocation": {
    "bitset": {}
  },
  "labels": [
    {}
  ],
  "workflowInstance": "<string>",
  "flag": "<string>",
  "owner": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://confidence.spotify.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
segment
string
required

Body

application/json

The body is of type object.

Response

200 - application/json

Returns a Segment.

A reusable slice of an entity population.

​
createTime
object
required

Time when the segment was first created.

​
updateTime
object
required

Time when the segment was last updated.

​
creator
string
required

Reference to the identity that created this segment.

​
updater
string
required

Reference to the identity that last updated this segment.

​
name
string

The resource name of the segment. For example: segments/0smva5nxuhv4yts6paxt

​
displayName
string

A human-friendly name for the segment.

​
description
string

A description for the segment.

​
targeting
Targeting · object

Targeting: The targeting that this segment adheres to.

​
allocation
object

How much of the total population that is allocated to this segment, and the coordination with other segments.

​
state
enum<string>

Current state of the segment.

Available options:
STATE_UNSPECIFIED,
OK,
UNALLOCATED,
ALLOCATED,
ARCHIVED
​
bitsetAllocation
object

A bitset representing the buckets that are allocated for this segment.

​
labels
object[]

General labels for this resource.

​
workflowInstance
string

The workflow instance that created this segment. If set, permissions will be inherited from the workflow instance, in addition to the segment permissions.

​
flag
string

The flag owning the rule this segment is connected to. If set, permissions will be inherited from the flag, in addition to the segment permissions.

​
owner
string

The owner of the resource. If not set will default to the creator.