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