post__repo

POST /repo

Create Repository

Create a new storage repository

TypeScript Client Library

// Function overloads for createStorageRepo
public createStorageRepo(data: CreateRepoRequest): Promise<CreateRepoResponse>;
public createStorageRepo(data: CreateRepoWithBucketsRequest): Promise<CreateRepoResponse>;
public async createStorageRepo(data: CreateRepoRequest | CreateRepoWithBucketsRequest): Promise<CreateRepoResponse> {
  return this.makeRequest<CreateRepoResponse>('repo', 'POST', data);
}

Code Samples

Shell

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

HTTP

POST https://backend.flashback.tech/repo HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: application/json

JavaScript

const inputBody = '{
  "name": "string",
  "storageType": "S3",
  "mode": "MIRROR",
  "repoBuckets": [
    {
      "bucketId": "string",
      "folder": "string",
      "master": true
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://backend.flashback.tech/repo',
{
  method: 'POST',
  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.post 'https://backend.flashback.tech/repo',
  params: {
  }, headers: headers

p JSON.parse(result)

Python

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

r = requests.post('https://backend.flashback.tech/repo', 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('POST','https://backend.flashback.tech/repo', 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");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
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("POST", "https://backend.flashback.tech/repo", data)
    req.Header = headers

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

Body parameter

{
  "name": "My Backup Repository",
  "storageType": "S3",
  "mode": "MIRROR",
  "workspaceId": "workspace-123",
  "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
body	body	object	true	none
» name	body	string	true	none
» storageType	body	string	true	none
» mode	body	string	true	none
» workspaceId	body	string	true	Workspace ID for the repository
» repoBuckets	body	[object]	true	none
»» folder	body	string	false	none
»» master	body	boolean	false	none
»» bucketId	body	string	false	none
»» bucket	body	object	false	none
»»» id	body	string	false	none
»»» name	body	string	false	none
»»» bucket	body	string	false	none
»»» storageType	body	string	false	none
»»» key	body	string	false	none
»»» secret	body	object	false	none
»»»» key	body	string	false	none
»»»» iv	body	string	false	none
»»»» authTag	body	string	false	none
»»»» message	body	string	false	none
»»» endpoint	body	string	false	none
»»» region	body	string	false	none
»»» status	body	string	false	none
»»» projectId	body	string	false	none
»»» createdAt	body	string	false	none

Enumerated Values

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

Example responses

200 Response

{
  "success": true,
  "repoId": "string",
  "workspaceId": "workspace-123"
}

Responses

Status	Meaning	Description	Schema
200	OK	Repository created successfully	Inline
429	Too Many Requests	Quota exceeded	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	none
» repoId	string	false	none	none
» workspaceId	string	false	none	Workspace ID for the repository

Status Code 429

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	none
» repoId	string	false	none	none
» error_code	string	false	none	none
» error_message	string	false	none	none