OAA Admin API

Stores snapshot in DB.

post

/policy/risk/v1/snapshots

Snapshot can be stored in DB by generating it directly in the system or by uploading it as a binary/zip file.

Request

There are no request parameters for this operation.

Supported Media Types

application/octet-stream
application/json

Root Schema : schema

Type: binary

Root Schema : schema

Type: object

Snapshot data

Show Source

createTime: string

Create Time of snapshot
description: integer

Description of the snapshot
name: string

Name of the snapshot
snapshotId: string

Unique identifier of snapshot

{
    "type":"object",
    "description":"Snapshot data",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the snapshot"
        },
        "description":{
            "type":"integer",
            "description":"Description of the snapshot"
        },
        "snapshotId":{
            "type":"string",
            "description":"Unique identifier of snapshot"
        },
        "createTime":{
            "type":"string",
            "description":"Create Time of snapshot"
        }
    }
}

Response

Supported Media Types

application/xml
application/json

200 Response

Snapshot information.

Root Schema : SnapshotsResponse

Type: object

Snapshot response

Show Source

message: integer

Message
snapshot: object schema

Snapshot data
status: string

Status

{
    "type":"object",
    "description":"Snapshot response",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status"
        },
        "message":{
            "type":"integer",
            "description":"Message"
        },
        "snapshot":{
            "type":"object",
            "$ref":"#/components/schemas/SnapshotData",
            "description":"All snapshots that are available."
        }
    }
}

Nested Schema : schema

Type: object

Snapshot data

Show Source

createTime: string

Create Time of snapshot
description: integer

Description of the snapshot
name: string

Name of the snapshot
snapshotId: string

Unique identifier of snapshot

{
    "type":"object",
    "description":"Snapshot data",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the snapshot"
        },
        "description":{
            "type":"integer",
            "description":"Description of the snapshot"
        },
        "snapshotId":{
            "type":"string",
            "description":"Unique identifier of snapshot"
        },
        "createTime":{
            "type":"string",
            "description":"Create Time of snapshot"
        }
    }
}

401 Response

Unauthorized

500 Response

Internal server error

503 Response

Service Unavailable

Examples

The following example shows a sample request and response for creating a snapshot in the DB.

cURL Command to Store the Snapshot in JSON Format

curl --location --request POST '<PolicyUrl>/policy/risk/v1/snapshots/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '{
    "name":"A sample snapshot",
    "description": "This is a test sample snapshot"
}'

Sample Response in JSON Format

{
    "status": "201",
    "message": "Snapshot created successfully.",
    "snapshot": {
        "name": "A sample snapshot",
        "description": "This is a test sample snapshot",
        "snapshotId": "20101",
        "createTime": "11-17-2021 11:10:38"
    }
}

The following example shows a sample request and response for uploading a snapshot ZIP file previously downloaded using "Get a snapshot ZIP file".

cURL Command to Store the Snapshot in JSON Format

curl --location --request POST '<PolicyUrl>/policy/risk/v1/snapshots/' \
--header 'Content-Type: application/octet-stream' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data-binary '@/scratch/hvellapp/respone_files/snapshot_11122021_163405143.zip'

Sample Response in JSON Format

{
    "status": "201",
    "message": "Snapshot created successfully.",
    "snapshot": {
        "name": "A sample SS",
        "description": "This is a test sample SS",
        "snapshotId": "20101",
        "createTime": "11-17-2021 11:10:38"
    }
}

cURL Command to Store the Snapshot in XML Format

curl --location --request POST '<PolicyUrl>/policy/risk/v1/snapshots/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '<?xml version="1.0" encoding="UTF-8" ?>
 <OARMSnapshotData>
     <name>A sample snapshot</name>
     <description>This is a test sample snapshot</description>
 </OARMSnapshotData>
'

Sample Response in XML Format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <SnapshotResponse>
     <status>201</status>
     <message>Snapshot created successfully.</message>
     <snapshot>
         <name>A sample snapshot</name>
         <description>This is a test sample snapshot</description>
         <snapshotId>20101</snapshotId>
         <createTime>11-17-2021 11:10:38</createTime>
     </snapshot>
 </SnapshotResponse>

The following example shows a sample request and response for uploading a snapshot ZIP file previously downloaded using "Get a snapshot ZIP file".

cURL Command to Store the Snapshot in XML Format

curl --location --request POST '<PolicyUrl>/policy/risk/v1/snapshots/' \
--header 'Content-Type: application/octet-stream' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data-binary '@/scratch/hvellapp/respone_files/snapshot_11122021_163405143.zip'

Sample Response in XML Format

<?xml version="1.0" encoding="UTF-8" ?>
 <SnapshotResponse>
     <status>201</status>
     <message>Snapshot created successfully.</message>
     <snapshot>
         <name>A sample SS</name>
         <description>This is a test sample SS</description>
         <snapshotId>20101</snapshotId>
         <createTime>11-17-2021 11:10:38</createTime>
     </snapshot>
 </SnapshotResponse>