Rollout Groups

Lists rollout groups within a project

GET /api/{spaceId}/projects/{projectId}/featuretoggles/rollout-groups

Also reachable at /api/spaces/{spaceIdentifier}/projects/{projectId}/featuretoggles/rollout-groups.

Path Parameters

projectId string (required)
spaceId string (required)

Query Parameters

partialName string
Filters results to rollout groups whose name contains this text (case-insensitive substring match).
skip integer (required)
Number of items to skip. Defaults to zero. Minimum 0.
take integer (required)
Number of items to take. Defaults to 30. Minimum 0.

Response

200 — Success

ItemType string
The type of item in this list.
Items array of object
- FeatureToggleUsages array of object
- Id string
- Name string
  Minimum length 1.
- ProjectId string
- SpaceId string
ItemsPerPage integer
LastPageNumber integer
NumberOfPages integer
TotalResults integer

{
  "ItemType": "RolloutGroup",
  "Items": [
    {
      "FeatureToggleUsages": [
        {}
      ],
      "Id": "string",
      "Name": "string",
      "ProjectId": "Projects-1",
      "SpaceId": "Spaces-1"
    }
  ],
  "ItemsPerPage": 30,
  "LastPageNumber": 1,
  "NumberOfPages": 2,
  "TotalResults": 42
}

Creates a rollout group within a project

POST /api/{spaceId}/projects/{projectId}/featuretoggles/rollout-groups

Also reachable at /api/spaces/{spaceIdentifier}/projects/{projectId}/featuretoggles/rollout-groups.

Path Parameters

projectId string (required)
spaceId string (required)

Request Body

Name string (required)
Minimum length 1. Maximum length 200.
ProjectId string (required)
SpaceId string (required)

Response

201 — Created

FeatureToggleUsages array of object
- Id string
- Name string
  Minimum length 1.
Id string
Name string
Minimum length 1.
ProjectId string
SpaceId string

{
  "Name": "string",
  "ProjectId": "Projects-1",
  "SpaceId": "Spaces-1"
}

{
  "FeatureToggleUsages": [
    {
      "Id": "string",
      "Name": "string"
    }
  ],
  "Id": "string",
  "Name": "string",
  "ProjectId": "Projects-1",
  "SpaceId": "Spaces-1"
}

Retrieves a rollout group by Id

GET /api/{spaceId}/projects/{projectId}/featuretoggles/rollout-groups/{id}

Also reachable at /api/spaces/{spaceIdentifier}/projects/{projectId}/featuretoggles/rollout-groups/{id}.

Path Parameters

id string (required)
projectId string (required)
spaceId string (required)

Response

200 — A rollout group within a project, used to link rollout percentages between feature toggles.

FeatureToggleUsages array of object
- Id string
- Name string
  Minimum length 1.
Id string
Name string
Minimum length 1.
ProjectId string
SpaceId string

{
  "FeatureToggleUsages": [
    {
      "Id": "string",
      "Name": "string"
    }
  ],
  "Id": "string",
  "Name": "string",
  "ProjectId": "Projects-1",
  "SpaceId": "Spaces-1"
}

Modifies a rollout group

PUT /api/{spaceId}/projects/{projectId}/featuretoggles/rollout-groups/{id}

Also reachable at /api/spaces/{spaceIdentifier}/projects/{projectId}/featuretoggles/rollout-groups/{id}.

Path Parameters

id string (required)
projectId string (required)
spaceId string (required)

Request Body

Id string (required)
Name string (required)
Minimum length 1. Maximum length 200.
ProjectId string (required)
SpaceId string (required)

Response

200 — A rollout group within a project, used to link rollout percentages between feature toggles.

FeatureToggleUsages array of object
- Id string
- Name string
  Minimum length 1.
Id string
Name string
Minimum length 1.
ProjectId string
SpaceId string

{
  "Id": "string",
  "Name": "string",
  "ProjectId": "Projects-1",
  "SpaceId": "Spaces-1"
}

{
  "FeatureToggleUsages": [
    {
      "Id": "string",
      "Name": "string"
    }
  ],
  "Id": "string",
  "Name": "string",
  "ProjectId": "Projects-1",
  "SpaceId": "Spaces-1"
}

Deletes a rollout group

DELETE /api/{spaceId}/projects/{projectId}/featuretoggles/rollout-groups/{id}

Also reachable at /api/spaces/{spaceIdentifier}/projects/{projectId}/featuretoggles/rollout-groups/{id}.

Path Parameters

id string (required)
projectId string (required)
spaceId string (required)

Response

200 — Response from deleting a rollout group.

{}