POST /creator-configs-public-api/v1/experimentation/universes/{universeId}/experiments/{experimentId}:complete — openapi

Completes an experiment by stopping it and rolling out the requested variant.

Endpoint

Method: POST

Path: /creator-configs-public-api/v1/experimentation/universes/{universeId}/experiments/{experimentId}:complete

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universeId	path	true
experimentId	path	true

[
  {
    "name": "universeId",
    "in": "path",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "name": "experimentId",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Request Body

{
  "content": {
    "application/json-patch+json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/CompleteExperimentRequest"
          }
        ],
        "description": "Request body for\r\n`POST /v1/experimentation/universes/{universeId}/experiments/{experimentId}:complete`."
      }
    },
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/CompleteExperimentRequest"
          }
        ],
        "description": "Request body for\r\n`POST /v1/experimentation/universes/{universeId}/experiments/{experimentId}:complete`."
      }
    },
    "text/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/CompleteExperimentRequest"
          }
        ],
        "description": "Request body for\r\n`POST /v1/experimentation/universes/{universeId}/experiments/{experimentId}:complete`."
      }
    },
    "application/*+json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/CompleteExperimentRequest"
          }
        ],
        "description": "Request body for\r\n`POST /v1/experimentation/universes/{universeId}/experiments/{experimentId}:complete`."
      }
    }
  },
  "required": true
}

Responses

Status	Description
200	OK
400	Bad Request
401	Unauthorized
404	Not Found

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/CompleteExperimentResponse"
        }
      }
    }
  },
  "400": {
    "description": "Bad Request",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ActionResult"
        }
      }
    }
  },
  "401": {
    "description": "Unauthorized",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ActionResult"
        }
      }
    }
  },
  "404": {
    "description": "Not Found",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ActionResult"
        }
      }
    }
  }
}

Authentication

{
  "security": [
    {
      "roblox-legacy-cookie": []
    },
    {
      "roblox-api-key": []
    },
    {
      "roblox-oauth2": [
        "universe:write"
      ]
    }
  ],
  "securitySchemes": {
    "roblox-api-key": {
      "type": "apiKey",
      "description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
      "name": "x-api-key",
      "in": "header"
    },
    "roblox-legacy-cookie": {
      "type": "apiKey",
      "description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
      "in": "cookie",
      "name": ".ROBLOSECURITY"
    },
    "roblox-oauth2": {
      "type": "oauth2",
      "description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
      "flows": {
        "authorizationCode": {
          "authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
          "tokenUrl": "https://apis.roblox.com/oauth/v1/token",
          "refreshUrl": "https://apis.roblox.com/oauth/v1/token",
          "scopes": {}
        }
      }
    }
  }
}

Complete Operation Definition

{
  "tags": [
    "Experiments"
  ],
  "summary": "Completes an experiment by stopping it and rolling out the requested variant.",
  "operationId": "PublicExperimentation_CompleteExperiment",
  "parameters": [
    {
      "name": "universeId",
      "in": "path",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "experimentId",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json-patch+json": {
        "schema": {
          "allOf": [
            {
              "$ref": "#/components/schemas/CompleteExperimentRequest"
            }
          ],
          "description": "Request body for\r\n`POST /v1/experimentation/universes/{universeId}/experiments/{experimentId}:complete`."
        }
      },
      "application/json": {
        "schema": {
          "allOf": [
            {
              "$ref": "#/components/schemas/CompleteExperimentRequest"
            }
          ],
          "description": "Request body for\r\n`POST /v1/experimentation/universes/{universeId}/experiments/{experimentId}:complete`."
        }
      },
      "text/json": {
        "schema": {
          "allOf": [
            {
              "$ref": "#/components/schemas/CompleteExperimentRequest"
            }
          ],
          "description": "Request body for\r\n`POST /v1/experimentation/universes/{universeId}/experiments/{experimentId}:complete`."
        }
      },
      "application/*+json": {
        "schema": {
          "allOf": [
            {
              "$ref": "#/components/schemas/CompleteExperimentRequest"
            }
          ],
          "description": "Request body for\r\n`POST /v1/experimentation/universes/{universeId}/experiments/{experimentId}:complete`."
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/CompleteExperimentResponse"
          }
        }
      }
    },
    "400": {
      "description": "Bad Request",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ActionResult"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ActionResult"
          }
        }
      }
    },
    "404": {
      "description": "Not Found",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ActionResult"
          }
        }
      }
    }
  },
  "x-roblox-stability": "EXPERIMENTAL",
  "x-roblox-rate-limits": {
    "perApiKeyOwner": {
      "period": "MINUTE",
      "maxInPeriod": 10
    },
    "perOauth2Authorization": {
      "period": "MINUTE",
      "maxInPeriod": 10
    }
  },
  "x-roblox-scopes": [
    {
      "name": "universe:write",
      "targetResourceSpecifier": "universes"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-legacy-cookie": []
    },
    {
      "roblox-api-key": []
    },
    {
      "roblox-oauth2": [
        "universe:write"
      ]
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/experiments#PublicExperimentation_CompleteExperiment"
  }
}