Backup & Restore

Get backup/restore item details

get

Get a backup/restore item details

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
idinteger · int64Required

The unique identifier held by the backup Lenses store

Responses
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: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": 1,
  "createdAt": 1,
  "type": "Backup",
  "topic": "text",
  "connectCluster": "text",
  "connectorName": "text",
  "connectorVersion": "text",
  "s3Location": "text",
  "reference": "text"
}

Delete a backup/restore item

delete

Delete a backup/restore item

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
idinteger · int64Required

The unique identifier held by the backup Lenses store

Responses
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: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List all backup/restore items

get

List all backup/restore items

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Responses
get
/api/v1/environments/{environment}/proxy/api/v1/s3/backups
GET /api/v1/environments/{environment}/proxy/api/v1/s3/backups HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {
    "id": 1,
    "createdAt": 1,
    "type": "Backup",
    "topic": "text",
    "connectCluster": "text",
    "connectorName": "text",
    "connectorVersion": "text",
    "s3Location": "text",
    "reference": "text"
  }
]

Last updated

Was this helpful?