Backup & Restore

get

Get a backup/restore item details

Path parameters

idinteger · int64Required

The unique identifier held by the backup Lenses store

Responses

200Success

application/json

idinteger · int64Required

createdAtinteger · int64Required

typestring · enumRequiredPossible values:

topicstringRequired

connectClusterstringRequired

connectorNamestringRequired

connectorVersionstringRequired

s3LocationstringRequired

referencestringOptional

400

The request input was invalid

text/plain

401

Authentication error

text/plain

402

The purchased Lenses license does not provide access to this feature

text/plain

403

Authorisation error

text/plain

404

The requested resource cannot be found

text/plain

500

An internal server error has occurred

text/plain

get

/api/v1/environments/{name}/proxy/api/v1/s3/backups/{id}

HTTPcURLJavaScriptPython

GET /api/v1/environments/{name}/proxy/api/v1/s3/backups/{id} HTTP/1.1
Accept: */*

{
  "id": 1,
  "createdAt": 1,
  "type": "Backup",
  "topic": "text",
  "connectCluster": "text",
  "connectorName": "text",
  "connectorVersion": "text",
  "s3Location": "text",
  "reference": "text"
}

post

Back up a topic to S3. You must configure the bucket, optional prefix and the flush settings.

Path parameters

topicstringRequired

The topic name

Body

application/json

clusterstringRequired

Responses

201Success

application/json

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

post

/api/v1/environments/{name}/proxy/api/v1/kafka/topic/{topic}/backup

HTTPcURLJavaScriptPython

POST /api/v1/environments/{name}/proxy/api/v1/kafka/topic/{topic}/backup HTTP/1.1
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

Delete a backup/restore item

Path parameters

idinteger · int64Required

The unique identifier held by the backup Lenses store

Responses

200Success

No content

400

The request input was invalid

text/plain

401

Authentication error

text/plain

402

The purchased Lenses license does not provide access to this feature

text/plain

403

Authorisation error

text/plain

404

The requested resource cannot be found

text/plain

500

An internal server error has occurred

text/plain

delete

/api/v1/environments/{name}/proxy/api/v1/s3/backups/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/environments/{name}/proxy/api/v1/s3/backups/{id} HTTP/1.1
Accept: */*

No content

get

List all backup/restore items

Responses

200Success

application/json

idinteger · int64Required

createdAtinteger · int64Required

typestring · enumRequiredPossible values:

topicstringRequired

connectClusterstringRequired

connectorNamestringRequired

connectorVersionstringRequired

s3LocationstringRequired

referencestringOptional

400

The request input was invalid

text/plain

401

Authentication error

text/plain

402

The purchased Lenses license does not provide access to this feature

text/plain

403

Authorisation error

text/plain

404

The requested resource cannot be found

text/plain

500

An internal server error has occurred

text/plain

get

/api/v1/environments/{name}/proxy/api/v1/s3/backups

HTTPcURLJavaScriptPython

GET /api/v1/environments/{name}/proxy/api/v1/s3/backups HTTP/1.1
Accept: */*

[
  {
    "id": 1,
    "createdAt": 1,
    "type": "Backup",
    "topic": "text",
    "connectCluster": "text",
    "connectorName": "text",
    "connectorVersion": "text",
    "s3Location": "text",
    "reference": "text"
  }
]