BackupRestore

get

Get a backup/restore item details

Path parameters
environmentstringRequired
idinteger · int64Required

The unique identifier held by the backup Lenses store

Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/v1/s3/backups/{id}
GET /api/v1/environments/{environment}/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"
}
delete

Delete a backup/restore item

Path parameters
environmentstringRequired
idinteger · int64Required

The unique identifier held by the backup Lenses store

Responses
200Success

No content

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

No content

get

List all backup/restore items

Path parameters
environmentstringRequired
Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/v1/s3/backups
GET /api/v1/environments/{environment}/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?