oCoreoCore Docs
API Reference

Backup Destinations

List backup destinations

Returns all backup destinations for the organization. Sensitive credentials are redacted.

GET
/backup-destinations

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

curl -X GET "//api.ocore.dev/api/backup-destinations" \
  -H "Authorization: <token>"

OK

{
  "destinations": [
    {
      "config": {},
      "createdAt": "string",
      "destinationType": "string",
      "id": "string",
      "isVerified": true,
      "lastTestedAt": "string",
      "name": "string"
    }
  ],
  "total": 0
}

Create a backup destination

Creates a new backup destination (S3, GCS, SFTP, etc.). Config is encrypted and connection is auto-tested.

POST
/backup-destinations

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Destination details

configobject

plaintext JSON, encrypted before storage

destinationTypestring
namestring
curl -X POST "//api.ocore.dev/api/backup-destinations" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "config": {},
    "destinationType": "string",
    "name": "string"
  }'

Created

{
  "config": {},
  "createdAt": "string",
  "destinationType": "string",
  "id": "string",
  "isVerified": true,
  "lastTestedAt": "string",
  "name": "string"
}

Handle OAuth callback

Handles the OAuth redirect from cloud providers, exchanges the authorization code for tokens, and saves them. Expected browser authorization denials redirect to settings with a fixed, non-sensitive error code.

GET
/backup-destinations/oauth/callback

Query Parameters

codestring

OAuth authorization code (required unless the provider returned an error)

stateRequiredstring

Opaque, one-time state bound to the initiating browser and authenticated context

errorstring

OAuth provider error code

curl -X GET "//api.ocore.dev/api/backup-destinations/oauth/callback?code=%3Cstring%3E&state=%3Cstring%3E&error=%3Cstring%3E"

Redirect to settings page

Get backup destination details

Returns a single backup destination's details with redacted credentials.

GET
/backup-destinations/{id}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Destination UUID

curl -X GET "//api.ocore.dev/api/backup-destinations/<string>" \
  -H "Authorization: <token>"

OK

{
  "config": {},
  "createdAt": "string",
  "destinationType": "string",
  "id": "string",
  "isVerified": true,
  "lastTestedAt": "string",
  "name": "string"
}

Delete a backup destination

Deletes a backup destination. Returns 409 if it is referenced by active backup schedules.

DELETE
/backup-destinations/{id}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Destination UUID

curl -X DELETE "//api.ocore.dev/api/backup-destinations/<string>" \
  -H "Authorization: <token>"

OK

{
  "message": "string"
}

Update a backup destination

Updates a backup destination's name, type, and config. Re-encrypts and re-tests the connection.

PUT
/backup-destinations/{id}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Updated destination details

configobject

plaintext JSON, encrypted before storage

destinationTypestring
namestring

Path Parameters

idRequiredstring

Destination UUID

curl -X PUT "//api.ocore.dev/api/backup-destinations/<string>" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "config": {},
    "destinationType": "string",
    "name": "string"
  }'

OK

{
  "config": {},
  "createdAt": "string",
  "destinationType": "string",
  "id": "string",
  "isVerified": true,
  "lastTestedAt": "string",
  "name": "string"
}

Initiate OAuth for destination

Generates an OAuth authorization URL for Google Drive or OneDrive backup destinations.

POST
/backup-destinations/{id}/oauth/connect

Authorization

Cookie<token>

Browser session JWT sent as the access_token cookie. Swagger 2 represents this cookie through the Cookie header.

In: header

Authorization<token>

oCore API key sent as Authorization: Bearer ocore_. JWT bearer tokens are not accepted in this header for these operations.

In: header

Path Parameters

idRequiredstring

Destination UUID

curl -X POST "//api.ocore.dev/api/backup-destinations/<string>/oauth/connect" \
  -H "Cookie: <token>"

OK

{
  "redirectUrl": "string"
}

Test destination connection

Tests the connection to the backup destination. Returns 200 on success, 422 on failure.

POST
/backup-destinations/{id}/test

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Destination UUID

curl -X POST "//api.ocore.dev/api/backup-destinations/<string>/test" \
  -H "Authorization: <token>"

OK

{
  "message": "string"
}

Was this page helpful?
Edit on GitHub

Backups

Previous Page

Snapshots

Next Page