GET /v2/compression-dictionaries/{dictionarySha256} — openapi

Returns the specified compression dictionary as a file download.

Endpoint

Method: GET

Path: /v2/compression-dictionaries/{dictionarySha256}

Servers:

https://clientsettings.roblox.com

Parameters

Name	Location	Required	Description
dictionarySha256	path	true	The SHA256 of the dictionary we wish to download.

[
  {
    "in": "path",
    "name": "dictionarySha256",
    "description": "The SHA256 of the dictionary we wish to download.",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Responses

Status	Description
200	OK

{
  "200": {
    "description": "OK"
  }
}

Authentication

{
  "security": [
    {}
  ],
  "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": [
    "Metadata"
  ],
  "summary": "Returns the specified compression dictionary as a file download.",
  "parameters": [
    {
      "in": "path",
      "name": "dictionarySha256",
      "description": "The SHA256 of the dictionary we wish to download.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK"
    }
  },
  "servers": [
    {
      "url": "https://clientsettings.roblox.com"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {}
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/metadata#clientsettings_get_v2_compression_dictionaries__dictionarySha256_"
  }
}