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

Acquia Options API

The Options API from Acquia — 6 operation(s) for options.

Acquia Options API is one of 21 APIs that Acquia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 6 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

6 operations 6 paths 9 schemas 6 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.0
Authentication
OAuth 2.0, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 4

Acquia Options API declares 4 security schemes for authenticating requests. It supports OAuth 2.0 (Acquia_Cloud_API_Documentation_OAuth2) using the clientCredentials flow. An API key is passed in the header as Authorization (Codebase_Service_JWT). An API key is passed in the header as Authorization (MEO_Environment_Service_JWT). An API key is passed in the header as Authorization (Site_Service_JWT).

  • Acquia_Cloud_API_Documentation_OAuth2 — All Cloud API calls need to be authenticated in order to work. You authenticate using a token that you can generate on your Acquia Profile page. To generate a…
  • Codebase_Service_JWT — Value for the Authorization header parameter.
  • MEO_Environment_Service_JWT — Value for the Authorization header parameter.
  • Site_Service_JWT — Value for the Authorization header parameter.

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 6 GET. Each is listed below with its method, path, parameters, and response codes.

Options 6
GET
/options
Does not return any data. Allows traversal of options groups endpoints.
getOptions → 200
GET
/options/cde-sizes
Displays the various CD Environment size options.
getCdeSizes → 200
GET
/options/log-forwarding
Does not return any data. Allows traversal of options groups endpoints.
getLogForwarding → 200
GET
/options/log-forwarding/sources
Displays available log forwarding sources.
getLogForwardingSources → 200
GET
/options/log-forwarding/consumers
Displays available log forwarding consumers.
getLogForwardingConsumers → 200
GET
/options/colors
Displays the various color options.
getColors → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Acquia_Cloud_API_Documentation_cde-size (6 properties), Acquia_Cloud_API_Documentation_log-forwarding-source (3 properties), Acquia_Cloud_API_Documentation_cde-sizes (3 properties), Acquia_Cloud_API_Documentation_log-forwarding-consumers (3 properties). Each schema is shown below with its type and property counts.

Acquia_Cloud_API_Documentation_log-forwarding-source
object
Response schema for a Log forwarding source.
3 properties 3 required
Acquia_Cloud_API_Documentation_log-forwarding-consumers
object
3 properties 3 required
Acquia_Cloud_API_Documentation_log-forwarding-consumer
object
Response schema for a Log forwarding consumer.
2 properties 2 required
Acquia_Cloud_API_Documentation_cde-sizes
object
3 properties 3 required
Acquia_Cloud_API_Documentation_colors
object
3 properties 3 required
Acquia_Cloud_API_Documentation_cde-size
object
Response schema for a CDE size.
6 properties 6 required
Acquia_Cloud_API_Documentation_links
object
HAL links about the current resource.
1 property 1 required
Acquia_Cloud_API_Documentation_color
object
Response schema for a color.
1 property 1 required
Acquia_Cloud_API_Documentation_log-forwarding-sources
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

acquia-options-api-openapi.yml Raw ↑

Other APIs Acquia publishes across the network.

Acquia Cloud Site Factory API
Acquia Content Hub API
Acquia Account API
Acquia Agreements API
Acquia Application Performance Monitoring Services API
Acquia Applications API
Acquia Cloud IDE API
Acquia Codebases API
Acquia Current system health API
Acquia Distributions API
Acquia Email API
Acquia Environments API