Documentation Powered by ReDoc

OwnBackup API (1.0.0)

Download OpenAPI specification:Download

Move your app forward with the OwnBackup API

Auth

User login

Authenticate a user by email and password

Request Body schema:
application/x-www-form-urlencoded
application/x-www-form-urlencoded
multipart/form-data
email
required
string

Email

password
required
string

Password

Responses

Response samples

Content type
application/json
{
  • "session_id": "skdjg1skdhgk41895yhdhg"
}

User logout

Logout

header Parameters
X-SESSION-ID
required
string

Session id

Responses

Response samples

Content type
application/json
{
  • "error": "Not Found",
  • "message": "service_id 12415 not found"
}

Service

Get All Services

Get a list of all services.

header Parameters
X-SESSION-ID
required
string

Session id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get information about a specific service.

Get a specific service by Service id

path Parameters
service_id
required
number <int32>

Service id

header Parameters
X-SESSION-ID
required
string

Session id

Responses

Response samples

Content type
application/json
{
  • "archived": true,
  • "provider": "SaleForce Data",
  • "num_items": 1,
  • "displayed_name": "admin@dev37101",
  • "return_message": "",
  • "total_size": 6,
  • "org_id": "00DK000000XJu1CMAT",
  • "id": 300008,
  • "return_code": 1,
  • "last_backup": "2018-04-09T10:30:42.000Z",
  • "enabled": 1,
  • "status": "ARCHIVED"
}

Back up a service manually now

Start backup a service manually now by Service id.

path Parameters
service_id
required
number <int32>

service id

header Parameters
X-SESSION-ID
required
string

Session id

Responses

Response samples

Content type
application/json
{ }

Back up specific objects in a service manually now

Start a backup for specific objects manually now by Service id.

path Parameters
service_id
required
number <int32>

service id

header Parameters
X-SESSION-ID
required
string

Session id

Request Body schema:
application/x-www-form-urlencoded
application/x-www-form-urlencoded
multipart/form-data
list_of_objects
required
Array of strings

Objects that are to be backed up

Responses

Response samples

Content type
application/json
{ }

Backup

List backups for a specific service

Get a list of all available backups for a given service.

path Parameters
service_id
required
number <int32>

Service id

header Parameters
X-SESSION-ID
required
string

Session id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a specific backup

Get a specific backup by the Service id and Backup id. Parameter backup_id can be 'last'

path Parameters
service_id
required
number <int32>

Service id

backup_id
required
number <int32>

backup id

header Parameters
X-SESSION-ID
required
string

Session id

Responses

Response samples

Content type
application/json
{
  • "id": 420519,
  • "num_sections": 23,
  • "num_updated_items": 1,
  • "num_sections_error": 9,
  • "num_api_calls": 2314,
  • "num_bulk_api_batches": 1000,
  • "num_inserted_items": 6,
  • "num_sections_info": 5,
  • "num_sections_warning": 2,
  • "num_sections_ok": 7,
  • "num_deleted_items": 5,
  • "trigger_type": "scheduled",
  • "completed_at": "2018-04-09T10:39:02.000Z",
  • "status": "OK"
}

Export a data backup into CSV or SQL

Export a data backup into CSV or SQL by Service id and Backup id. Parameter backup_id can be 'last'

path Parameters
service_id
required
number <int32>

Service id

backup_id
required
number <int32>

Backup id

header Parameters
X-SESSION-ID
required
string

Session id

Request Body schema:
application/x-www-form-urlencoded
application/x-www-form-urlencoded
multipart/form-data
application/json
export_format
required
string
Enum: "csv" "sql"

Required export format.

include_attachments
required
boolean

Should the export include attachments. e.g true, false

sql_dialect
string
Enum: "mysql" "oracle" "postgresql" "mssql"

SQL dialect to use when exporting to SQL.

objects
Array of strings

Object names to export, if empty all objects

Responses

Request samples

Content type
application/x-www-form-urlencoded
application/x-www-form-urlencoded
multipart/form-data
application/json
No sample

Response samples

Content type
application/json
{
  • "job_id": 30141
}

Export a data backup to Mysql/S3 endpoint

Export a data backup to Mysql/S3 Endpoint by Service id and Backup id. Parameter backup_id can be 'last'

path Parameters
service_id
required
number <int32>

Service id

backup_id
required
number <int32>

Backup id

header Parameters
X-SESSION-ID
required
string

Session id

Request Body schema:
application/x-www-form-urlencoded
application/x-www-form-urlencoded
multipart/form-data
application/json
endpoint_id
required
integer <int32>

Required endpoint id. You can get it from endpoints page.

objects
Array of strings

Object names to export, if empty all objects

Responses

Request samples

Content type
application/x-www-form-urlencoded
application/x-www-form-urlencoded
multipart/form-data
application/json
No sample

Response samples

Content type
application/json
{
  • "job_id": 30141
}

Objects

List Salesforce objects for a given backup

Get list of objects in a backup by Service id and Backup id. Parameter backup_id can be 'last'. The following fields: download_link, download_added_link, download_removed_link and download_changed_link contain links to the associated data of that backup, stored in CSV format. To download these CSVs, issue an HTTPS GET request (using a valid session) to these URLs.

path Parameters
service_id
required
number <int32>

Service id

backup_id
required
number <int32>

backup id

header Parameters
X-SESSION-ID
required
string

Session id

Responses

Response samples

Content type
application/json
[]

Job

List of jobs

Get a list of all jobs

header Parameters
X-SESSION-ID
required
string

Session id

Responses

Response samples

Content type
application/json
{
  • "progress": 100,
  • "id": 30301,
  • "title": "SalesForce Table Compare",
  • "status": "ok"
}

Get specific job

Get specific job

path Parameters
job_id
required
number <int32>

Job id

header Parameters
X-SESSION-ID
required
string

Session id

Responses

Response samples

Content type
application/json
{
  • "progress": 100,
  • "id": 30301,
  • "title": "SalesForce Table Compare",
  • "status": "ok"
}

GDPR

submitting a GDPR rectify request

submitting a GDPR rectify request

path Parameters
service_id
required
number <int32>

Service id

header Parameters
X-SESSION-ID
required
string

Session id

Request Body schema:
application/x-www-form-urlencoded
application/x-www-form-urlencoded
multipart/form-data
record_id
required
string

Required the id of the relevant record

table_name
required
string

name of the table

field
required
string

the field to rectify

value
required
string

the new value

comment
string

comments

Responses

Response samples

Content type
application/json
{
  • "id": 30141
}

submitting a GDPR forget request

submitting a GDPR forget request

path Parameters
service_id
required
number <int32>

Service id

header Parameters
X-SESSION-ID
required
string

Session id

Request Body schema:
application/x-www-form-urlencoded
application/x-www-form-urlencoded
multipart/form-data
record_id
required
string

Required the id of the relevant record

table_name
required
string

name of the table

comment
string

comments

Responses

Response samples

Content type
application/json
{
  • "id": 30141
}

Event

Get account events history

Get the account event history from the beginning of time (default route) or all events that follows a specific event (use parameter with the id of an event), results are limited to 1,000 events per request.

query Parameters
from
number <int32>

Event id which will filter all of the preceding events (self included), a way to remove history

header Parameters
X-SESSION-ID
required
string

Session id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Enhanced Sandbox Seeding

Get All Services.

Get all services that can be used as destination for seeds.

header Parameters
X-SESSION-ID
required
string

Session id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get All Templates.

Get all seeding templates that the user has access to.

header Parameters
X-SESSION-ID
required
string

Session id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Seed Log.

Get information for the specified seed.

path Parameters
seed_id
required
string

Unique OwnBackup identifier of the seed to get the log of.

header Parameters
X-SESSION-ID
required
string

Session id

Responses

Response samples

Content type
application/json
{
  • "created_at": "2020-05-11T11:19:10.000Z",
  • "delete_fail_records": 0,
  • "delete_success_records": 0,
  • "dest_service_id": 4,
  • "disable_automations": false,
  • "duplicated_records": 0,
  • "finished_at": "2020-05-11T11:19:53.000Z",
  • "id": 1,
  • "insert_fail_records": 0,
  • "insert_success_records": 5,
  • "progress": 100,
  • "seed_id": 731169459,
  • "seeding_method": "add",
  • "started_at": "2020-05-11T11:19:10.000Z",
  • "status": "COMPLETED",
  • "template": 1,
  • "total_delete_records": 0,
  • "total_insert_records": 5
}

Start seed.

Start a new seed from the template's source service to the specified destination service.

path Parameters
template_id
required
number <int32>

Unique OwnBackup identifier of the template to seed from.

header Parameters
X-SESSION-ID
required
string

Session id

Request Body schema: multipart/form-data
destination
required
number <int32>

Unique OwnBackup identifier of the destination service for the seed.

seeding_method
required
string
Enum: "clean_and_insert" "incremental" "upsert"

Seeding method. Please notice that clean_and_insert method is not available for full sandboxes

disable_automations
required
boolean

Should the seed automations be disabled during the seed.

object (SBS_Automations)

Responses

Request samples

Content type
multipart/form-data
{
  "destination": 70001,
  "seeding_method": "incremental",
  "disable_automations": true,
  "automations_to_disable": {
    "ApexTrigger": [
      "Account.BeforeInsert"
    ],
    "ValidationRule": [
      "Account.CountryValidation"
    ]
  }
}

Get Service Automations.

Get active automations names by automation type, of the specified service (excluding automations from managed packages, since they cannot be disabled by salesforce).

path Parameters
service_id
required
number <int32>

Service id

header Parameters
X-SESSION-ID
required
string

Session id

Responses

Response samples

Content type
application/json
{
  • "ApexTrigger": [
    ],
  • "ValidationRule": [
    ]
}