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

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: /assets/v1/assets/{assetId}:archive

Servers:

https://apis.roblox.com

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

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": []
    },
    {
      "roblox-oauth2": []
    }
  ],
  "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'"
    }
  ],
  "x-roblox-rate-limits": {
    "perApiKeyOwner": {
      "period": "MINUTE",
      "maxInPeriod": 100
    },
    "perOauth2Authorization": {
      "period": "MINUTE",
      "maxInPeriod": 100
    }
  },
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/assets#Assets_ArchiveAsset"
  }
}