GAgamebeast
Experiments (V2)

Create experiment

Changed on

Create a new experiment on a configuration. Validates group weights, changeset operations, scheduling constraints, and path-lock conflicts.

post/application/{applicationId}/v2/experiments

Request

  • Base URL
    https://api.gamebeast.gg
  • Auth
    HTTP bearer

Path parameters

applicationIdnumber required

Gamebeast project ID

Headers

environment_idnumber required

Gamebeast environment ID

Request body

namestring required
descriptionstring nullable
baseConfigurationIdinteger required
unitType'user' | 'server' required
autoAssignmentboolean
assignmentMode'weightedHash' | 'roundRobin' required
permanentEnrollmentboolean
exclusiveboolean
startsAtstring date-time nullable
endsAtstring date-time nullable

Response

Default Response

idinteger required
applicationIdinteger required
environmentIdinteger required
baseConfigurationIdinteger required
namestring required
descriptionstring nullable required
access'public' | 'private' required
unitType'user' | 'server' required
autoAssignmentboolean required
assignmentMode'weightedHash' | 'roundRobin' required
permanentEnrollmentboolean required
exclusiveboolean required
requiredPropertiesstring[] required
state'scheduled' | 'pending' | 'active' | 'ended' | 'terminated' required
startsAtstring date-time required
endsAtstring date-time nullable required
terminatedAtstring date-time nullable required
createdBystring uuid required
terminatedBystring uuid nullable required
createdAtstring date-time required
updatedAtstring date-time required

Changes

  • efdc00220d24Revision changes
    • warning

      added the new pending enum value to the response property for the response status

    • info

      added the required property to the response with the status

  • c00591dedd1fRevision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status