โ† API reference
Mutation / admin

deleteArchiveJob

Delete an archive job, cancelling its schedule. Reports notFound if no such job exists for the tenant. Requires archiveJob:delete permission.

Arguments

TypeID (prefix arj) of the archive job to delete.

Returns DeletePayload!

Scalar fields at a glance

successBoolean!
โ†— View the complete DeletePayload type

Explore in a view

Administration and IAM
View exact SDL
"""
Delete an archive job, cancelling its schedule. Reports notFound if no such job exists for the tenant. Requires archiveJob:delete permission.
"""
deleteArchiveJob(
  """TypeID (prefix `arj`) of the archive job to delete."""
  id: ArchiveJobID!
): DeletePayload! @topic(names: ["admin"])

Schema reference describes the API contract. Actual access is checked by the platform for every operation.