Split.io (version v1.*.*)

Admin API for Split.io

associate_tags

Associate Tags

Parameters

object_name (required)

Type: string

object_type (required)

Type: string

ws_id (required)

The ID of the workspace

Type: string

$body

End state of tags assocated with the object

Type: array

[ "string" ]

create_environment

Create Environment

Parameters

ws_id (required)

The ID of the workspace

Type: string

$body

JSON object that contains the name of the environment

Type: object

{ }

create_event

Create Event

Parameters

$body

Type: object

{ }

SplitSDKMachineIP

The IP address of the machine issuing the request

Type: string

SplitSDKMachineName

The name of the machine issuing the request.

Type: string

SplitSDKVersion

This is your sdk and version appended with a '-' in between.

Type: string

create_events

Create Events

Parameters

$body

Type: object

{ }

SplitSDKMachineIP

The IP address of the machine issuing the request

Type: string

SplitSDKMachineName

The name of the machine issuing the request.

Type: string

SplitSDKVersion

This is your sdk and version appended with a '-' in between.

Type: string

create_segment

Create Segment

Parameters

traffic_type_id_or_name (required)

The ID or name of the traffic type

Type: string

ws_id (required)

The ID of the workspace

Type: string

$body

JSON object that contains the name and description of the Split.

Type: object

{ }

create_split

Create Split

Parameters

traffic_type_id_or_name (required)

The ID or name of the traffic type

Type: string

ws_id (required)

The ID of the workspace

Type: string

$body

JSON object that contains the name and description of the Split.

Type: object

{ }

create_split_definition_in_environment

Create Split Definition in Environment

Parameters

environment_name_or_id (required)

Environment name or ID

Type: string

split_name (required)

Type: string

ws_id (required)

The ID of the workspace

Type: string

$body

JSON object that contains the split

Type: object

{ }

deactivate_segment_in_environment

Deactivate Segment in Environment

Parameters

environment_id (required)

the ID of the environment

Type: string

segment_name (required)

Type: string

delete_attribute

Delete Attribute

Parameters

attribute_id (required)

Type: string

traffic_type_id_or_name (required)

The ID or name of the traffic type

Type: string

ws_id (required)

The ID of the workspace

Type: string

delete_environment

Delete Environment

Parameters

environment_name_or_id (required)

Environment name or ID

Type: string

ws_id (required)

The ID of the workspace

Type: string

delete_identity

Delete Identity

Parameters

environment_id (required)

the ID of the environment

Type: string

key (required)

Type: string

traffic_type_id (required)

Type: string

delete_segment

Delete Segment

Parameters

segment_name (required)

Type: string

ws_id (required)

The ID of the workspace

Type: string

delete_split

Delete Split

Parameters

split_name (required)

Type: string

ws_id (required)

The ID of the workspace

Type: string

enable_segment_in_environment

Enable Segment in Environment

Parameters

environment_id (required)

the ID of the environment

Type: string

segment_name (required)

Type: string

full_update_split_definition_in_environment

Full Update Split Definition in Environment

Parameters

environment_name_or_id (required)

Environment name or ID

Type: string

split_name (required)

Type: string

ws_id (required)

The ID of the workspace

Type: string

$body

JSON object that contains the full split definition to be updated

Type: object

{ }

get_change_request

Get Change Request

Parameters

change_request_id (required)

Type: string

get_split

Get Split

Parameters

split_name (required)

Type: string

ws_id (required)

The ID of the workspace

Type: string

get_split_definition_in_environment

Get Split Definition in Environment

Parameters

environment_name_or_id (required)

Environment name or ID

Type: string

split_name (required)

Type: string

ws_id (required)

The ID of the workspace

Type: string

kill_split_in_environment

Kill Split in Environment

Parameters

environment_name_or_id (required)

Environment name or ID

Type: string

split_name (required)

Type: string

ws_id (required)

The ID of the workspace

Type: string

list_attributes

List Attributes

Parameters

traffic_type_id_or_name (required)

The ID or name of the traffic type

Type: string

ws_id (required)

The ID of the workspace

Type: string

list_environments

List Environments

Parameters

ws_id (required)

The ID of the workspace

Type: string

list_segment_keys_in_environment

List Segment Keys in Environment

Parameters

environment_id (required)

the ID of the environment

Type: string

segment_name (required)

Type: string

list_segments

List Segments

Parameters

ws_id (required)

The ID of the workspace

Type: string

tag

Type: array

[ "string" ]

list_segments_in_environment

List Segments in Environment

Parameters

environment_name_or_id (required)

Environment name or ID

Type: string

ws_id (required)

The ID of the workspace

Type: string

list_splits

List Splits

Parameters

ws_id (required)

The ID of the workspace

Type: string

tag

repeatable tag parameter(s) to query by

Type: string

list_traffic_types

List Traffic Types

Parameters

ws_id (required)

The ID of the workspace

Type: string

list_workspaces

List Workspaces

This operation has no parameters

lists_split_definitions_in_environment

Lists Split Definitions in Environment

Parameters

environment_name_or_id (required)

Environment name or ID

Type: string

ws_id (required)

The ID of the workspace

Type: string

partial_update_split_definition_in_environment

Partial Update Split Definition in Environment

Parameters

environment_name_or_id (required)

Environment name or ID

Type: string

split_name (required)

Type: string

ws_id (required)

The ID of the workspace

Type: string

$body

JSON object that contains the attributes of a split to be updated in JsonPatch format

Type: object

{ }

comment

Describe and explain the change you're making

Type: string

remove_segment_keys_from_environment

Remove Segment Keys from Environment

Parameters

environment_id (required)

the ID of the environment

Type: string

segment_name (required)

Type: string

remove_split_definition_from_environment

Remove Split Definition from Environment

Parameters

environment_name_or_id (required)

Environment name or ID

Type: string

split_name (required)

Type: string

ws_id (required)

The ID of the workspace

Type: string

comment

Describe and explain the change you're making

Type: string

restore_split_in_environment

Restore Split in Environment

Parameters

environment_name_or_id (required)

Environment name or ID

Type: string

split_name (required)

Type: string

ws_id (required)

The ID of the workspace

Type: string

save_attribute

Save Attribute

Parameters

traffic_type_id_or_name (required)

The ID or name of the traffic type

Type: string

ws_id (required)

The ID of the workspace

Type: string

save_identities

Save Identities

Parameters

environment_id (required)

the ID of the environment

Type: string

traffic_type_id (required)

Type: string

save_identity

Save Identity

Parameters

environment_id (required)

the ID of the environment

Type: string

key (required)

Type: string

traffic_type_id (required)

Type: string

submit_change_request

Submit Change Request

Parameters

environment_id (required)

the ID of the environment

Type: string

ws_id (required)

The ID of the workspace

Type: string

update_environment

Update Environment

Parameters

environment_name_or_id (required)

Environment name or ID

Type: string

ws_id (required)

The ID of the workspace

Type: string

$body

JSON object that contains the attributes of a environment to be updated in JsonPatch format

Type: object

{ }

update_identity

Update Identity

Parameters

environment_id (required)

the ID of the environment

Type: string

key (required)

Type: string

traffic_type_id (required)

Type: string

update_segment_keys_in_environment_via_csv

Update Segment Keys in Environment via CSV

Parameters

environment_id (required)

the ID of the environment

Type: string

segment_name (required)

Type: string

$body

The location of the file to upload

Type: string

replace

Replace the content of the segment (if it previously exists) with the new content

Type: boolean

update_segment_keys_in_environment_via_json

Update Segment Keys in Environment via JSON

Parameters

environment_id (required)

the ID of the environment

Type: string

segment_name (required)

Type: string

replace

Replace the content of the segment (if it previously exists) with the new content

Type: boolean

update_split_description

Update Split Description

Parameters

split_name (required)

Type: string

ws_id (required)

The ID of the workspace

Type: string

$body

JSON Object with the description

Type: object

{ }

withdraw_change_request

Withdraw Change Request

Parameters

change_request_id (required)

Type: string