Oracle File Storage API
The fileStorage API from Oracle — 48 operation(s) for filestorage.
Oracle File Storage API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include File Storage. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 74 operations across 48 paths, and defines 62 schemas. It is described by OpenAPI 3.2.0, at version 20171215.
Requests are made against a single base URL, /20171215.
74 operations
48 paths
62 schemas
9 DELETE20 GET36 POST9 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 74
Across 48 paths, the API surfaces 74 operations — 9 DELETE, 20 GET, 36 POST, 9 PUT. Each is listed below with its method, path, parameters, and response codes.
fileStorage 74
GET
/exportSets
ListExportSets
GET
/exportSets/{exportSetId}
GetExportSet
PUT
/exportSets/{exportSetId}
UpdateExportSet
GET
/exports
ListExports
POST
/exports
CreateExport
DELETE
/exports/{exportId}
DeleteExport
GET
/exports/{exportId}
GetExport
PUT
/exports/{exportId}
UpdateExport
POST
/exports/{exportId}/actions/addLock
Adds a lock to a resource.
POST
/exports/{exportId}/actions/removeLock
Removes a lock to a resource.
GET
/fileSystems
ListFileSystems
POST
/fileSystems
CreateFileSystem
DELETE
/fileSystems/{fileSystemId}
DeleteFileSystem
GET
/fileSystems/{fileSystemId}
GetFileSystem
PUT
/fileSystems/{fileSystemId}
UpdateFileSystem
POST
/fileSystems/{fileSystemId}/actions/addLock
Adds a lock to a resource.
POST
/fileSystems/{fileSystemId}/actions/changeCompartment
ChangeFileSystemCompartment
POST
/fileSystems/{fileSystemId}/actions/detachClone
DetachClone
POST
/fileSystems/{fileSystemId}/actions/estimateReplication
EstimateReplication
POST
/fileSystems/{fileSystemId}/actions/removeLock
Removes a lock to a resource.
POST
/fileSystems/{fileSystemId}/actions/toggleQuotaRules
Toggles quota enforcement for a file system
GET
/fileSystems/{fileSystemId}/quotaRules
List user or group usages and their quota rules.
POST
/fileSystems/{fileSystemId}/quotaRules
Create an FS level, user or group quota rule.
DELETE
/fileSystems/{fileSystemId}/quotaRules/{quotaRuleId}
Remove an FS level, user or group quota rule.
GET
/fileSystems/{fileSystemId}/quotaRules/{quotaRuleId}
Get an FS level, user or group quota rule.
PUT
/fileSystems/{fileSystemId}/quotaRules/{quotaRuleId}
Edit an FS level, user or group quota rule.
GET
/filesystemSnapshotPolicies
ListFilesystemSnapshotPolicies
POST
/filesystemSnapshotPolicies
CreateFilesystemSnapshotPolicy
DELETE
/filesystemSnapshotPolicies/{filesystemSnapshotPolicyId}
DeleteFilesystemSnapshotPolicy
GET
/filesystemSnapshotPolicies/{filesystemSnapshotPolicyId}
GetFilesystemSnapshotPolicy
PUT
/filesystemSnapshotPolicies/{filesystemSnapshotPolicyId}
UpdateFilesystemSnapshotPolicy
POST
/filesystemSnapshotPolicies/{filesystemSnapshotPolicyId}/actions/addLock
Adds a lock to a resource.
POST
/filesystemSnapshotPolicies/{filesystemSnapshotPolicyId}/actions/changeCompartment
ChangeFilesystemSnapshotPolicyCompartment
POST
/filesystemSnapshotPolicies/{filesystemSnapshotPolicyId}/actions/pause
Pauses an active filesystem snapshot policy.
POST
/filesystemSnapshotPolicies/{filesystemSnapshotPolicyId}/actions/removeLock
Removes a lock to a resource.
POST
/filesystemSnapshotPolicies/{filesystemSnapshotPolicyId}/actions/unpause
Unpauses a paused (inactive) filesystem snapshot policy.
GET
/mountTargets
ListMountTargets
POST
/mountTargets
CreateMountTarget
POST
/mountTargets/actions/validateKeyTabs
ValidateKeytabs
DELETE
/mountTargets/{mountTargetId}
DeleteMountTarget
GET
/mountTargets/{mountTargetId}
GetMountTarget
PUT
/mountTargets/{mountTargetId}
UpdateMountTarget
POST
/mountTargets/{mountTargetId}/actions/addLock
Adds a lock to a resource.
POST
/mountTargets/{mountTargetId}/actions/cancelShapeDowngrade
CancelDowngradeShapeMountTarget
POST
/mountTargets/{mountTargetId}/actions/changeCompartment
ChangeMountTargetCompartment
POST
/mountTargets/{mountTargetId}/actions/removeLock
Removes a lock to a resource.
POST
/mountTargets/{mountTargetId}/actions/scheduleShapeDowngrade
ScheduleDowngradeShapeMountTarget
POST
/mountTargets/{mountTargetId}/actions/upgradeShape
UpgradeShapeMountTarget
GET
/outboundConnectors
ListOutboundConnectors
POST
/outboundConnectors
CreateOutboundConnector
DELETE
/outboundConnectors/{outboundConnectorId}
DeleteOutboundConnector
GET
/outboundConnectors/{outboundConnectorId}
GetOutboundConnector
PUT
/outboundConnectors/{outboundConnectorId}
UpdateOutboundConnector
POST
/outboundConnectors/{outboundConnectorId}/actions/addLock
Adds a lock to a resource.
POST
/outboundConnectors/{outboundConnectorId}/actions/changeCompartment
ChangeOutboundConnectorCompartment
POST
/outboundConnectors/{outboundConnectorId}/actions/removeLock
Removes a lock to a resource.
GET
/replicationTargets
ListReplicationTargets
DELETE
/replicationTargets/{replicationTargetId}
DeleteReplicationTarget
GET
/replicationTargets/{replicationTargetId}
GetReplicationTarget
GET
/replications
ListReplications
POST
/replications
CreateReplication
DELETE
/replications/{replicationId}
DeleteReplication
GET
/replications/{replicationId}
GetReplication
PUT
/replications/{replicationId}
UpdateReplication
POST
/replications/{replicationId}/actions/addLock
Adds a lock to a resource.
POST
/replications/{replicationId}/actions/changeCompartment
ChangeReplicationCompartment
POST
/replications/{replicationId}/actions/removeLock
Removes a lock to a resource.
GET
/snapshots
ListSnapshots
POST
/snapshots
CreateSnapshot
DELETE
/snapshots/{snapshotId}
DeleteSnapshot
GET
/snapshots/{snapshotId}
GetSnapshot
PUT
/snapshots/{snapshotId}
UpdateSnapshot
POST
/snapshots/{snapshotId}/actions/addLock
Adds a lock to a resource.
POST
/snapshots/{snapshotId}/actions/removeLock
Removes a lock to a resource.
Schemas 62
The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are FileSystem (24 properties), MountTarget (24 properties), MountTargetSummary (20 properties), Replication (19 properties). Each schema is shown below with its type and property counts.
SnapshotSummary
object
Summary information for a snapshot.
16 properties
5 required
CreateReplicationDetails
object
Details for creating the replication and replication target.
8 properties
3 required
ValidateKeyTabsDetails
object
Validate keytabs request details.
2 properties
CreateMountTargetDetails
object
Details for creating the mount target.
15 properties
3 required
ScheduleDowngradeShapeMountTargetDetails
object
Shape details about the Mount Target.
1 property
CreateExportDetails
object
Details for creating the export.
6 properties
3 required
ResourceLock
object
Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource.…
4 properties
1 required
MountTarget
object
Provides access to a collection of file systems through one or more VNICs on a specified subnet. The set of file systems is controlled through the referenced e…
24 properties
8 required
ChangeFilesystemSnapshotPolicyCompartmentDetails
object
Details for changing the compartment of a file system snapshot policy.
1 property
1 required
OutboundConnector
object
Outbound connectors are used to help File Storage communicate with an external server, such as an LDAP server. An outbound connector contains all the informati…
11 properties
6 required
ReplicationEstimate
object
Details for response from replication estimation.
5 properties
5 required
KerberosKeytabEntry
object
Details of each keytab entry read from the keytab file.
3 properties
3 required
CreateOutboundConnectorDetails
object
Details for creating the outbound connector.
7 properties
3 required
ChangeFileSystemCompartmentDetails
object
Details for changing the compartment.
1 property
1 required
Replication
object
Replications are the primary resource that governs the policy of cross-region replication between source and target file systems. Replications are associated w…
19 properties
8 required
UpdateFileSystemDetails
object
Details for updating the file system.
5 properties
ValidateKeyTabsResponseDetails
object
Validate keytabs response details.
2 properties
1 required
FilesystemSnapshotPolicy
object
A file system snapshot policy is used to automate snapshot creation and deletion. It contains a list of snapshot schedules that define the frequency of snapsho…
12 properties
5 required
ClientOptions
object
NFS export options applied to a specified set of clients. Only governs access through the associated export. Access to the same file system through a different…
8 properties
1 required
UpdateQuotaRuleDetails
object
Details for updating a quota rule in the file system.
2 properties
UpdateKerberosDetails
object
Kerberos details needed to update configuration.
5 properties
ExportSummary
object
Summary information for an export.
8 properties
6 required
FileSystem
object
An NFS file system. To allow access to a file system, add it to an export set and associate the export set with a mount target. The same file system can be in…
24 properties
6 required
FileSystemSummary
object
Summary information for a file system.
19 properties
6 required
ExportSetSummary
object
Summary information for an export set.
7 properties
6 required
CreateKerberosDetails
object
Kerberos details needed to create configuration.
5 properties
1 required
ToggleQuotaRulesDetails
object
Details for enabling or disabling quota enforcement in the file system.
1 property
1 required
UpdateReplicationDetails
object
Details for updating the replication and replication target.
4 properties
MountTargetSummary
object
Summary information for the specified mount target.
20 properties
7 required
OutboundConnectorSummary
object
Summary information for an outbound connector.
11 properties
6 required
Snapshot
object
A point-in-time snapshot of a specified file system.
18 properties
5 required
SnapshotSchedule
object
The snapshot schedule is a structure within a parent file system snapshot policy. It contains data about the frequency of snapshot creation and the retention t…
10 properties
2 required
UpdateSnapshotDetails
object
Details for updating the snapshot.
4 properties
QuotaRuleSummary
object
Summary information for a principal's usage and quota rule.
11 properties
4 required
QuotaRule
object
A rule that can restrict the logical space that a user or group can consume in a file system.
9 properties
7 required
CreateFileSystemDetails
object
Details for creating the file system.
11 properties
2 required
ChangeMountTargetCompartmentDetails
object
Details for changing the compartment.
1 property
1 required
ReplicationTargetSummary
object
Summary information for replication target.
11 properties
4 required
UpdateFilesystemSnapshotPolicyDetails
object
Details for updating the file system snapshot policy.
5 properties
UpgradeShapeMountTargetDetails
object
Shape details about the Mount Target.
1 property
CreateLdapIdmapDetails
object
Mount target details about the LDAP ID mapping configuration.
8 properties
LockDurationDetails
object
Details for setting a retention date or legal hold.
3 properties
2 required
ChangeOutboundConnectorCompartmentDetails
object
Details for changing the compartment of the outbound connector.
1 property
1 required
UpdateExportSetDetails
object
Details for updating the export set.
3 properties
Export
object
A file system and the path that you can use to mount it. Each export resource belongs to exactly one export set. The export's path attribute is not a path in t…
9 properties
7 required
UpdateMountTargetDetails
object
Details for updating the mount target.
8 properties
FilesystemSnapshotPolicySummary
object
Summary information for a file system snapshot policy.
11 properties
5 required
ExportSet
object
A set of file systems to export through one or more mount targets. Composed of zero or more export resources.
9 properties
6 required
KeyTabSecretDetails
object
Secret details of keytabs in Vault.
3 properties
2 required
ReplicationTarget
object
Replication targets are associated with a primary resource called a [Replication](/en/iaas/latest/Replication) located in another availability domain in the sa…
17 properties
8 required
CreateSnapshotDetails
object
Details for creating the snapshot.
7 properties
2 required
CreateQuotaRuleDetails
object
Details for creating a quota rule in the file system.
5 properties
3 required
SourceDetails
object
Source information for the file system.
2 properties
LdapIdmap
object
Mount target details about the LDAP ID mapping configuration.
8 properties
UpdateLdapIdmapDetails
object
Mount target details about the LDAP ID mapping configuration.
8 properties
UpdateOutboundConnectorDetails
object
Details for updating the outbound connector.
3 properties
Error
object
Details about an error that occurred.
2 properties
2 required
ReplicationSummary
object
Summary information for a replication.
13 properties
4 required
UpdateExportDetails
object
Details for updating the export.
2 properties
CreateFilesystemSnapshotPolicyDetails
object
Details for creating the file system snapshot policy.
8 properties
2 required
ChangeReplicationCompartmentDetails
object
Details for changing the compartment of both replication and replication target.
1 property
1 required
Kerberos
object
Allows administrator to configure a mount target to interact with the administrator's Kerberos infrastructure.
5 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle 12
Other APIs Oracle publishes across the network.
Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
#File Storage
Where this information came from
This is an independent, third-party profile of Oracle File Storage 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.