Jump to

• Request
• Response
• Examples

Restore a snapshot in an Analytics instance

post

/api/20210901/system/actions/restoreSnapshot

Restore a snapshot with a given id and password in an Analytics instance. Returns a WorkRequest id so you can monitor progress.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Properties to perform a snapshot restore action.

Show Source

• snapshot: object SnapshotRestore
  Properties to restore a snapshot using a snapshot resource.

{
    "description":"Properties to perform a snapshot restore action.",
    "type":"object",
    "properties":{
        "snapshot":{
            "$ref":"#/components/schemas/SnapshotRestore"
        }
    }
}

Nested Schema : SnapshotRestore

Type: object

Properties to restore a snapshot using a snapshot resource.

Show Source

• id(required): string
  Id of the snapshot.
• password(required): string
  Password of the snapshot.

{
    "description":"Properties to restore a snapshot using a snapshot resource.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of the snapshot."
        },
        "password":{
            "type":"string",
            "description":"Password of the snapshot."
        }
    },
    "required":[
        "id",
        "password"
    ]
}

Back to Top

Response

202 Response

Asynchronous operation started.

Headers

• oa-work-request-id(required):

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

404 Response

Not Found. The requested resource was not found.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

Back to Top

Examples

In this example, you restore a snapshot with the ID ac6fdab7-9c16-4d22-a56f-cb7b5d15505a in your Oracle Analytics instance.

Use Get all snapshots to find the ID of the snapshot you want to restore. If the snapshot you want isn't yet registered with your Analytics instance, you need to do that first (see Create a snapshot).

cURL Example:

First, create a JSON file that contains the ID of the snapshot you want to restore and the password required to access the snapshot. For example, create a JSON file called restore_mysnapshot.json that looks like this:

{
   "snapshot": {
      "id" : "ac6fdab7-9c16-4d22-a56f-cb7b5d15505a",
      "password" : "snapshotPassword123"
   }
}

Then run this cURL command to restore the snapshot in your Oracle Analytics instance:

curl -i \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --request POST 'https://<hostname>/api/20210901/system/actions/restoreSnapshot' \
  -d @restore_mysnapshot.json

Example of Request Body

{

  "snapshot": {

    "id": "ac6fdab7-9c16-4d22-a56f-cb7b5d15505a",

    "password": "snapshotPassword123"

  }

}

Example of Response Header

Make a note of the oa-work-request-id in the response header. You can use this value to track the status of your operation.

oa-work-request-id: lfc-c2:152-cd:607

Example of Response Body

Alternatively, make a note of the workRequestId in the response body. You can use this value to track the status of your operation.

{
    "workRequestId": "lfc-c2:152-cd:607"
}

Back to Top