API Reference
Search documentation
karat

+

K

User Documentation ↗

Archive a Target Board

PUT/api/gotham/v1/twb/targetBoard/{rid}/archive
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Archive a Collection by RID.

Path parameters

rid
string

Target Board RID

Query parameters

preview
boolean
optional

Represents a boolean value that restricts an endpoint to preview mode when set to true.

Response body

EmptySuccessResponse
object

Success response

Examples

Request

Copied!
1 2 3 curl -X PUT \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/gotham/v1/twb/targetBoard/ri.gotham-artifact.0-0.target-board.example/archive?preview=true"