{ "opencollection": "1.0.0", "info": { "name": "Oracle Object Storage API", "version": "20160918" }, "items": [ { "info": { "name": "objectStorage", "type": "folder" }, "items": [ { "info": { "name": "GET Namespace Name", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/n/", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "This is an optional field representing either the tenancy [OCID](/Content/General/Concepts/identifiers.htm) or the compartment\n[OCID](/Content/General/Concepts/identifiers.htm) within the tenancy whose Object Storage namespace is to be retrieved.\n" } ] }, "docs": "Each Oracle Cloud Infrastructure tenant is assigned one unique and uneditable Object Storage namespace. The namespace\nis a system-generated string assigned during account creation. For some older tenancies, the namespace string may be\nthe tenancy name in all lower-case letters. You cannot edit a namespace.\n\nGetNamespace returns the name of the Object Storage namespace for the user making the request.\nIf an optional compartmentId query parameter is provided, GetNamespace returns the namespace nam" }, { "info": { "name": "GET Namespace Metadata", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/n/:namespaceName", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." } ] }, "docs": "Gets the metadata for the Object Storage namespace, which contains defaultS3CompartmentId and\ndefaultSwiftCompartmentId.\n\nAny user with the OBJECTSTORAGE_NAMESPACE_READ permission will be able to see the current metadata. If you are\nnot authorized, talk to an administrator. If you are an administrator who needs to write policies\nto give users access, see\n[Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).\n" }, { "info": { "name": "PUT Namespace", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/n/:namespaceName", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "By default, buckets created using the Amazon S3 Compatibility API or the Swift API are created in the root\ncompartment of the Oracle Cloud Infrastructure tenancy.\n\nYou can change the default Swift/Amazon S3 compartmentId designation to a different compartmentId. All\nsubsequent bucket creations will use the new default compartment, but no previously created\nbuckets will be modified. A user must have OBJECTSTORAGE_NAMESPACE_UPDATE permission to make changes to the default\ncompartments for Amazon S" }, { "info": { "name": "List Buckets", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/n/:namespaceName/b/", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list buckets." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important\ndetails about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "fields", "value": "", "type": "query", "description": "Bucket summary in list of buckets includes the 'namespace', 'name', 'compartmentId', 'createdBy', 'timeCreated',\nand 'etag' fields. This parameter can also include 'tags' (freeformTags and definedTags). The only supported value of this parameter is 'tags' for now. Example 'tags'.\n" } ] }, "docs": "Gets a list of all BucketSummary items in a compartment. A BucketSummary contains only summary fields for the bucket\nand does not contain fields like the user-defined metadata.\n\nListBuckets returns a BucketSummary containing at most 1000 buckets. To paginate through more buckets, use the returned\n`opc-next-page` value with the `page` request parameter.\n\nTo use this and other API operations, you must be authorized in an IAM policy. If you are not authorized,\ntalk to an administrator. If you are a" }, { "info": { "name": "Create Bucket", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/n/:namespaceName/b/", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a bucket in the given namespace with a bucket name and optional user-defined metadata. Avoid entering\nconfidential information in bucket names.\n" }, { "info": { "name": "GET Bucket", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/", "headers": [ { "name": "if-match", "value": "" }, { "name": "if-none-match", "value": "" }, { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "fields", "value": "", "type": "query", "description": "Bucket summary includes the 'namespace', 'name', 'compartmentId', 'createdBy', 'timeCreated',\nand 'etag' fields. This parameter can also include 'approximateCount' (approximate number of objects), 'approximateSize'\n(total approximate size in bytes of all objects) and 'autoTiering' (state of auto tiering on the bucket).\nFor example 'approximateCount,approximateSize,autoTiering'.\n" } ] }, "docs": "Gets the current representation of the given bucket in the given Object Storage namespace.\n" }, { "info": { "name": "POST Bucket", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Performs a partial or full update of a bucket's user-defined metadata.\n\nUse UpdateBucket to move a bucket from one compartment to another within the same tenancy. Supply the compartmentID\nof the compartment that you want to move the bucket to. For more information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "DELETE Bucket", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" } ] }, "docs": "Deletes a bucket if the bucket is already empty. If the bucket is not empty, use\n[DeleteObject](#/en/objectstorage/20160918/Object/DeleteObject) first. In addition,\nyou cannot delete a bucket that has a multipart upload in progress or a pre-authenticated\nrequest associated with that bucket.\n" }, { "info": { "name": "HEAD Bucket", "type": "http" }, "http": { "method": "HEAD", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/", "headers": [ { "name": "if-match", "value": "" }, { "name": "if-none-match", "value": "" }, { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" } ] }, "docs": "Efficiently checks to see if a bucket exists and gets the current entity tag (ETag) for the bucket.\n" }, { "info": { "name": "Deletes a batch of objects.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/actions/batchDeleteObjects", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a batch of objects." }, { "info": { "name": "Creates a copy object request.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/actions/copyObject", "headers": [ { "name": "opc-client-request-id", "value": "" }, { "name": "opc-sse-customer-algorithm", "value": "" }, { "name": "opc-sse-customer-key", "value": "" }, { "name": "opc-sse-customer-key-sha256", "value": "" }, { "name": "opc-source-sse-customer-algorithm", "value": "" }, { "name": "opc-source-sse-customer-key", "value": "" }, { "name": "opc-source-sse-customer-key-sha256", "value": "" }, { "name": "opc-sse-kms-key-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a request to copy an object within a region or to another region.\n\nSee [Object Names](/Content/Object/Tasks/managingobjects.htm#namerequirements)\nfor object naming requirements.\n" }, { "info": { "name": "Stops the replication policy associated with a destination bucket.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/actions/makeBucketWritable", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" } ] }, "docs": "Stops replication to the destination bucket and removes the replication policy. When the replication\npolicy was created, this destination bucket became read-only except for new and changed objects replicated\nautomatically from the source bucket. MakeBucketWritable removes the replication policy. This bucket is no\nlonger the target for replication and is now writable, allowing users to make changes to bucket contents.\n" }, { "info": { "name": "Re-encrypt Bucket Data Encryption Key", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/actions/reencrypt", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "isReencryptBucketKeyOnly", "value": "", "type": "query", "description": "If true, reencrypt only the intermediate bucket keys and skip everything else in the bucket." } ] }, "docs": "Re-encrypts the unique data encryption key that encrypts each object written to the bucket by using the most recent \nversion of the master encryption key assigned to the bucket. (All data encryption keys are encrypted by a master \nencryption key. Master encryption keys are assigned to buckets and managed by Oracle by default, but you can assign \na key that you created and control through the Oracle Cloud Infrastructure Key Management service.) The kmsKeyId property \nof the bucket determines whic" }, { "info": { "name": "Re-encrypt the data encryption keys associated with an object", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/actions/reencrypt/:objectName", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "objectName", "value": "", "type": "path", "description": "The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n" }, { "name": "versionId", "value": "", "type": "query", "description": "VersionId used to identify a particular version of the object" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Re-encrypts the data encryption keys that encrypt the object and its chunks. By default, when you create a bucket, the Object Storage\nservice manages the master encryption key used to encrypt each object's data encryption keys. The encryption mechanism that you specify for\nthe bucket applies to the objects it contains.\n\nYou can alternatively employ one of these encryption strategies for an object:\n\n- You can assign a key that you created and control through the Oracle Cloud Infrastructure Vault " }, { "info": { "name": "Rename Object", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/actions/renameObject", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Rename an object in the given Object Storage namespace.\n\nSee [Object Names](/Content/Object/Tasks/managingobjects.htm#namerequirements)\nfor object naming requirements.\n" }, { "info": { "name": "Restore Object", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/actions/restoreObjects", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restores the object specified by the objectName parameter.\nBy default object will be restored for 24 hours. Duration can be configured using the hours parameter.\n" }, { "info": { "name": "Move the object into a different storage tier", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/actions/updateObjectStorageTier", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes the storage tier of the object specified by the objectName parameter.\n" }, { "info": { "name": "GET object lifecycle policy", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/l", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" } ] }, "docs": "Gets the object lifecycle policy for the bucket.\n" }, { "info": { "name": "Put object lifecycle policy.", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/l", "headers": [ { "name": "opc-client-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "if-none-match", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or replaces the object lifecycle policy for the bucket.\n" }, { "info": { "name": "Delete object lifecycle policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/l", "headers": [ { "name": "opc-client-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" } ] }, "docs": "Deletes the object lifecycle policy for the bucket.\n" }, { "info": { "name": "List Objects", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/o", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "prefix", "value": "", "type": "query", "description": "The string to use for matching against the start of object names in a list query." }, { "name": "start", "value": "", "type": "query", "description": "Returns object names which are lexicographically greater than or equal to this parameter." }, { "name": "end", "value": "", "type": "query", "description": "Returns object names which are lexicographically strictly less than this parameter." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "delimiter", "value": "", "type": "query", "description": "When this parameter is set, only objects whose names do not contain the delimiter character\n(after an optionally specified prefix) are returned in the objects key of the response body.\nScanned objects whose names contain the delimiter have the part of their name up to the first\noccurrence of the delimiter (including the optional prefix) returned as a set of prefixes.\nNote that only '/' is a supported delimiter character at this time.\n" }, { "name": "fields", "value": "", "type": "query", "description": "Object summary by default includes only the 'name' field. Use this parameter to also\ninclude 'size' (object size in bytes), 'etag', 'md5', 'timeCreated' (object creation date and time),\n'timeModified' (object modification date and time), 'storageTier' and 'archivalState' fields.\nSpecify the value of this parameter as a comma-separated, case-insensitive list of those field names. \nFor example 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'.\n" }, { "name": "startAfter", "value": "", "type": "query", "description": "Returns object names which are lexicographically strictly greater than this parameter." } ] }, "docs": "Lists the objects in a bucket. By default, ListObjects returns object names only. See the `fields`\nparameter for other fields that you can optionally include in ListObjects response.\n\nListObjects returns at most 1000 objects. To paginate through more objects, use the returned 'nextStartWith'\nvalue with the 'start' parameter. To filter which objects ListObjects returns, use the 'start' and 'end'\nparameters.\n\nTo use this and other API operations, you must be authorized in an IAM policy. If you are" }, { "info": { "name": "GET Object", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/o/:objectName", "headers": [ { "name": "if-match", "value": "" }, { "name": "if-none-match", "value": "" }, { "name": "opc-client-request-id", "value": "" }, { "name": "range", "value": "" }, { "name": "opc-sse-customer-algorithm", "value": "" }, { "name": "opc-sse-customer-key", "value": "" }, { "name": "opc-sse-customer-key-sha256", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "objectName", "value": "", "type": "path", "description": "The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n" }, { "name": "versionId", "value": "", "type": "query", "description": "VersionId used to identify a particular version of the object" }, { "name": "httpResponseContentDisposition", "value": "", "type": "query", "description": "Specify this query parameter to override the value of the Content-Disposition response header in the GetObject response." }, { "name": "httpResponseCacheControl", "value": "", "type": "query", "description": "Specify this query parameter to override the Cache-Control response header in the GetObject response." }, { "name": "httpResponseContentType", "value": "", "type": "query", "description": "Specify this query parameter to override the Content-Type response header in the GetObject response." }, { "name": "httpResponseContentLanguage", "value": "", "type": "query", "description": "Specify this query parameter to override the Content-Language response header in the GetObject response." }, { "name": "httpResponseContentEncoding", "value": "", "type": "query", "description": "Specify this query parameter to override the Content-Encoding response header in the GetObject response." }, { "name": "httpResponseExpires", "value": "", "type": "query", "description": "Specify this query parameter to override the Expires response header in the GetObject response." } ] }, "docs": "Gets the metadata and body of an object. \n" }, { "info": { "name": "PUT Object", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/o/:objectName", "headers": [ { "name": "if-match", "value": "" }, { "name": "if-none-match", "value": "" }, { "name": "opc-client-request-id", "value": "" }, { "name": "Expect", "value": "" }, { "name": "Content-Length", "value": "" }, { "name": "Content-MD5", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Language", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Content-Disposition", "value": "" }, { "name": "Cache-Control", "value": "" }, { "name": "opc-sse-customer-algorithm", "value": "" }, { "name": "opc-sse-customer-key", "value": "" }, { "name": "opc-sse-customer-key-sha256", "value": "" }, { "name": "opc-sse-kms-key-id", "value": "" }, { "name": "storage-tier", "value": "" }, { "name": "opc-meta-*", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "objectName", "value": "", "type": "path", "description": "The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n" }, { "name": "isAppend", "value": "", "type": "query", "description": "The option to commit a new chunk of data to the end of an existing object. If the object doesn't exist, it'll create a new one.\nThe maximum size of the data to append to an object in a single append request is 512MB. Each object can only be appended up to 10,000 times.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new object or overwrites an existing object with the same name. The maximum object size allowed by\nPutObject is 50 GiB.\n\nSee [Object Names](/Content/Object/Tasks/managingobjects.htm#namerequirements)\nfor object naming requirements. \n\nSee [Special Instructions for Object Storage PUT](/Content/API/Concepts/signingrequests.htm#ObjectStoragePut)\nfor request signature requirements.\n" }, { "info": { "name": "DELETE Object", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/o/:objectName", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "objectName", "value": "", "type": "path", "description": "The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n" }, { "name": "versionId", "value": "", "type": "query", "description": "VersionId used to identify a particular version of the object" } ] }, "docs": "Deletes an object.\n" }, { "info": { "name": "HEAD Object", "type": "http" }, "http": { "method": "HEAD", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/o/:objectName", "headers": [ { "name": "if-match", "value": "" }, { "name": "if-none-match", "value": "" }, { "name": "opc-client-request-id", "value": "" }, { "name": "opc-sse-customer-algorithm", "value": "" }, { "name": "opc-sse-customer-key", "value": "" }, { "name": "opc-sse-customer-key-sha256", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "objectName", "value": "", "type": "path", "description": "The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n" }, { "name": "versionId", "value": "", "type": "query", "description": "VersionId used to identify a particular version of the object" } ] }, "docs": "Gets the user-defined metadata and entity tag (ETag) for an object.\n" }, { "info": { "name": "List Object Versions", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/objectversions", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "prefix", "value": "", "type": "query", "description": "The string to use for matching against the start of object names in a list query." }, { "name": "start", "value": "", "type": "query", "description": "Returns object names which are lexicographically greater than or equal to this parameter." }, { "name": "end", "value": "", "type": "query", "description": "Returns object names which are lexicographically strictly less than this parameter." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "delimiter", "value": "", "type": "query", "description": "When this parameter is set, only objects whose names do not contain the delimiter character\n(after an optionally specified prefix) are returned in the objects key of the response body.\nScanned objects whose names contain the delimiter have the part of their name up to the first\noccurrence of the delimiter (including the optional prefix) returned as a set of prefixes.\nNote that only '/' is a supported delimiter character at this time.\n" }, { "name": "fields", "value": "", "type": "query", "description": "Object summary by default includes only the 'name' field. Use this parameter to also\ninclude 'size' (object size in bytes), 'etag', 'md5', 'timeCreated' (object creation date and time),\n'timeModified' (object modification date and time), 'storageTier' and 'archivalState' fields.\nSpecify the value of this parameter as a comma-separated, case-insensitive list of those field names. \nFor example 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'.\n" }, { "name": "startAfter", "value": "", "type": "query", "description": "Returns object names which are lexicographically strictly greater than this parameter." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important\ndetails about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the object versions in a bucket.\n\nListObjectVersions returns an ObjectVersionCollection containing at most 1000 object versions. To paginate through\nmore object versions, use the returned `opc-next-page` value with the `page` request parameter.\n\nTo use this and other API operations, you must be authorized in an IAM policy. If you are not authorized,\ntalk to an administrator. If you are an administrator who needs to write policies to give users access, see\n[Getting Started with Policies](/C" }, { "info": { "name": "List Preauthenticated Requests", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/p/", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "objectNamePrefix", "value": "", "type": "query", "description": "User-specified object name prefixes can be used to query and return a list of pre-authenticated requests." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important\ndetails about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists pre-authenticated requests for the bucket.\n" }, { "info": { "name": "Create Preauthenticated Request", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/p/", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a pre-authenticated request specific to the bucket.\n" }, { "info": { "name": "GET Preauthenticated Request", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/p/:parId", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "parId", "value": "", "type": "path", "description": "The unique identifier for the pre-authenticated request. This can be used to manage operations against\nthe pre-authenticated request, such as GET or DELETE.\n" } ] }, "docs": "Gets the pre-authenticated request for the bucket." }, { "info": { "name": "DELETE Preauthenticated Request", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/p/:parId", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "parId", "value": "", "type": "path", "description": "The unique identifier for the pre-authenticated request. This can be used to manage operations against\nthe pre-authenticated request, such as GET or DELETE.\n" } ] }, "docs": "Deletes the pre-authenticated request for the bucket." }, { "info": { "name": "List the replication policies associated with a bucket.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/replicationPolicies", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important\ndetails about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "List the replication policies associated with a bucket.\n" }, { "info": { "name": "Create replication policy.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/replicationPolicies", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a replication policy for the specified bucket.\n" }, { "info": { "name": "Get replication policy.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/replicationPolicies/:replicationId", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "replicationId", "value": "", "type": "path", "description": "The ID of the replication policy." } ] }, "docs": "Get the replication policy.\n" }, { "info": { "name": "Delete replication policy.", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/replicationPolicies/:replicationId", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "replicationId", "value": "", "type": "path", "description": "The ID of the replication policy." } ] }, "docs": "Deletes the replication policy associated with the source bucket.\n" }, { "info": { "name": "List the replication sources of a destination bucket.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/replicationSources", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important\ndetails about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "List the replication sources of a destination bucket.\n" }, { "info": { "name": "List the retention rules for a bucket.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/retentionRules", "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important\ndetails about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "List the retention rules for a bucket. The retention rules are sorted based on creation time,\nwith the most recently created retention rule returned first.\n" }, { "info": { "name": "Create a new retention rule.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/retentionRules", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new retention rule in the specified bucket. The new rule will take effect typically within 30 seconds.\nNote that a maximum of 100 rules are supported on a bucket.\n" }, { "info": { "name": "Get the specified retention rule.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/retentionRules/:retentionRuleId", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "retentionRuleId", "value": "", "type": "path", "description": "The ID of the retention rule." } ] }, "docs": "Get the specified retention rule." }, { "info": { "name": "Update the specified retention rule.", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/retentionRules/:retentionRuleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "retentionRuleId", "value": "", "type": "path", "description": "The ID of the retention rule." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified retention rule. Rule changes take effect typically within 30 seconds.\n" }, { "info": { "name": "Delete the specified retention rule.", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/retentionRules/:retentionRuleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "retentionRuleId", "value": "", "type": "path", "description": "The ID of the retention rule." } ] }, "docs": "Deletes the specified rule. The deletion takes effect typically within 30 seconds." }, { "info": { "name": "List Multipart Uploads", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/u", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important\ndetails about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists all of the in-progress multipart uploads for the given bucket in the given Object Storage namespace.\n" }, { "info": { "name": "Create Multipart Upload", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/u", "headers": [ { "name": "if-match", "value": "" }, { "name": "if-none-match", "value": "" }, { "name": "opc-client-request-id", "value": "" }, { "name": "opc-sse-customer-algorithm", "value": "" }, { "name": "opc-sse-customer-key", "value": "" }, { "name": "opc-sse-customer-key-sha256", "value": "" }, { "name": "opc-sse-kms-key-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Starts a new multipart upload to a specific object in the given bucket in the given namespace.\n\nSee [Object Names](/Content/Object/Tasks/managingobjects.htm#namerequirements)\nfor object naming requirements.\n" }, { "info": { "name": "List Multipart Upload Parts", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/u/:objectName", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "objectName", "value": "", "type": "path", "description": "The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n" }, { "name": "uploadId", "value": "", "type": "query", "description": "The upload ID for a multipart upload." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important\ndetails about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the parts of an in-progress multipart upload.\n" }, { "info": { "name": "Commit Multipart Upload", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/u/:objectName", "headers": [ { "name": "if-match", "value": "" }, { "name": "if-none-match", "value": "" }, { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "objectName", "value": "", "type": "path", "description": "The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n" }, { "name": "uploadId", "value": "", "type": "query", "description": "The upload ID for a multipart upload." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Commits a multipart upload, which involves checking part numbers and entity tags (ETags) of the parts, to create an aggregate object.\n" }, { "info": { "name": "Upload Multipart Object Part", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/u/:objectName", "headers": [ { "name": "opc-client-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "if-none-match", "value": "" }, { "name": "Expect", "value": "" }, { "name": "Content-Length", "value": "" }, { "name": "Content-MD5", "value": "" }, { "name": "opc-sse-customer-algorithm", "value": "" }, { "name": "opc-sse-customer-key", "value": "" }, { "name": "opc-sse-customer-key-sha256", "value": "" }, { "name": "opc-sse-kms-key-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "objectName", "value": "", "type": "path", "description": "The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n" }, { "name": "uploadId", "value": "", "type": "query", "description": "The upload ID for a multipart upload." }, { "name": "uploadPartNum", "value": "", "type": "query", "description": "The part number that identifies the object part currently being uploaded." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Uploads a single part of a multipart upload.\n" }, { "info": { "name": "Abort Multipart Upload", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/n/:namespaceName/b/:bucketName/u/:objectName", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n" }, { "name": "objectName", "value": "", "type": "path", "description": "The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n" }, { "name": "uploadId", "value": "", "type": "query", "description": "The upload ID for a multipart upload." } ] }, "docs": "Aborts an in-progress multipart upload and deletes all parts that have been uploaded.\n" }, { "info": { "name": "List the inventory rules.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/n/:namespaceName/inventoryRules", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important\ndetails about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "List the inventory rules.\n" }, { "info": { "name": "Create a new inventory rule.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/n/:namespaceName/inventoryRules", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new inventory rule in the namespace\n" }, { "info": { "name": "Get the specified inventory rule.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/n/:namespaceName/inventoryRules/:inventoryRuleId", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "inventoryRuleId", "value": "", "type": "path", "description": "The ID of the inventory rule." } ] }, "docs": "Get the specified inventory rule." }, { "info": { "name": "Update the specified inventory rule.", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/n/:namespaceName/inventoryRules/:inventoryRuleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "inventoryRuleId", "value": "", "type": "path", "description": "The ID of the inventory rule." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified inventory rule. Rule changes take effect typically within 30 seconds.\n" }, { "info": { "name": "Delete the specified inventory rule.", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/n/:namespaceName/inventoryRules/:inventoryRuleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "inventoryRuleId", "value": "", "type": "path", "description": "The ID of the inventory rule." } ] }, "docs": "Deletes the specified rule." }, { "info": { "name": "List Private Endpoints", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/n/:namespaceName/pe/", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list buckets." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important\ndetails about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "fields", "value": "", "type": "query", "description": "PrivateEndpoint summary in list of PrivateEndpoints includes the 'namespace', 'name', 'compartmentId', \n'createdBy', 'timeCreated', 'timeModified' and 'etag' fields. \nThis parameter can also include 'tags' (freeformTags and definedTags). \nThe only supported value of this parameter is 'tags' for now. Example 'tags'.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The lifecycle state of the Private Endpoint" } ] }, "docs": "Gets a list of all PrivateEndpointSummary in a compartment associated with a namespace.\nTo use this and other API operations, you must be authorized in an IAM policy. If you are not authorized,\ntalk to an administrator. If you are an administrator who needs to write policies to give users access, see\n[Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).\n" }, { "info": { "name": "Create PrivateEndpoint", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/n/:namespaceName/pe/", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a PrivateEndpoint.\n" }, { "info": { "name": "Get PrivateEndpoint", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/n/:namespaceName/pe/:peName/", "headers": [ { "name": "if-match", "value": "" }, { "name": "if-none-match", "value": "" }, { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "peName", "value": "", "type": "path", "description": "The name of the private endpoint. Avoid entering confidential information.\nExample: `my-new-pe-1`\n" } ] }, "docs": "Gets the current representation of the given Private Endpoint in the given Object Storage namespace.\n" }, { "info": { "name": "POST Private Endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/n/:namespaceName/pe/:peName/", "headers": [ { "name": "opc-client-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "peName", "value": "", "type": "path", "description": "The name of the private endpoint. Avoid entering confidential information.\nExample: `my-new-pe-1`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Performs a partial or full update of a user-defined data associated with the Private Endpoint.\n\nUse UpdatePrivateEndpoint to move a Private Endpoint from one compartment to another within the same tenancy. Supply the compartmentID\nof the compartment that you want to move the Private Endpoint to. Or use it to update the name, subnetId, endpointFqdn or privateEndpointIp or accessTargets of the Private Endpoint.\nFor more information about moving resources between compartments, see [Moving Resources" }, { "info": { "name": "DELETE Private Endpoint", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/n/:namespaceName/pe/:peName/", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The Object Storage namespace used for the request." }, { "name": "peName", "value": "", "type": "path", "description": "The name of the private endpoint. Avoid entering confidential information.\nExample: `my-new-pe-1`\n" } ] }, "docs": "Deletes a Private Endpoint if it exists in the given namespace.\n" }, { "info": { "name": "List Work Requests", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/workRequests", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list buckets." }, { "name": "privateEndpointName", "value": "", "type": "query", "description": "The name of the privateEndpoint for which to list work requests." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important\ndetails about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "GET Work Request Status", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/workRequests/:workRequestId", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Gets the status of the work request for the given ID." }, { "info": { "name": "Cancel a work request", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/workRequests/:workRequestId", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Cancels a work request.\n" }, { "info": { "name": "List Work Request Errors", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important\ndetails about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Lists the errors of the work request with the given ID." }, { "info": { "name": "List Work Request Logs", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-client-request-id", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important\ndetails about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Lists the logs of the work request with the given ID." }, { "info": { "name": "GET Object", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/:bucketName/:objectName", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "range", "value": "" }, { "name": "x-amz-date", "value": "" }, { "name": "x-amz-server-side-encryption-customer-algorithm", "value": "" }, { "name": "x-amz-server-side-encryption-customer-key", "value": "" }, { "name": "x-amz-server-side-encryption-customer-key-md5", "value": "" } ], "params": [ { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\n\nExample: `my-new-bucket1`\n" }, { "name": "objectName", "value": "", "type": "path", "description": "The name of the object. Avoid entering confidential information.\n\nExample: `test/object1.log`\n" }, { "name": "response-content-disposition", "value": "", "type": "query", "description": "Specify this query parameter to override the value of the Content-Disposition response header in the GetObject response." }, { "name": "response-cache-control", "value": "", "type": "query", "description": "Specify this query parameter to override the value of the Cache-Control response header in the GetObject response." }, { "name": "response-content-type", "value": "", "type": "query", "description": "Specify this query parameter to override the value of the Content-Type response header in the GetObject response." }, { "name": "response-content-language", "value": "", "type": "query", "description": "Specify this query parameter to override the value of the Content-Language response header in the GetObject response." }, { "name": "response-content-encoding", "value": "", "type": "query", "description": "Specify this query parameter to override the value of the Content-Encoding response header in the GetObject response." }, { "name": "response-expires", "value": "", "type": "query", "description": "Specify this query parameter to override the value of the Expires response header in the GetObject response." } ] }, "docs": "Retrieves an object.\n" }, { "info": { "name": "PUT Object", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/:bucketName/:objectName", "headers": [ { "name": "Expect", "value": "" }, { "name": "Content-Length", "value": "" }, { "name": "Content-MD5", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Content-Disposition", "value": "" }, { "name": "x-amz-content-sha256", "value": "" }, { "name": "x-amz-checksum-sha256", "value": "" }, { "name": "Cache-Control", "value": "" }, { "name": "x-amz-meta-*", "value": "" }, { "name": "x-amz-metadata-directive", "value": "" }, { "name": "x-amz-copy-source", "value": "" }, { "name": "x-amz-copy-source-if-match", "value": "" }, { "name": "x-amz-copy-source-if-none-match", "value": "" }, { "name": "x-amz-copy-source-if-unmodified-since", "value": "" }, { "name": "x-amz-copy-source-if-modified-since", "value": "" }, { "name": "x-amz-storage-class", "value": "" }, { "name": "x-amz-server-side-encryption-customer-algorithm", "value": "" }, { "name": "x-amz-server-side-encryption-customer-key", "value": "" }, { "name": "x-amz-server-side-encryption-customer-key-md5", "value": "" }, { "name": "x-amz-server-side-encryption-aws-kms-key-id", "value": "" }, { "name": "x-amz-copy-source-server-side-encryption-customer-algorithm", "value": "" }, { "name": "x-amz-copy-source-server-side-encryption-customer-key", "value": "" }, { "name": "x-amz-copy-source-server-side-encryption-customer-key-md5", "value": "" } ], "params": [ { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\n\nExample: `my-new-bucket1`\n" }, { "name": "objectName", "value": "", "type": "path", "description": "The name of the object. Avoid entering confidential information.\n\nExample: `test/object1.log`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new object or overwrites an existing one.\n\nTo use this and other API operations, you must be authorized in an IAM policy. If you're not authorized,\ntalk to an administrator. If you're an administrator who needs to write policies to give users access, see\n[Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).\n" }, { "info": { "name": "DELETE Object", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/:bucketName/:objectName", "headers": [ { "name": "If-Match", "value": "" } ], "params": [ { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\n\nExample: `my-new-bucket1`\n" }, { "name": "objectName", "value": "", "type": "path", "description": "The name of the object. Avoid entering confidential information.\n\nExample: `test/object1.log`\n" } ] }, "docs": "Deletes an object.\n" }, { "info": { "name": "HEAD Object", "type": "http" }, "http": { "method": "HEAD", "url": "https://127.0.0.1/:bucketName/:objectName", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "range", "value": "" }, { "name": "x-amz-date", "value": "" }, { "name": "x-amz-server-side-encryption-customer-algorithm", "value": "" }, { "name": "x-amz-server-side-encryption-customer-key", "value": "" }, { "name": "x-amz-server-side-encryption-customer-key-md5", "value": "" } ], "params": [ { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\n\nExample: `my-new-bucket1`\n" }, { "name": "objectName", "value": "", "type": "path", "description": "The name of the object. Avoid entering confidential information.\n\nExample: `test/object1.log`\n" } ] }, "docs": "Gets the user-defined metadata and entity tag for an object.\n" }, { "info": { "name": "Restores an archived object.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/:bucketName/:objectName?restore", "headers": [ { "name": "x-amz-meta-*", "value": "" } ], "params": [ { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\n\nExample: `my-new-bucket1`\n" }, { "name": "objectName", "value": "", "type": "path", "description": "The name of the object. Avoid entering confidential information.\n\nExample: `test/object1.log`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restores the object as defined in the request body.\n" }, { "info": { "name": "run SQL like queries on objects and returns results.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/:bucketName/:objectName?select", "headers": [ { "name": "x-amz-meta-*", "value": "" } ], "params": [ { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\n\nExample: `my-new-bucket1`\n" }, { "name": "objectName", "value": "", "type": "path", "description": "The name of the object. Avoid entering confidential information.\n\nExample: `test/object1.log`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Filter the contents of an object based on a simple structured query language (SQL) statement\ndefined in the request body.\n" }, { "info": { "name": "List Parts", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/:bucketName/:objectName?uploadId", "params": [ { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\n\nExample: `my-new-bucket1`\n" }, { "name": "objectName", "value": "", "type": "path", "description": "The name of the object. Avoid entering confidential information.\n\nExample: `test/object1.log`\n" }, { "name": "uploadId", "value": "", "type": "query", "description": "The ID of a multipart upload.\n" }, { "name": "max-parts", "value": "", "type": "query", "description": "The maximum number of parts to return in the response body." }, { "name": "part-number-marker", "value": "", "type": "query", "description": "Specifies the part number after which listing should begin." }, { "name": "encoding-type", "value": "", "type": "query", "description": "When this parameter is set, the response is encoded with the specified encoding method. This\ncan be used for object keys containing characters that XML 1.0 parsers cannot parse.\n" } ] }, "docs": "Lists the parts that have been uploaded for a specific multipart upload.\n" }, { "info": { "name": "Complete Multipart Upload", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/:bucketName/:objectName?uploadId", "params": [ { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\n\nExample: `my-new-bucket1`\n" }, { "name": "objectName", "value": "", "type": "path", "description": "The name of the object. Avoid entering confidential information.\n\nExample: `test/object1.log`\n" }, { "name": "uploadId", "value": "", "type": "query", "description": "The ID of a multipart upload.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Commits a multipart upload.\n" }, { "info": { "name": "Upload Part", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/:bucketName/:objectName?uploadId", "headers": [ { "name": "Content-Length", "value": "" }, { "name": "Content-MD5", "value": "" }, { "name": "x-amz-checksum-sha256", "value": "" }, { "name": "Expect", "value": "" }, { "name": "x-amz-copy-source", "value": "" }, { "name": "x-amz-copy-source-if-match", "value": "" }, { "name": "x-amz-copy-source-if-none-match", "value": "" }, { "name": "x-amz-copy-source-if-unmodified-since", "value": "" }, { "name": "x-amz-copy-source-if-modified-since", "value": "" }, { "name": "x-amz-server-side-encryption-customer-algorithm", "value": "" }, { "name": "x-amz-server-side-encryption-customer-key", "value": "" }, { "name": "x-amz-server-side-encryption-customer-key-md5", "value": "" }, { "name": "x-amz-copy-source-server-side-encryption-customer-algorithm", "value": "" }, { "name": "x-amz-copy-source-server-side-encryption-customer-key", "value": "" }, { "name": "x-amz-copy-source-server-side-encryption-customer-key-md5", "value": "" }, { "name": "x-amz-server-side-encryption-aws-kms-key-id", "value": "" } ], "params": [ { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\n\nExample: `my-new-bucket1`\n" }, { "name": "objectName", "value": "", "type": "path", "description": "The name of the object. Avoid entering confidential information.\n\nExample: `test/object1.log`\n" }, { "name": "uploadId", "value": "", "type": "query", "description": "The ID of a multipart upload.\n" } ] }, "docs": "Uploads a part in a multipart upload.\n" }, { "info": { "name": "Abort Multipart Upload", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/:bucketName/:objectName?uploadId", "params": [ { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\n\nExample: `my-new-bucket1`\n" }, { "name": "objectName", "value": "", "type": "path", "description": "The name of the object. Avoid entering confidential information.\n\nExample: `test/object1.log`\n" }, { "name": "uploadId", "value": "", "type": "query", "description": "The ID of a multipart upload.\n" } ] }, "docs": "Aborts a multipart upload.\n" }, { "info": { "name": "Initiate Multipart Upload", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/:bucketName/:objectName?uploads", "headers": [ { "name": "x-amz-meta-*", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Content-Disposition", "value": "" }, { "name": "Cache-Control", "value": "" }, { "name": "x-amz-storage-class", "value": "" }, { "name": "x-amz-server-side-encryption-customer-algorithm", "value": "" }, { "name": "x-amz-server-side-encryption-customer-key", "value": "" }, { "name": "x-amz-server-side-encryption-customer-key-md5", "value": "" }, { "name": "x-amz-server-side-encryption-aws-kms-key-id", "value": "" } ], "params": [ { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\n\nExample: `my-new-bucket1`\n" }, { "name": "objectName", "value": "", "type": "path", "description": "The name of the object. Avoid entering confidential information.\n\nExample: `test/object1.log`\n" } ] }, "docs": "Starts a new multipart upload to a specific object in the given bucket.\n" }, { "info": { "name": "Bulk Delete", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/:bucketName?delete", "headers": [ { "name": "Content-Length", "value": "" }, { "name": "Content-MD5", "value": "" }, { "name": "x-amz-checksum-sha256", "value": "" }, { "name": "x-amz-checksum-crc32c", "value": "" }, { "name": "x-amz-date", "value": "" } ], "params": [ { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\n\nExample: `my-new-bucket1`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk delete up to 1000 objects in the given bucket.\nThe request body must include one checksum header for validation: Content-MD5, x-amz-checksum-sha256, or x-amz-checksum-crc32c.\n" }, { "info": { "name": "GetLocation", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/:bucketName?location", "headers": [ { "name": "x-amz-date", "value": "" } ], "params": [ { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\n\nExample: `my-new-bucket1`\n" } ] }, "docs": "Get the location of bucket's region.\n" }, { "info": { "name": "List Uploads", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/:bucketName?uploads", "params": [ { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket. Avoid entering confidential information.\n\nExample: `my-new-bucket1`\n" }, { "name": "max-uploads", "value": "", "type": "query", "description": "The maximum number of multipart uploads to return in the response body." }, { "name": "key-marker", "value": "", "type": "query", "description": "Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.\n" }, { "name": "upload-id-marker", "value": "", "type": "query", "description": "Together with key-marker, this parameter specifies the multipart upload after which listing should begin.\n" }, { "name": "encoding-type", "value": "", "type": "query", "description": "When this parameter is set, the response is encoded with the specified encoding method. This\ncan be used for object keys containing characters that XML 1.0 parsers cannot parse.\n" } ] }, "docs": "Lists up to 1000 in-progress multipart uploads in the given bucket.\n" } ] } ], "bundled": true }