put__repo_repoId

Code Samples

Shell

# You can also use wget
curl -X PUT https://backend.flashback.tech/repo/{repoId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

HTTP

PUT https://backend.flashback.tech/repo/{repoId} HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: application/json

JavaScript

const inputBody = '{
  "name": "My Updated Repository",
  "storageType": "S3",
  "mode": "MIRROR",
  "repoBuckets": [
    {
      "folder": "backups",
      "master": true,
      "bucketId": "123e4567-e89b-12d3-a456-426614174000",
      "bucket": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "My Backup Bucket",
        "bucket": "my-backup-bucket-2024",
        "storageType": "S3",
        "key": "AKIAIOSFODNN7EXAMPLE",
        "secret": {
          "key": "encrypted-secret-key",
          "iv": "initialization-vector",
          "authTag": "authentication-tag",
          "message": "encrypted-message"
        },
        "endpoint": "https://s3.amazonaws.com",
        "region": "us-east-1",
        "status": "ACTIVE",
        "projectId": "my-project-123",
        "createdAt": "2024-01-15T09:00:00Z"
      }
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://backend.flashback.tech/repo/{repoId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://backend.flashback.tech/repo/{repoId}',
  params: {
  }, headers: headers

p JSON.parse(result)

Python

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://backend.flashback.tech/repo/{repoId}', headers = headers)

print(r.json())

PHP

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://backend.flashback.tech/repo/{repoId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Java

URL obj = new URL("https://backend.flashback.tech/repo/{repoId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Go

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://backend.flashback.tech/repo/{repoId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /repo/{repoId}

Update Repository

Update an existing storage repository

Body parameter

{
  "name": "My Updated Repository",
  "storageType": "S3",
  "mode": "MIRROR",
  "repoBuckets": [
    {
      "folder": "backups",
      "master": true,
      "bucketId": "123e4567-e89b-12d3-a456-426614174000",
      "bucket": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "My Backup Bucket",
        "bucket": "my-backup-bucket-2024",
        "storageType": "S3",
        "key": "AKIAIOSFODNN7EXAMPLE",
        "secret": {
          "key": "encrypted-secret-key",
          "iv": "initialization-vector",
          "authTag": "authentication-tag",
          "message": "encrypted-message"
        },
        "endpoint": "https://s3.amazonaws.com",
        "region": "us-east-1",
        "status": "ACTIVE",
        "projectId": "my-project-123",
        "createdAt": "2024-01-15T09:00:00Z"
      }
    }
  ]
}

Parameters

Name	In	Type	Required	Description
repoId	path	string	true	Repository ID to update
body	body	object	true	Repository update data
» name	body	string	true	Repository name
» storageType	body	string	true	Storage provider type
» mode	body	string	true	Repository mode
» repoBuckets	body	[object]	true	Repository bucket configuration
»» folder	body	string	false	Folder path within the bucket
»» master	body	boolean	false	Whether this is the master bucket
»» bucketId	body	string	false	Bucket identifier
»» bucket	body	object	false	Storage bucket details
»»» id	body	string	false	Bucket identifier
»»» name	body	string	false	Bucket name
»»» bucket	body	string	false	Actual bucket name in cloud storage
»»» storageType	body	string	false	Storage provider type
»»» key	body	string	false	Access key for the storage provider
»»» secret	body	object	false	Encrypted secret key information
»»»» key	body	string	false	Encrypted key data
»»»» iv	body	string	false	Initialization vector
»»»» authTag	body	string	false	Authentication tag
»»»» message	body	string	false	Encrypted message
»»» endpoint	body	string	false	Custom endpoint URL
»»» region	body	string	false	Storage region
»»» status	body	string	false	Bucket status
»»» projectId	body	string	false	Project identifier (for GCS)
»»» createdAt	body	string	false	Creation timestamp for the bucket

Enumerated Values

Parameter	Value
» storageType	S3
» storageType	GCS
» storageType	AZURE
» mode	MIRROR
» mode	BACKUP

Example responses

200 Response

{
  "success": true,
  "repo": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "My Updated Repository",
    "storageType": "S3",
    "mode": "MIRROR",
    "createdAt": "2024-01-15T10:00:00Z",
    "updatedAt": "2024-01-15T11:00:00Z"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Repository updated successfully	Inline
400	Bad Request	Validation error	Inline
404	Not Found	Repository not found	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	Indicates if the request was successful
» repo	object	false	none	Updated repository information
»» id	string	false	none	Repository identifier
»» name	string	false	none	Repository name
»» storageType	string	false	none	Storage provider type
»» mode	string	false	none	Repository mode
»» createdAt	string	false	none	Creation timestamp
»» updatedAt	string	false	none	Last update timestamp

Status Code 400

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	Indicates if the request was successful
» message	string	false	none	Error message

Status Code 404

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	Indicates if the request was successful
» message	string	false	none	Error message