POST /v1/assets/{assetId}:archive — assets/v1

Archives the asset.

Archives the asset. Archived assets disappear from the website and are no longer usable or visible in Roblox experiences, but you can restore them.

Endpoint

Method: POST

Path: /v1/assets/{assetId}:archive

Servers:

https://apis.roblox.com/assets

Parameters

Name	Location	Required	Description
assetId	path	true	The unique identifier of the asset.

[
  {
    "name": "assetId",
    "in": "path",
    "description": "The unique identifier of the asset.",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Responses

Status	Description
200	Asset archived succesfully successfully.
400	Bad request - invalid request.
403	Forbidden - API key without Write scope or user doesn't have access.
404	Asset not found.

{
  "200": {
    "description": "Asset archived succesfully successfully.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Asset"
        }
      }
    }
  },
  "400": {
    "description": "Bad request - invalid request."
  },
  "403": {
    "description": "Forbidden - API key without Write scope or user doesn't have access."
  },
  "404": {
    "description": "Asset not found."
  }
}

Authentication

{
  "security": [
    {
      "roblox-api-key": [
        "asset:read",
        "asset:write"
      ]
    },
    {
      "roblox-oauth2": [
        "asset:read",
        "asset: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.",
      "in": "header",
      "name": "x-api-key"
    },
    "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": {
            "asset:read": "This allows viewing information about your assets.",
            "asset:write": "This allows uploading and updating assets to Roblox."
          }
        }
      }
    }
  }
}

Asset

Complete Operation Definition

{
  "tags": [
    "Assets"
  ],
  "x-roblox-cloud-api-operation": true,
  "x-roblox-cloud-api-operation-name": "Archive Asset",
  "x-roblox-stability": "BETA",
  "summary": "Archives the asset.",
  "description": "Archives the asset. Archived assets disappear from the website and are no longer usable or visible in Roblox experiences, but you can [restore](#POST-v1-assets-{assetId}:restore) them.",
  "operationId": "Assets_ArchiveAsset",
  "parameters": [
    {
      "name": "assetId",
      "in": "path",
      "description": "The unique identifier of the asset.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Asset archived succesfully successfully.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Asset"
          }
        }
      }
    },
    "400": {
      "description": "Bad request - invalid request."
    },
    "403": {
      "description": "Forbidden - API key without Write scope or user doesn't have access."
    },
    "404": {
      "description": "Asset not found."
    }
  },
  "security": [
    {
      "roblox-api-key": [
        "asset:read",
        "asset:write"
      ]
    },
    {
      "roblox-oauth2": [
        "asset:read",
        "asset:write"
      ]
    }
  ],
  "x-roblox-scopes": [
    {
      "name": "asset:read"
    },
    {
      "name": "asset:write"
    }
  ],
  "x-roblox-cloud-api-operation-code-samples": [
    {
      "language": "Archive Asset",
      "script": "curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:archive' \\\n--header 'x-api-key: {apiKey}' \\\n--header 'Content-Type: application/json'"
    }
  ]
}