SmugMug API
Tutorial
API Concepts
Advanced
- Optimizing response sizes
- Expanding related data
- Configuring expansions
- Rate Limits
- Method and Content Overrides
- Performance Metrics
- Multi-get
- Options requests
Live API Browser
Reference
Options requests
The HTTP specification defines a request method called OPTIONS
. The specification describes this method as follows:
This method allows the client to determine the options and/or requirements associated with a resource, or the capabilities of a server, without implying a resource action or initiating a resource retrieval.
The SmugMug API supports the OPTIONS
method. You can use it to find out what other methods an endpoint supports and what parameters those methods accept. This information will be found under the Options
key in the response. You can get the same data alongside any other API response by using the _verbosity
parameter.
Options Subsection | Description |
---|---|
Methods | A list of supported HTTP methods |
MediaTypes | A list of supported MediaTypes |
Parameters | Includes data about required parameters for each supported HTTP method |
Parameter Description | Provides details about the format of each parameter type for the endpoint |
Notes | General notes about the endpoint |
Examples
This shows an example of an OPTIONS
response for this endpoint:
This is an example of a _verbose=
response for the same endpoint: