Oracle Object Storage API

The objectStorage API from Oracle — 41 operation(s) for objectstorage.

Documentation

📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datacc/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling-dp/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/delegate-access-control/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/devops/20210630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/digital-assistant/20190506/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/disaster-recovery/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dms/20211101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/document-understanding/20221109/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/edsfu/20220528/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildelivery/20170907/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildeliverysubmission/20220926/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fleet-management/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functions/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functionsdocgenpbf/1.0/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fusion-applications/20211201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents-client/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-inference/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-nl2sql/20260325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generic/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/globally-distributed-database/20250101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/healthchecks/20180501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-domains/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-dp/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/incidentmanagement/20181231/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/instanceagent/20180530/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/integration/20190131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iot/20250531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/itas/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms/20210610/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-utils/20250521/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/kafka/20240901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/key/release/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/language/20221001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/licensemanager/20220430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits-increase/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits/20181025/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/loadbalancer/20170115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logan-api-spec/20200601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-dataplane/20200831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-management/20200531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-search/20190909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/lustre/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managed-access/20220126/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/management-agent/20200202/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/marketplace/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mngdmac/20250320/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/multicloud-omhub-cp/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/NetMonitor/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20230501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/networkloadbalancer/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/nosql-database/20190828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/OCB/20220509/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occ/20230515/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occds/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occm/20231107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocicache/20220315/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocm/20220919/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opa/20210621/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opensearch/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operations-insights/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operatoraccesscontrol/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/oracle-api-access-control/20241130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20230401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20200801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/osmh/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/postgresql/20220915/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/psasvc/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/publisher/20241201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/queue/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/recovery-service/20210216/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/registry/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-analytics/20241031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-discovery-monitoring-control-api/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-scheduler/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resourcemanager/20180917/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/rover/20201210/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/scanning/20210215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/search/20180409/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretmgmt/20180608/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretretrieval/20190301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secure-desktops/20220618/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/security-attribute/20240815/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/self/20260129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/service-catalog/20210527/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/serviceconnectors/20200909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/smp/20210914/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/speech/20220101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/stack-monitoring/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/threat-intel/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage/20200107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage-proxy/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vision/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder/20210601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder-studio/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20230701/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waa/20211230/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waas/20181116/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waf/20210930/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/wlms/20241101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/workrequests/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing-tools/20240301/

Specifications

OpenAPI Specification

oracle-objectstorage-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Oracle Object Storage API
  version: '20160918'
  license:
    name: Oracle Corporation
  description: 'Operations tagged objectStorage across 2 of this provider''s published API definitions: oci-objectstorage-openapi.yaml, oci-s3objectstorage-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://127.0.0.1/
tags:
- name: objectStorage
paths:
  /n/:
    get:
      description: 'Each Oracle Cloud Infrastructure tenant is assigned one unique and uneditable Object Storage namespace. The namespace

        is a system-generated string assigned during account creation. For some older tenancies, the namespace string may be

        the tenancy name in all lower-case letters. You cannot edit a namespace.


        GetNamespace returns the name of the Object Storage namespace for the user making the request.

        If an optional compartmentId query parameter is provided, GetNamespace returns the namespace name of the corresponding

        tenancy, provided the user has access to it.

        '
      operationId: GetNamespace
      parameters:
      - $ref: '#/components/parameters/ClientRequestIdHeader'
      - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam'
      responses:
        200:
          description: The requesting user's Object Storage namespace string.
          content:
            application/json:
              schema:
                pattern: '[A-Za-z][A-Za-z0-9\\-_\\.]+'
                type: string
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/NotAuthenticated'
        408:
          $ref: '#/components/responses/RequestTimeout'
        429:
          $ref: '#/components/responses/TooManyRequests'
        500:
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/Error'
      summary: GET Namespace Name
      tags:
      - objectStorage
      x-example: 'GET /n/ HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.11.0

        date: Fri, 12 Aug 2016 22:42:15 GMT

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Namespace'
  /n/{namespaceName}:
    get:
      description: 'Gets the metadata for the Object Storage namespace, which contains defaultS3CompartmentId and

        defaultSwiftCompartmentId.


        Any user with the OBJECTSTORAGE_NAMESPACE_READ permission will be able to see the current metadata. If you are

        not authorized, talk to an administrator. If you are an administrator who needs to write policies

        to give users access, see

        [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

        '
      operationId: GetNamespaceMetadata
      parameters:
      - $ref: '#/components/parameters/NamespacePathParam'
      - $ref: '#/components/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: The default metadata.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular

                request, provide this request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NamespaceMetadata'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/NotAuthenticated'
        404:
          $ref: '#/components/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/components/responses/RequestTimeout'
        429:
          $ref: '#/components/responses/TooManyRequests'
        500:
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/Error'
      summary: GET Namespace Metadata
      tags:
      - objectStorage
      x-example: 'GET /n/<var>&lt;namespace_metadata&gt;</var> HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.11.0

        date: Fri, 12 Aug 2016 22:42:15 GMT

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Namespace'
    put:
      description: 'By default, buckets created using the Amazon S3 Compatibility API or the Swift API are created in the root

        compartment of the Oracle Cloud Infrastructure tenancy.


        You can change the default Swift/Amazon S3 compartmentId designation to a different compartmentId. All

        subsequent bucket creations will use the new default compartment, but no previously created

        buckets will be modified. A user must have OBJECTSTORAGE_NAMESPACE_UPDATE permission to make changes to the default

        compartments for Amazon S3 and Swift.

        '
      operationId: UpdateNamespaceMetadata
      parameters:
      - $ref: '#/components/parameters/NamespacePathParam'
      - $ref: '#/components/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: The updated NamespaceMetadata information.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular

                request, provide this request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NamespaceMetadata'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/NotAuthenticated'
        404:
          $ref: '#/components/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/components/responses/RequestTimeout'
        429:
          $ref: '#/components/responses/TooManyRequests'
        500:
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/Error'
      summary: PUT Namespace
      tags:
      - objectStorage
      x-example: "PUT /n/<var>&lt;namespace_metadata&gt;</var> HTTP/1.1\nHost: objectstorage.us-phoenix-1.oraclecloud.com\nconnection: keep-alive\naccept-encoding: gzip, deflate\naccept: */*\nuser-agent: python-requests/2.11.0\ndate: Fri, 12 Aug 2016 22:50:18 GMT\ncontent-type: application/json\nauthorization: <var>&lt;authorization and other headers&gt;</var>\n{\n  \"defaultS3CompartmentId\": \"ocid.compartment.oc1..exampleuniquecompartmentS3ID\",\n  \"defaultSwiftCompartmentId\": \"ocid.compartment.oc1..exampleuniquecompartmentSwiftID\"\n}\n"
      x-related-resource: '#/definitions/Namespace'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateNamespaceMetadataDetails'
        description: Request object for update NamespaceMetadata.
        required: true
  /n/{namespaceName}/b/:
    get:
      description: 'Gets a list of all BucketSummary items in a compartment. A BucketSummary contains only summary fields for the bucket

        and does not contain fields like the user-defined metadata.


        ListBuckets returns a BucketSummary containing at most 1000 buckets. To paginate through more buckets, use the returned

        `opc-next-page` value with the `page` request parameter.


        To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized,

        talk to an administrator. If you are an administrator who needs to write policies to give users access, see

        [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

        '
      operationId: ListBuckets
      parameters:
      - $ref: '#/components/parameters/NamespacePathParam'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/ListBucketFieldsQueryParam'
      - $ref: '#/components/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: A page of BucketSummary objects.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
              schema:
                type: string
            opc-next-page:
              description: 'For paginating a list of buckets.

                In the GET request, set the limit to the number of buckets items that you want returned in the response.

                If the `opc-next-page` header appears in the response, then this is a partial list and there are additional

                buckets to get. Include the header''s value as the `page` parameter in the subsequent GET request to get the

                next batch of buckets. Repeat this process to retrieve the entire list of buckets.

                By default, the page limit is set to 25 buckets per page, but you can specify a value from 1 to 1000.


                For more details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular

                request, provide this request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/BucketSummary'
                type: array
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/NotAuthenticated'
        404:
          $ref: '#/components/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/components/responses/RequestTimeout'
        429:
          $ref: '#/components/responses/TooManyRequests'
        500:
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/Error'
      summary: List Buckets
      tags:
      - objectStorage
      x-example: 'GET /n/<var>&lt;namespace_string&gt;</var>/b/ HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.11.0

        date: Fri, 20 Jan 2017 22:52:33 GMT

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Bucket'
    post:
      description: 'Creates a bucket in the given namespace with a bucket name and optional user-defined metadata. Avoid entering

        confidential information in bucket names.

        '
      operationId: CreateBucket
      parameters:
      - $ref: '#/components/parameters/NamespacePathParam'
      - $ref: '#/components/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: The complete bucket representation, including fields set by the server.
          headers:
            ETag:
              description: The entity tag (ETag) for the bucket that was created.
              schema:
                type: string
            Location:
              description: The full path to the bucket that was created.
              schema:
                type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular

                request, provide this request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Bucket'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/NotAuthenticated'
        404:
          $ref: '#/components/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/components/responses/RequestTimeout'
        409:
          $ref: '#/components/responses/NotAuthorizedOrInternalConflict'
        411:
          $ref: '#/components/responses/ContentLengthRequired'
        429:
          $ref: '#/components/responses/TooManyRequests'
        500:
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/Error'
      summary: Create Bucket
      tags:
      - objectStorage
      x-example: "POST /n/<var>&lt;namespace_string&gt;</var>/b/ HTTP/1.1\nHost: objectstorage.us-phoenix-1.oraclecloud.com\nconnection: keep-alive\naccept-encoding: gzip, deflate\naccept: */*\nuser-agent: python-requests/2.11.0\ndate: Fri, 12 Aug 2016 22:50:18 GMT\nx-content-sha256: GzeGbC8Ad9cEhdcnD2wjPiUej5TIHHw2I+uj4w7Jot4=\nContent-Length: 148\ncontent-type: application/json\nauthorization: <var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid.compartment.oc1..exampleuniquecompartmentID\",\n  \"namespace\": \"ansh8lvru1zp\",\n  \"objectEventsEnabled\": true,\n  \"name\": \"my-test-1\",\n  \"freeformTags\": {\"Department\": \"Finance\"},\n  \"definedTags\":\n  {\n    \"MyTags\":\n    {\n      \"CostCenter\": \"42\",\n      \"Project\": \"Stealth\",\n      \"CreatedBy\": \"BillSmith\",\n      \"CreatedDate\": \"9/21/2017T14:00\"\n    },\n    \"Audit\":\n    {\n      \"DataSensitivity\": \"PII\",\n      \"CageSecurity\": \"High\",\n      \"Simplicity\": \"complex\"\n    }\n  }\n}\n"
      x-related-resource: '#/definitions/Bucket'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBucketDetails'
        description: Request object for creating a bucket.
        required: true
  /n/{namespaceName}/b/{bucketName}/:
    delete:
      description: 'Deletes a bucket if the bucket is already empty. If the bucket is not empty, use

        [DeleteObject](#/en/objectstorage/20160918/Object/DeleteObject) first. In addition,

        you cannot delete a bucket that has a multipart upload in progress or a pre-authenticated

        request associated with that bucket.

        '
      operationId: DeleteBucket
      parameters:
      - $ref: '#/components/parameters/NamespacePathParam'
      - $ref: '#/components/parameters/BucketPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/ClientRequestIdHeader'
      responses:
        204:
          description: The response body is always empty.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular

                request, provide this request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/NotAuthenticated'
        404:
          $ref: '#/components/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/components/responses/RequestTimeout'
        409:
          $ref: '#/components/responses/NotAuthorizedOrInternalConflict'
        412:
          $ref: '#/components/responses/PreconditionFailed'
        429:
          $ref: '#/components/responses/TooManyRequests'
        500:
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/Error'
      summary: DELETE Bucket
      tags:
      - objectStorage
      x-example: 'DELETE /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var> HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.11.0

        date: Fri, 12 Aug 2016 23:04:28 GMT

        content-length: 0

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Bucket'
    get:
      description: 'Gets the current representation of the given bucket in the given Object Storage namespace.

        '
      operationId: GetBucket
      parameters:
      - $ref: '#/components/parameters/NamespacePathParam'
      - $ref: '#/components/parameters/BucketPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/IfNoneMatchHeaderExceptStar'
      - $ref: '#/components/parameters/ClientRequestIdHeader'
      - $ref: '#/components/parameters/GetBucketFieldsQueryParam'
      responses:
        200:
          description: A bucket representation for the requested bucket.
          headers:
            ETag:
              description: The current entity tag (ETag) for the bucket.
              schema:
                type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular

                request, provide this request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Bucket'
        304:
          description: Not Modified
          headers:
            ETag:
              description: The current entity tag (ETag) for the bucket.
              schema:
                type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular

                request, provide this request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/NotAuthenticated'
        404:
          $ref: '#/components/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/components/responses/RequestTimeout'
        412:
          $ref: '#/components/responses/PreconditionFailed'
        429:
          $ref: '#/components/responses/TooManyRequests'
        500:
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/Error'
      summary: GET Bucket
      tags:
      - objectStorage
      x-example: 'GET /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var> HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.11.0

        date: Fri, 12 Aug 2016 22:52:33 GMT

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Bucket'
    head:
      description: 'Efficiently checks to see if a bucket exists and gets the current entity tag (ETag) for the bucket.

        '
      operationId: HeadBucket
      parameters:
      - $ref: '#/components/parameters/NamespacePathParam'
      - $ref: '#/components/parameters/BucketPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/IfNoneMatchHeaderExceptStar'
      - $ref: '#/components/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: The bucket exists.
          headers:
            ETag:
              description: The current entity tag (ETag) for the bucket.
              schema:
                type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular

                request, provide this request ID.

                '
              schema:
                type: string
        304:
          description: Not Modified
          headers:
            ETag:
              description: The current entity tag (ETag) for the bucket.
              schema:
                type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular

                request, provide this request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/NotAuthenticated'
        404:
          $ref: '#/components/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/components/responses/RequestTimeout'
        412:
          $ref: '#/components/responses/PreconditionFailed'
        429:
          $ref: '#/components/responses/TooManyRequests'
        500:
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/Error'
      summary: HEAD Bucket
      tags:
      - objectStorage
      x-example: 'HEAD /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var> HTTP/1.1

        Host: objectstorage.us-phoenix-1.oraclecloud.com

        connection: keep-alive

        accept-encoding: gzip, deflate

        accept: */*

        user-agent: python-requests/2.11.0

        date: Fri, 12 Aug 2016 22:52:33 GMT

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Bucket'
    post:
      description: 'Performs a partial or full update of a bucket''s user-defined metadata.


        Use UpdateBucket to move a bucket from one compartment to another within the same tenancy. Supply the compartmentID

        of the compartment that you want to move the bucket to. For more information about moving resources between compartments,

        see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

        '
      operationId: UpdateBucket
      parameters:
      - $ref: '#/components/parameters/NamespacePathParam'
      - $ref: '#/components/parameters/BucketPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: The full representation of the bucket, including fields set by the server.
          headers:
            ETag:
              description: The entity tag (ETag) for the updated bucket.
              schema:
                type: string
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular

                request, provide this request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Bucket'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/NotAuthenticated'
        404:
          $ref: '#/components/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/components/responses/RequestTimeout'
        409:
          $ref: '#/components/responses/NotAuthorizedOrInternalConflict'
        412:
          $ref: '#/components/responses/PreconditionFailed'
        429:
          $ref: '#/components/responses/TooManyRequests'
        500:
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/Error'
      summary: POST Bucket
      tags:
      - objectStorage
      x-example: "POST /n/<var>&lt;namespace_string&gt;</var>/b/<var>&lt;bucket_name&gt;</var> HTTP/1.1\nHost: objectstorage.us-phoenix-1.oraclecloud.com\nconnection: keep-alive\naccept-encoding: gzip, deflate\naccept: */*\nuser-agent: python-requests/2.10.0\ndate: Tue, 23 Aug 2016 21:01:55 GMT\nx-content-sha256: XK0yY+agfR3IHWjFyQlO5LCU8IysvgpDdDGSRrb/xzA=\nContent-Length: 80\ncontent-type: application/json\nauthorization: <var>&lt;authorization and other headers&gt;</var>\n{\n  \"namespace\": \"ansh8lvru1zp\",\n  \"name\": \"MyBucket\",\n  \"metadata\":\n    {\n      \"foo\": \"bar\"\n    },\n  \"objectEventsEnabled\": true,  \n  \"freeformTags\": {\"Department\": \"Finance\"},\n  \"definedTags\":\n  {\n    \"MyTags\":\n    {\n      \"CostCenter\": \"42\",\n       \"Project\": \"Stealth\",\n      \"CreatedBy\": \"BillSmith\",\n      \"CreatedDate\": \"9/21/2017T14:00\"\n    },\n    \"Audit\":\n    {\n      \"DataSensitivity\": \"PII\",\n      \"CageSecurity\": \"High\",\n      \"Simplicity\": \"complex\"\n    }\n  }\n}\n"
      x-related-resource: '#/definitions/Bucket'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBucketDetails'
        description: Request object for updating a bucket.
        required: true
  /n/{namespaceName}/b/{bucketName}/actions/batchDeleteObjects:
    post:
      description: Deletes a batch of objects.
      operationId: BatchDeleteObjects
      parameters:
      - $ref: '#/components/parameters/NamespacePathParam'
      - $ref: '#/components/parameters/BucketPathParam'
      - $ref: '#/components/parameters/ClientRequestIdHeader'
      responses:
        200:
          description: Always returns this status code if the request was processed after validation, authentication and authorization.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular

                request, provide this request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchDeleteObjectsResult'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/NotAuthenticated'
        403:
          $ref: '#/components/responses/Forbidden'
        404:
          $ref: '#/components/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/components/responses/RequestTimeout'
        429:
          $ref: '#/components/responses/TooManyRequests'
        500:
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/Error'
      summary: Deletes a batch of objects.
      tags:
      - objectStorage
      x-example: "POST /n/example_namespace/b/example_bucket/actions/deleteObjects\nHost: objectstorage.us-phoenix-1.oraclecloud.com\nUser-Agent: curl/7.43.0\nAccept: */*\nContent-Type: application/json\nContent-Length: 139\nDate: Fri, 31 Oct 2025 11:50:24 GMT\nAuthorization: <var>&lt;authorization_string&gt;</var>\n{\n  \"objects\": [\n    {\n      \"objectName\": \"object1\",\n      \"ifMatch\": \"etag1\"\n    },\n    {\n      \"objectName\": \"object2\",\n      \"ifMatch\": \"etag1\"\n    },\n    {\n      \"objectName\": \"object3\",\n    }\n  ],\n  \"isSkipDeletedResult\": false\n}\n"
      x-related-resource: '#/definitions/Object'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchDeleteObjectsDetails'
        description: Details about batch of objects to be deleted.
        required: true
  /n/{namespaceName}/b/{bucketName}/actions/copyObject:
    post:
      description: 'Creates a request to copy an object within a region or to another region.


        See [Object Names](/Content/Object/Tasks/managingobjects.htm#namerequirements)

        for object naming requirements.

        '
      operationId: CopyObject
      parameters:
      - $ref: '#/components/parameters/NamespacePathParam'
      - $ref: '#/components/parameters/BucketPathParam'
      - $ref: '#/components/parameters/ClientRequestIdHeader'
      - $ref: '#/components/parameters/OptionalSSECustomerAlgorithmHeader'
      - $ref: '#/components/parameters/OptionalSSECustomerKeyHeader'
      - $ref: '#/components/parameters/OptionalSSECustomerKeySHA256Header'
      - $ref: '#/components/parameters/OptionalSrcSSECustomerAlgorithmHeader'
      - $ref: '#/components/parameters/OptionalSrcSSECustomerKeyHeader'
      - $ref: '#/components/parameters/OptionalSrcSSECustomerKeySHA256Header'
      - $ref: '#/components/parameters/OptionalSSEKMSKeyIdHeader'
      responses:
        202:
          description: The request has been accepted for processing, but the processing has not completed.
          headers:
            opc-client-request-id:
              description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular

                request, provide this request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. If you need to contact Oracle about a

                particular request, provide this request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/NotAuthenticated'
        404:
          $ref: '#/components/responses/NotAuthorizedOrNotFound'
        408:
          $ref: '#/components/responses/RequestTimeout'
        429:
          $ref: '#/components/responses/TooManyRequests'
        500:
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/Error'
      summary: Creates a copy 

# --- truncated at 32 KB (399 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-objectstorage-api-openapi.yml