Backup & Restore

Get backup/restore item details

get

Get a backup/restore item details

Authorizations

bearerAuthcookieAuth

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

200Success

application/json

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/{environment}/proxy/api/v1/s3/backups/{id}

HTTPcURLJavaScriptPython

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

bearerAuthcookieAuth

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

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/{environment}/proxy/api/v1/s3/backups/{id}

HTTPcURLJavaScriptPython

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

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Responses

200Success

application/json

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/{environment}/proxy/api/v1/s3/backups

HTTPcURLJavaScriptPython

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"
  }
]