ElasticDW Docs

ElasticDW API

ElasticDW provides an API for a subset of its features. If you have any questions or want to request new API features, please contact Full 360 support.

Note: Before planning an API integration, consider whether the ElasticDW terraform provider or CLI meets your needs.

The available API is exposed on this site as a swagger document.

Authentication

All requests must be authenticated with a bearer token. Use the HTTP header Authorization with the value Bearer . If the token is absent or invalid, ElasticDW responds with HTTP status 401 and a JSON API error object. The 401 status code is reserved for problems with the authentication token; forbidden requests with a valid token result in a 404.

There are two kinds of token available - a master token, or an environment token. The difference is in the allowed scope. A master token, as the name implies allows management of all the environments and clusters. The environment token reduces the scope to a single environment that the token was generated for.

Response Codes

This API returns standard HTTP response codes.

We return 404 Not Found codes for resources that a user doesn’t have access to, as well as for resources that don’t exist. This is to avoid telling a potential attacker that a given resource exists.

Versioning

The API documented in these pages is the second version of ElasticDW’s API, and resides under the /v2 prefix.

Future APIs will increment this version, leaving the /v1 API intact, though in the future we might deprecate certain features. In that case, we’ll provide ample notice to migrate to the new API.

Paths

All V2 API endpoints use /api/v2 as a prefix unless otherwise specified.

For example, if the API endpoint documentation defines the path /runs then the full path is /api/v2/runs.