Oracle Platforms Blockstorage API
The blockstorage API from Oracle Platforms — 33 operation(s) for blockstorage.
Oracle Platforms Blockstorage API is one of 11 APIs that Oracle Platforms publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Block Storage. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, rate-limit docs, and pricing.
This API exposes 60 operations across 33 paths, and defines 53 schemas. It is described by OpenAPI 3.2.0, at version 20160918.
Requests are made against a single base URL, /20160918.
60 operations
33 paths
53 schemas
10 DELETE24 GET17 POST9 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 60
Across 33 paths, the API surfaces 60 operations — 10 DELETE, 24 GET, 17 POST, 9 PUT. Each is listed below with its method, path, parameters, and response codes.
blockstorage 60
GET
/blockVolumeReplicas
ListBlockVolumeReplicas
GET
/blockVolumeReplicas/{blockVolumeReplicaId}
GetBlockVolumeReplica
GET
/bootVolumeBackups
ListBootVolumeBackups
POST
/bootVolumeBackups
CreateBootVolumeBackup
DELETE
/bootVolumeBackups/{bootVolumeBackupId}
DeleteBootVolumeBackup
GET
/bootVolumeBackups/{bootVolumeBackupId}
GetBootVolumeBackup
PUT
/bootVolumeBackups/{bootVolumeBackupId}
UpdateBootVolumeBackup
POST
/bootVolumeBackups/{bootVolumeBackupId}/actions/changeCompartment
ChangeBootVolumeBackupCompartment
POST
/bootVolumeBackups/{bootVolumeBackupId}/actions/copy
CreateBootVolumeBackupCopy
GET
/bootVolumeReplicas
ListBootVolumeReplicas
GET
/bootVolumeReplicas/{bootVolumeReplicaId}
GetBootVolumeReplica
GET
/bootVolumes
ListBootVolumes
POST
/bootVolumes
CreateBootVolume
DELETE
/bootVolumes/{bootVolumeId}
DeleteBootVolume
GET
/bootVolumes/{bootVolumeId}
GetBootVolume
PUT
/bootVolumes/{bootVolumeId}
UpdateBootVolume
POST
/bootVolumes/{bootVolumeId}/actions/changeCompartment
ChangeBootVolumeCompartment
DELETE
/bootVolumes/{bootVolumeId}/kmsKey
DeleteBootVolumeKmsKey
GET
/bootVolumes/{bootVolumeId}/kmsKey
GetBootVolumeKmsKey
PUT
/bootVolumes/{bootVolumeId}/kmsKey
UpdateBootVolumeKmsKey
GET
/volumeBackupPolicies
ListVolumeBackupPolicies
POST
/volumeBackupPolicies
CreateVolumeBackupPolicy
DELETE
/volumeBackupPolicies/{policyId}
DeleteVolumeBackupPolicy
GET
/volumeBackupPolicies/{policyId}
GetVolumeBackupPolicy
PUT
/volumeBackupPolicies/{policyId}
UpdateVolumeBackupPolicy
GET
/volumeBackupPolicyAssignments
GetVolumeBackupPolicyAssetAssignment
POST
/volumeBackupPolicyAssignments
CreateVolumeBackupPolicyAssignment
DELETE
/volumeBackupPolicyAssignments/{policyAssignmentId}
DeleteVolumeBackupPolicyAssignment
GET
/volumeBackupPolicyAssignments/{policyAssignmentId}
GetVolumeBackupPolicyAssignment
GET
/volumeBackups
ListVolumeBackups
POST
/volumeBackups
CreateVolumeBackup
DELETE
/volumeBackups/{volumeBackupId}
DeleteVolumeBackup
GET
/volumeBackups/{volumeBackupId}
GetVolumeBackup
PUT
/volumeBackups/{volumeBackupId}
UpdateVolumeBackup
POST
/volumeBackups/{volumeBackupId}/actions/changeCompartment
ChangeVolumeBackupCompartment
POST
/volumeBackups/{volumeBackupId}/actions/copy
CreateVolumeBackupCopy
GET
/volumeGroupBackups
ListVolumeGroupBackups
POST
/volumeGroupBackups
CreateVolumeGroupBackup
DELETE
/volumeGroupBackups/{volumeGroupBackupId}
DeleteVolumeGroupBackup
GET
/volumeGroupBackups/{volumeGroupBackupId}
GetVolumeGroupBackup
PUT
/volumeGroupBackups/{volumeGroupBackupId}
UpdateVolumeGroupBackup
POST
/volumeGroupBackups/{volumeGroupBackupId}/actions/changeCompartment
ChangeVolumeGroupBackupCompartment
POST
/volumeGroupBackups/{volumeGroupBackupId}/actions/copy
CreateVolumeGroupBackupCopy
GET
/volumeGroupReplicas
Lists the volume group replicas in the specified compartment.
GET
/volumeGroupReplicas/{volumeGroupReplicaId}
Gets information for the specified volume group replica.
GET
/volumeGroups
ListVolumeGroups
POST
/volumeGroups
CreateVolumeGroup
DELETE
/volumeGroups/{volumeGroupId}
DeleteVolumeGroup
GET
/volumeGroups/{volumeGroupId}
GetVolumeGroup
PUT
/volumeGroups/{volumeGroupId}
UpdateVolumeGroup
POST
/volumeGroups/{volumeGroupId}/actions/changeCompartment
ChangeVolumeGroupCompartment
GET
/volumes
ListVolumes
POST
/volumes
CreateVolume
DELETE
/volumes/{volumeId}
DeleteVolume
GET
/volumes/{volumeId}
GetVolume
PUT
/volumes/{volumeId}
UpdateVolume
POST
/volumes/{volumeId}/actions/changeCompartment
ChangeVolumeCompartment
DELETE
/volumes/{volumeId}/kmsKey
DeleteVolumeKmsKey
GET
/volumes/{volumeId}/kmsKey
GetVolumeKmsKey
PUT
/volumes/{volumeId}/kmsKey
UpdateVolumeKmsKey
Schemas 53
The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are VolumeBackup (24 properties), BootVolumeBackup (23 properties), VolumeGroupBackup (23 properties), BootVolume (21 properties). Each schema is shown below with its type and property counts.
UpdateVolumeKmsKeyDetails
object
1 property
CreateVolumeDetails
object
The details of the volume to create. For CreateVolume operation, this field is required in the request, see [CreateVolume](/en/iaas/latest/Volume/CreateVolume).
17 properties
1 required
UpdateVolumeBackupDetails
object
8 properties
UpdateVolumeBackupPolicyDetails
object
Specifies the properties for updating a user defined backup policy. For more information about user defined backup policies, see [User Defined Policies](/iaas/…
5 properties
Volume
object
A detachable block volume device that allows you to dynamically expand the storage capacity of an instance. For more information, see [Overview of Cloud Volume…
21 properties
7 required
ChangeVolumeCompartmentDetails
object
Contains the details for the compartment to move the volume to.
1 property
1 required
CreateVolumeBackupPolicyDetails
object
Specifies the properties for creating user defined backup policy. For more information about user defined backup policies, see [User Defined Policies](/iaas/Co…
6 properties
1 required
UpdateVolumeGroupDetails
object
5 properties
UpdateVolumeDetails
object
9 properties
VolumeBackupSchedule
object
Defines the backup frequency and retention period for a volume backup policy. For more information, see [Policy-Based Backups](/iaas/Content/Block/Tasks/schedu…
13 properties
3 required
ChangeBootVolumeBackupCompartmentDetails
object
Contains the details for the compartment to move the boot volume backup to.
1 property
1 required
CreateVolumeGroupDetails
object
9 properties
3 required
UpdateBootVolumeDetails
object
8 properties
ChangeVolumeGroupBackupCompartmentDetails
object
Contains the details for the compartment to move the volume group backup to.
1 property
1 required
BootVolumeBackup
object
A point-in-time copy of a boot volume that can then be used to create a new boot volume or recover a boot volume. For more information, see [Overview of Boot V…
23 properties
5 required
RetentionDuration
object
This field is used to define the retention period for backups. This is an optional field. If it is not specified, it is set to null, no retention period will b…
2 properties
2 required
BootVolumeReplica
object
An asynchronous replica of a boot volume that can then be used to create a new boot volume or recover a boot volume. For more information, see [Overview of Cro…
14 properties
9 required
VolumeGroup
object
Specifies a volume group which is a collection of volumes. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). Warning: O…
14 properties
8 required
CreateBootVolumeBackupDetails
object
10 properties
1 required
VolumeGroupReplicaInfo
object
Information about the volume group replica in the destination availability domain.
3 properties
3 required
UpdateBootVolumeKmsKeyDetails
object
1 property
ChangeBootVolumeCompartmentDetails
object
Contains the details for the compartment to move the boot volume to.
1 property
1 required
BootVolumeKmsKey
object
The Vault service master encryption key associated with this volume.
1 property
BootVolumeReplicaInfo
object
Information about the boot volume replica in the destination availability domain.
3 properties
3 required
AutotunePolicy
object
An autotune policy automatically tunes the volume's performace based on the type of the policy.
1 property
1 required
VolumeGroupSourceDetails
object
Specifies the source for a volume group.
1 property
1 required
VolumeBackup
object
A point-in-time copy of a volume that can then be used to create a new block volume or recover a block volume. For more information, see [Overview of Cloud Vol…
24 properties
6 required
CopyBootVolumeBackupDetails
object
3 properties
1 required
BootVolumeSourceDetails
object
1 property
1 required
VolumeGroupReplica
object
An asynchronous replica of a volume group that can then be used to create a new volume group or recover a volume group. For more information, see [Volume Group…
12 properties
10 required
ChangeVolumeBackupCompartmentDetails
object
Contains the details for the compartment to move the volume backup to.
1 property
1 required
MemberReplica
object
OCIDs for the volume replicas in this volume group replica.
1 property
1 required
ChangeVolumeGroupCompartmentDetails
object
Contains the details for the compartment to move the volume group to.
1 property
1 required
BootVolume
object
A detachable boot volume device that contains the image used to boot a Compute instance. For more information, see [Overview of Boot Volumes](/iaas/Content/Blo…
21 properties
6 required
VolumeBackupPolicyAssignment
object
Specifies the volume that the volume backup policy is assigned to. For more information about Oracle defined backup policies and custom backup policies, see [P…
4 properties
4 required
BlockVolumeReplicaDetails
object
Contains the details for the block volume replica
2 properties
1 required
VolumeSourceDetails
object
Specifies the volume source details for a new Block volume. The volume source is either another Block volume in the same Availability Domain or a Block volume…
1 property
1 required
CreateVolumeBackupPolicyAssignmentDetails
object
2 properties
2 required
VolumeBackupPolicy
object
A policy for automatically creating volume backups according to a recurring schedule. Has a set of one or more schedules that control when and how backups are…
8 properties
4 required
VolumeGroupBackup
object
A point-in-time copy of a volume group that can then be used to create a new volume group or restore a volume group. For more information, see [Volume Groups](…
23 properties
7 required
CreateVolumeBackupDetails
object
10 properties
1 required
VolumeGroupReplicaDetails
object
Contains the details for the volume group replica.
2 properties
1 required
BootVolumeReplicaDetails
object
Contains the details for the boot volume replica
2 properties
1 required
BlockVolumeReplica
object
An asynchronous replica of a block volume that can then be used to create a new block volume or recover a block volume. For more information, see [Overview of…
13 properties
9 required
CreateVolumeGroupBackupDetails
object
10 properties
1 required
BlockVolumeReplicaInfo
object
Information about the block volume replica in the destination availability domain.
3 properties
3 required
CopyVolumeBackupDetails
object
3 properties
1 required
Error
object
5 properties
2 required
CopyVolumeGroupBackupDetails
object
3 properties
1 required
UpdateBootVolumeBackupDetails
object
8 properties
VolumeKmsKey
object
The Vault service master encryption key associated with this volume.
1 property
CreateBootVolumeDetails
object
13 properties
2 required
UpdateVolumeGroupBackupDetails
object
7 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle Platforms 10
Other APIs Oracle Platforms publishes across the network.
Oracle Fusion Cloud ERP API
Oracle APEX REST APIs
Oracle Platforms Analytics API
Oracle Platforms Compute API
Oracle Platforms Compute Management API
Oracle Platforms Database API
Oracle Platforms Data Science API
Oracle Platforms Integration Instance API
Oracle Platforms Oce Instance API
Oracle Platforms Virtual Network API
#Block Storage
Where this information came from
This is an independent, third-party profile of Oracle Platforms Blockstorage API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.