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 Board by RID. The user is required to have OWN permissions on the target.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:target-write.
1
2
3
curl -X DELETE \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/targetWorkbench/targetBoards/ri.gotham-artifact.0-0.target-board.example?preview=true"| Error Name | ||
|---|---|---|
User | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The user is required to have owner permissions on the artifact. | |
| Parameters | artifactId | |
Delete | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not delete the TargetBoard. | |
| Parameters | targetBoardRid | |
See Errors for a general overview of errors in the platform.