Jump to

• Request
• Response
• Examples

Get a snapshot

get

/api/20210901/snapshots/{snapshotId}

Return information about a single snapshot with a given id. Details such as the snapshot name, BAR file name, storage location, creator, and date created.

Request

Path Parameters

• snapshotId(required): string
  Snapshot id.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : Snapshot

Type: object

Object which represents a snapshot.

Show Source

• bar(required): object Bar
  Snapshot BAR file.
• createdByUser(required): string
  User who created the snapshot.
• id(required): string
  Id of the snapshot.
• name(required): string
  Name of the snapshot.
• storage(required): Discriminator: type
  Discriminator: { "propertyName":"type", "mapping":{ "OCI_NATIVE":"#/components/schemas/OCINativeStorage" } }
• timeCreated(required): string (date-time)
  Time the snapshot was created.

{
    "description":"Object which represents a snapshot.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of the snapshot."
        },
        "name":{
            "type":"string",
            "description":"Name of the snapshot."
        },
        "createdByUser":{
            "type":"string",
            "description":"User who created the snapshot."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time the snapshot was created."
        },
        "storage":{
            "$ref":"#/components/schemas/StorageOneOf"
        },
        "bar":{
            "$ref":"#/components/schemas/Bar"
        }
    },
    "required":[
        "id",
        "name",
        "createdByUser",
        "timeCreated",
        "storage",
        "bar"
    ]
}

Nested Schema : Bar

Type: object

Snapshot BAR file.

Show Source

• uri: string
  URI of the BAR file in storage.

{
    "description":"Snapshot BAR file.",
    "type":"object",
    "properties":{
        "uri":{
            "type":"string",
            "description":"URI of the BAR file in storage."
        }
    }
}

Nested Schema : Discriminator: type

Type: object

Discriminator: type

Discriminator Values

• OCI_NATIVE

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/OCINativeStorage"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "OCI_NATIVE":"#/components/schemas/OCINativeStorage"
        }
    }
}

Match One Schema

Show Source

• OCINativeStorage
  Oracle Cloud Infrastructure (OCI) storage details.

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/OCINativeStorage"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "OCI_NATIVE":"#/components/schemas/OCINativeStorage"
        }
    }
}

Nested Schema : OCINativeStorage

Oracle Cloud Infrastructure (OCI) storage details.

Match All

Show Source

• object Storage
  Storage details.
• object OCINativeStorage-allOf[1]

{
    "description":"Oracle Cloud Infrastructure (OCI) storage details.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Storage"
        },
        {
            "type":"object",
            "properties":{
                "bucket":{
                    "type":"string",
                    "description":"Name of a storage bucket in OCI object storage."
                }
            }
        }
    ]
}

Nested Schema : Storage

Type: object

Storage details.

Show Source

• auth(required): Discriminator: type
  Discriminator: { "propertyName":"type", "mapping":{ "OSS_AUTH_OCI_USER_ID":"#/components/schemas/OCIUserIdAuth" } }
• type(required): object StorageType
  Type of storage.

{
    "description":"Storage details.",
    "type":"object",
    "properties":{
        "type":{
            "$ref":"#/components/schemas/StorageType"
        },
        "auth":{
            "$ref":"#/components/schemas/AuthOneOf"
        }
    },
    "required":[
        "type",
        "auth"
    ]
}

Nested Schema : OCINativeStorage-allOf[1]

Type: object

Show Source

• bucket: string
  Name of a storage bucket in OCI object storage.

{
    "type":"object",
    "properties":{
        "bucket":{
            "type":"string",
            "description":"Name of a storage bucket in OCI object storage."
        }
    }
}

Nested Schema : Discriminator: type

Type: object

Discriminator: type

Discriminator Values

• OSS_AUTH_OCI_USER_ID

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/OCIUserIdAuth"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "OSS_AUTH_OCI_USER_ID":"#/components/schemas/OCIUserIdAuth"
        }
    }
}

Match One Schema

Show Source

• OCIUserIdAuth
  Oracle Cloud Infrastructure (OCI) user ID authentication details. See [How to Generate an API Signing Key](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#two).

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/OCIUserIdAuth"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "OSS_AUTH_OCI_USER_ID":"#/components/schemas/OCIUserIdAuth"
        }
    }
}

Nested Schema : StorageType

Type: object

Type of storage.

Show Source

• type(required): string
  Allowed Values: [ "OCI_NATIVE" ]

{
    "description":"Type of storage.",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "OCI_NATIVE"
            ]
        }
    },
    "required":[
        "type"
    ]
}

Nested Schema : OCIUserIdAuth

Oracle Cloud Infrastructure (OCI) user ID authentication details. See [How to Generate an API Signing Key](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#two).

Match All

Show Source

• object Auth
  Authentication details.
• object OCIUserIdAuth-allOf[1]

{
    "description":"Oracle Cloud Infrastructure (OCI) user ID authentication details. See [How to Generate an API Signing Key](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#two).",
    "allOf":[
        {
            "$ref":"#/components/schemas/Auth"
        },
        {
            "type":"object",
            "properties":{
                "ociRegion":{
                    "type":"string",
                    "description":"Name of the OCI region."
                },
                "ociTenancyId":{
                    "type":"string",
                    "description":"OCID of the tenancy."
                },
                "ociUserId":{
                    "type":"string",
                    "description":"OCID of the user."
                },
                "ociKeyFingerprint":{
                    "type":"string",
                    "description":"Fingerprint of the public key."
                },
                "ociPrivateKeyWrapped":{
                    "type":"string",
                    "description":"Base64 encoded private key."
                }
            }
        }
    ],
    "required":[
        "ociRegion",
        "ociTenancyId",
        "ociUserId"
    ]
}

Nested Schema : Auth

Type: object

Authentication details.

Show Source

• type(required): object AuthType
  Type of authentication.

{
    "description":"Authentication details.",
    "type":"object",
    "properties":{
        "type":{
            "$ref":"#/components/schemas/AuthType"
        }
    },
    "required":[
        "type"
    ]
}

Nested Schema : OCIUserIdAuth-allOf[1]

Type: object

Show Source

• ociKeyFingerprint: string
  Fingerprint of the public key.
• ociPrivateKeyWrapped: string
  Base64 encoded private key.
• ociRegion: string
  Name of the OCI region.
• ociTenancyId: string
  OCID of the tenancy.
• ociUserId: string
  OCID of the user.

{
    "type":"object",
    "properties":{
        "ociRegion":{
            "type":"string",
            "description":"Name of the OCI region."
        },
        "ociTenancyId":{
            "type":"string",
            "description":"OCID of the tenancy."
        },
        "ociUserId":{
            "type":"string",
            "description":"OCID of the user."
        },
        "ociKeyFingerprint":{
            "type":"string",
            "description":"Fingerprint of the public key."
        },
        "ociPrivateKeyWrapped":{
            "type":"string",
            "description":"Base64 encoded private key."
        }
    }
}

Nested Schema : AuthType

Type: object

Type of authentication.

Show Source

• type(required): string
  Allowed Values: [ "OSS_AUTH_OCI_USER_ID" ]

{
    "description":"Type of authentication.",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "OSS_AUTH_OCI_USER_ID"
            ]
        }
    },
    "required":[
        "type"
    ]
}

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 return the details of a single snapshot with the ID ac6fdab7-9c16-4d22-a56f-cb7b5d15505a.

cURL Example:

curl -i \
  --header 'Authorization: Bearer <token>' \
  --request GET 'https://<hostname>/api/20210901/snapshots/ac6fdab7-9c16-4d22-a56f-cb7b5d15505a'

Example of Request Body

Not applicable.

Example of Response Body

Status 200:

{

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

  "name": "myfirstsnapshot",

  "createdByUser": "Admin",

  "timeCreated": "2021-10-01T14:20:17.288Z",

  "storage": {

    "type": "OCI_NATIVE",

    "bucket": "mysnapshot-bucket",

    "auth": {

      "type": "OSS_AUTH_OCI_USER_ID",

      "ociRegion": "us-phoenix-1",

      "ociTenancyId": "ocid1.tenancy.oc1..xxxxx...",

      "ociUserId": "ocid1.user.oc1..xxxxxxxxxxxx..."

    }

  },

  "bar": {

    "uri": "file:///myfolder/myfirstsnapshot.bar"

  }

}

Back to Top