API Reference
Search documentation
karat

+

K

User Documentation ↗

Archive a Target

PUT/api/gotham/v1/twb/target/{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 Target by RID. The user is required to have OWN permissions on the target.

Path parameters

rid
string

Target 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/target/ri.gotham-artifact.0-0.target.example/archive?preview=true"