Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Path Settings API

The Settings API allow you to configure global settings for your project.

Elastic Path Settings API is one of 100 APIs that Elastic Path publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Settings. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 1 path, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 25.1126.6886238.

Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.

3 operations 1 paths 5 schemas 1 DELETE1 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
25.1126.6886238
Base URL
https://useast.api.elasticpath.com
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Elastic Path Settings API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

Paths & Operations 3

Across 1 path, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Settings 3

The Settings API allow you to configure global settings for your project.

GET
/v2/settings
Get Project Settings
get-v2-settings → 200401default
PUT
/v2/settings
Update Project Settings
put-v2-settings body → 200400default
DELETE
/v2/settings
Delete Project Settings
delete-v2-settings → 204401default

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Settings (7 properties), Error (5 properties), SettingsData (1 property), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

SettingsResponse
Settings
object
7 properties 1 required
Error
object
5 properties 1 required
ErrorResponse
object
1 property 1 required
SettingsData
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-settings-api-openapi.yml Raw ↑

Other APIs Elastic Path publishes across the network.

Elastic Path GraphQL API
Elastic Path Account Addresses API
Elastic Path Account Authentication Settings API
Elastic Path Account Cart Associations API
Elastic Path Account Management Authentication API
Elastic Path Account Members API
Elastic Path Account Membership API
Elastic Path Account Membership Settings API
Elastic Path Account Tags API
Elastic Path Accounts API
Elastic Path Administrator Latest Releases Catalog API API
Elastic Path Application Keys API