Archive a workspace

Archive an inactive workspace using the specified workspace ID. When a workspace is archived, any cloud applications are disconnected, and Inbound Gateway and Network settings are cleared. Admin users can’t sign into archived workspaces, and archived workspaces don’t appear in an MSP's list of workspaces.

SecurityJWT
Request
header Parameters
Workspace
required
string

The workspace identifier, which isolates API requests inside the provided workspace scope.

Example: corodevonmicrosoftcom_TX7T_u
Responses
200

Success

400

Bad request, validation error

401

Unauthorized request

403

Access forbidden

429

Too Many Requests

500

Internal server error

put/v1/workspaces/archive
Request samples 
Response samples 
application/problem+json
{
  • "status": 400,
  • "title": "Bad request",
  • "errors": [
    ],
  • "timestamp": "2022-08-21T19:44:32.351Z",
  • "traceId": "a029fd656529d7dc"
}