Archive a Use Case

Archive a use case by setting its status to inactive. Archived use cases are hidden from listings by default and will reject new event ingestion.

Required scope: vision-events:manage

Archive a Use Case

post

Archive a use case by setting its status to inactive.

Authorizations

bearerAuth

AuthorizationstringRequired

Roboflow API key passed as a Bearer token.

Path parameters

useCaseIdstringRequired

The ID of the use case to archive.

Responses

200

Use case archived successfully.

application/json

successbooleanOptional

403

Insufficient permissions for this resource.

application/json

404

Use case not found.

application/json

post

/vision-events/use-cases/{useCaseId}/archive

HTTPcURLJavaScriptPython

POST /vision-events/use-cases/{useCaseId}/archive HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true
}

Path Parameters

• useCaseId (string, required): The ID of the use case to archive.

Example Request

curl -X POST "https://api.roboflow.com/vision-events/use-cases/a1b3c8e1/archive" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response

200

{
  "success": true
}

404

403

Notes

• Archiving is a soft delete. The use case and its events are preserved but hidden from active listings.

• To view archived use cases, use the List Use Cases endpoint with status=inactive.

• You can restore an archived use case using the Unarchive a Use Case endpoint.