Get Open API Specification

Get OpenAPI Specification

GET/v2/settings/extensions/specifications/openapi

Use it in a workflow

Add a step and choose the Elastic Path connector.
Pick the Get Open API Specification action (under Commerce Extensions).
Fill in the fields below, then reference the result from later steps as {{getOpenApiSpecification.response.data}}.

baseUrlstring

The API host this action calls. Choose one, or pick Custom to enter your own.

One ofhttps://useast.api.elasticpath.comhttps://euwest.api.elasticpath.com__custom__Default "https://useast.api.elasticpath.com"

baseUrlCustomstring

forwardAllHeadersboolean

If enabled, all headers from the incoming request will be forwarded. Additional headers below will override forwarded ones.

Default false

headerskeyvalue

Extra HTTP headers to include, beyond what this action already declares. These override forwarded or declared headers with the same name.

queryParamskeyvalue

Extra URL query parameters to include, beyond what this action already declares. These override declared query parameters with the same name.

Returns 200 with an object. Read it in later steps with {{getOpenApiSpecification.response.data.<field>}}.

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.

Was this page helpful?