options method

Written by

Updated at September 30, 2024

Checks whether a CORS request to an object can be made.

For more information on getting started with the API and the general request format, see How to use the S3 API.

Request

OPTIONS /{bucket}/{key} HTTP/2

Parameter	Description
`bucket`	Bucket name.
`key`	Object key. ID for saving the object in Object Storage.

Header	Description
`Origin`	Request source domain. E.g., `http://www.example.com`. Required.
`Access-Control-Request-Method`	HTTP method that will be used to send the request to the resource. Required.
`Access-Control-Request-Headers`	List of headers to be sent in a subsequent request to the object. Headers are separated by commas. Optional.

Make sure to also use the required common headers.

In addition to common response headers, responses may contain:

Header	Header
`Access-Control-Allow-Origin`	Domain provided in the `Origin` header of the request. If the CORS configuration has its `AllowedOrigin` element set to ``, then the `Access-Control-Allow-Origin` header value will also be ``. If access from the domain is denied, Object Storage will return error 403 and there will be no `Access-Control-*` headers present.
`Access-Control-Max-Age`	Allowed response caching time (in seconds).
`Access-Control-Allow-Methods`	Allowed request methods. If there are no allowed methods, Object Storage will return error 403 and there will be no `Access-Control-*` headers present.
`Access-Control-Allow-Headers`	List of HTTP headers that can be used in a subsequent request to the object. If there are no headers allowed, this header is not included in a response.
`Access-Control-Expose-Headers`	List of HTTP headers that the JavaScript client receives.

The method returns the following:

For a detailed description of response codes, see Responses.