Backup & Restore
Get a backup/restore item details
The unique identifier held by the backup Lenses store
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
GET /api/v1/environments/{name}/proxy/api/v1/s3/backups/{id} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"createdAt": 1,
"type": "Backup",
"topic": "text",
"connectCluster": "text",
"connectorName": "text",
"connectorVersion": "text",
"s3Location": "text",
"reference": "text"
}
Back up a topic to S3. You must configure the bucket, optional prefix and the flush settings.
The topic name
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
POST /api/v1/environments/{name}/proxy/api/v1/kafka/topic/{topic}/backup HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 99
{
"cluster": "text",
"s3": {
"bucket": "text",
"prefix": "text"
},
"flush": {
"count": 1,
"size": 1,
"interval": 1
}
}
{
"id": 1,
"connector": "text",
"cluster": "text"
}
Delete a backup/restore item
The unique identifier held by the backup Lenses store
No content
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
DELETE /api/v1/environments/{name}/proxy/api/v1/s3/backups/{id} HTTP/1.1
Host:
Accept: */*
No content
List all backup/restore items
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
GET /api/v1/environments/{name}/proxy/api/v1/s3/backups HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"createdAt": 1,
"type": "Backup",
"topic": "text",
"connectCluster": "text",
"connectorName": "text",
"connectorVersion": "text",
"s3Location": "text",
"reference": "text"
}
]
Last updated
Was this helpful?