GET /v2/ota-version/{binaryType} — openapi

Get OTA information for a specific binary type with a given version on some channel. Returns empty list if no updates are found or channel/application with the given version does not exist in CVS.

Endpoint

Method: GET

Path: /v2/ota-version/{binaryType}

Servers:

https://clientsettings.roblox.com

Parameters

Name	Location	Required	Description
binaryType	path	true	Binary type of the application to get info for
channel	query	false	Channel name. If not provided, production is assumed.
version	query	false	Application version
tag	query	false	Tag to filter results by. Only applicable to non-studio application types.
name	query	false	Name to filter results by. Only applicable to non-studio application types.

[
  {
    "in": "path",
    "name": "binaryType",
    "description": "Binary type of the application to get info for",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "channel",
    "description": "Channel name. If not provided, production is assumed.",
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "version",
    "description": "Application version",
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "tag",
    "description": "Tag to filter results by. Only applicable to non-studio application types.",
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "name",
    "description": "Name to filter results by. Only applicable to non-studio application types.",
    "schema": {
      "type": "string"
    }
  }
]

Responses

Status	Description
200	OK
400	2: Invalid binaryType. 4: Invalid app version. 6: Missing or invalid channel. 7: Unsupported binaryType.
401	5: Not authorized to perform this action.
501	9: The requested tag is not implemented.

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Roblox.ClientSettings.Api.Models.Response.OtaVersionResponse"
          }
        }
      },
      "text/json": {
        "schema": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Roblox.ClientSettings.Api.Models.Response.OtaVersionResponse"
          }
        }
      }
    }
  },
  "400": {
    "description": "2: Invalid binaryType.\r\n4: Invalid app version.\r\n6: Missing or invalid channel.\r\n7: Unsupported binaryType."
  },
  "401": {
    "description": "5: Not authorized to perform this action."
  },
  "501": {
    "description": "9: The requested tag is not implemented."
  }
}

Authentication

{
  "security": [
    {},
    {
      "roblox-legacy-cookie": []
    }
  ],
  "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": {}
        }
      }
    }
  }
}

Roblox.ClientSettings.Api.Models.Response.OtaVersionResponse

Complete Operation Definition

{
  "tags": [
    "Metadata"
  ],
  "summary": "Get OTA information for a specific binary type with a given version on some channel.\nReturns empty list if no updates are found or channel/application with the given version does not exist in CVS.",
  "parameters": [
    {
      "in": "path",
      "name": "binaryType",
      "description": "Binary type of the application to get info for",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "channel",
      "description": "Channel name. If not provided, production is assumed.",
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "version",
      "description": "Application version",
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "tag",
      "description": "Tag to filter results by. Only applicable to non-studio application types.",
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "name",
      "description": "Name to filter results by. Only applicable to non-studio application types.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Roblox.ClientSettings.Api.Models.Response.OtaVersionResponse"
            }
          }
        },
        "text/json": {
          "schema": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Roblox.ClientSettings.Api.Models.Response.OtaVersionResponse"
            }
          }
        }
      }
    },
    "400": {
      "description": "2: Invalid binaryType.\r\n4: Invalid app version.\r\n6: Missing or invalid channel.\r\n7: Unsupported binaryType."
    },
    "401": {
      "description": "5: Not authorized to perform this action."
    },
    "501": {
      "description": "9: The requested tag is not implemented."
    }
  },
  "servers": [
    {
      "url": "https://clientsettings.roblox.com"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {},
    {
      "roblox-legacy-cookie": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/metadata#clientsettings_get_v2_ota_version__binaryType_"
  }
}