Edit CORS settings

put

https://{hostname}/api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/settings/cors

Updates the cross-origin resource sharing (CORS) settings configured for an endpoint version.

Path Params

versionNumber

integer

required

The unique identifier for the endpoint version.

apiEndPointId

integer

required

The unique identifier for the endpoint.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Cross-origin resource sharing (CORS) settings configured for an endpoint. CORS enables clients to request restricted resources from external domains outside the domain that served the first resource. You can configure CORS settings if the API Gateway product is in your contract.

allowCredentials

boolean

Defaults to false

Whether you allow credentialed HTTP requests to access your resources. Credentials may be cookies or TLS client certificates.

allowedHeaders

array of strings

The HTTP header names that you allow using the Access-Control-Allow-Headers header.

allowedHeaders

allowedMethods

array of strings

The HTTP methods that you allow using the Access-Control-Allow-Methods header, either GET, PUT, POST, DELETE, OPTIONS, PATCH, or HEAD.

allowedMethods

Allowed:

allowedOrigins

array of strings

The origin hostnames that you allow using the Access-Control-Allow-Origin header. The wildcard (*) means all hostnames.

allowedOrigins

enabled

boolean

required

Whether you enabled CORS for the endpoint.

exposedHeaders

array of strings

The headers that you expose using the Access-Control-Expose-Headers header. By exposing a header, you allow clients to access it.

exposedHeaders

preflightMaxAge

integer

required

The maximum time in seconds for caching responses to preflight requests.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200The response shows updated CORS data.

400Bad request. Some of your request's input is invalid.

401Unauthorized. You aren't authorized to perform the action.

403Forbidden. You don't have permission to access the API endpoint.

404Not found. This API endpoint doesn't exist.

405Method not allowed.

415Unsupported Media Type.