Skip to content

Delete a library

DELETE
/api/v1/libraries/{id}
curl --request DELETE \
--url http://127.0.0.1:8080/api/v1/libraries/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "confirmation": "example" }'

Requires explicit confirmation and library ownership. Uses the persisted local-mode user when authentication is disabled. Otherwise an authenticated browser session is required, except for the current account and sign-in. Modifying authenticated requests require the current X-CSRF-Token. Credentials and responses must not be cached.

id
required
string
X-CSRF-Token
string

Required with an authenticated browser session; read from current-account.

Media typeapplication/json
object
confirmation
required
string
Examplegenerated
{
"confirmation": "example"
}

Operation completed.

Media typeapplication/json
object
Examplegenerated
{}

No valid session or API token (authentication-required), or the credential sent is invalid (invalid-credentials).

Media typeapplication/problem+json
object
code
required
string
detail
required
string
status
required
integer format: int64
title
required
string
type
required
string
key
additional properties
any
Examplegenerated
{
"code": "example",
"detail": "example",
"status": 1,
"title": "example",
"type": "example"
}

Stable account problem code; authentication, authority, validation or lifecycle conflict.

Media typeapplication/problem+json
object
code
required
string
detail
required
string
status
required
integer format: int64
title
required
string
type
required
string
key
additional properties
any
Examplegenerated
{
"code": "example",
"detail": "example",
"status": 1,
"title": "example",
"type": "example"
}